make nebari API private (#1778)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/kubernetes_test.yaml

@@ -8,7 +8,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
       - "pytest.ini"
   push:
@@ -22,7 +22,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
       - "pytest.ini"
   workflow_call:

.github/workflows/test-provider.yaml

@@ -8,7 +8,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
   push:
     branches:
@@ -21,7 +21,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
   workflow_call:
     inputs:

.github/workflows/test.yaml

@@ -8,7 +8,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
       - "pytest.ini"
   push:
@@ -22,7 +22,7 @@ on:
       - "tests_deployment/**"
       - "tests_e2e/**"
       - "scripts/**"
-      - "nebari/**"
+      - "src/**"
       - "pyproject.toml"
       - "pytest.ini"
 

.gitignore

@@ -1,5 +1,5 @@
 # setuptools scm
-nebari/_version.py
+src/_nebari/_version.py
 
 # ignore terraform state
 .terraform

.pre-commit-config.yaml

@@ -29,12 +29,12 @@ repos:
       - id: check-json
       - id: check-yaml
         # jinja2 templates for helm charts
-        exclude: "nebari/template/stages/07-kubernetes-services/modules/kubernetes/services/(clearml/chart/templates/.*|prefect/chart/templates/.*)"
+        exclude: "src/_nebari/template/stages/07-kubernetes-services/modules/kubernetes/services/(clearml/chart/templates/.*|prefect/chart/templates/.*)"
         args: [--allow-multiple-documents]
       - id: check-toml
       # Lint: Checks that non-binary executables have a proper shebang.
       - id: check-executables-have-shebangs
-        exclude: "^nebari/template/"
+        exclude: "^src/_nebari/template/"
 
   - repo: https://github.com/codespell-project/codespell
     rev: v2.2.4
@@ -54,7 +54,7 @@ repos:
     rev: 23.3.0
     hooks:
       - id: black
-        args: ["--line-length=88", "--exclude=/nebari/template/"]
+        args: ["--line-length=88", "--exclude=/src/_nebari/template/"]
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
     rev: v0.0.263

pyproject.toml

@@ -4,13 +4,16 @@ requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
-include = ["nebari"]
+packages = [
+    "src/_nebari",
+    "src/nebari",
+]
 
 [tool.hatch.version]
 source = "vcs"
 
 [tool.hatch.build.hooks.vcs]
-version-file = "nebari/_version.py"
+version-file = "src/_nebari/_version.py"
 local_scheme = "node-and-timestamp"
 
 
@@ -90,15 +93,15 @@ Documentation = "https://www.nebari.dev/docs"
 Source = "https://github.com/nebari-dev/nebari"
 
 [project.scripts]
-nebari = "nebari.cli.main:app"
+nebari = "_nebari.cli.main:app"
 
 [tool.ruff]
 ignore = [
     "E501", # Line too long
     "F821", # Undefined name
 ]
 extend-exclude = [
-    "nebari/template",
+    "src/_nebari/template",
     "home",
     "__pycache__"
 ]

scripts/aws-force-destroy.py

@@ -3,7 +3,7 @@
 import pathlib
 import time
 
-from nebari.utils import check_cloud_credentials, load_yaml, timer
+from _nebari.utils import check_cloud_credentials, load_yaml, timer
 
 logging.basicConfig(level=logging.INFO)
 

scripts/keycloak-export.py

@@ -4,7 +4,7 @@
 import pathlib
 import sys
 
-from nebari.keycloak import get_keycloak_admin_from_config
+from _nebari.keycloak import get_keycloak_admin_from_config
 
 logging.basicConfig(level=logging.INFO)
 

nebari/cli/dev.py → src/_nebari/cli/dev.py

@@ -3,7 +3,7 @@
 
 import typer
 
-from nebari.keycloak import keycloak_rest_api_call
+from _nebari.keycloak import keycloak_rest_api_call
 
 app_dev = typer.Typer(
     add_completion=False,

nebari/cli/init.py → src/_nebari/cli/init.py

@@ -6,8 +6,8 @@
 import rich
 import typer
 
-from nebari.initialize import render_config
-from nebari.schema import (
+from _nebari.initialize import render_config
+from _nebari.schema import (
     AuthenticationEnum,
     CiEnum,
     GitRepoEnum,
@@ -16,7 +16,7 @@
     TerraformStateEnum,
     project_name_convention,
 )
-from nebari.utils import NEBARI_DASK_VERSION, NEBARI_IMAGE_TAG, yaml
+from _nebari.utils import NEBARI_DASK_VERSION, NEBARI_IMAGE_TAG, yaml
 
 MISSING_CREDS_TEMPLATE = "Unable to locate your {provider} credentials, refer to this guide on how to generate them:\n\n[green]\t{link_to_docs}[/green]\n\n"
 LINKS_TO_DOCS_TEMPLATE = (

nebari/cli/keycloak.py → src/_nebari/cli/keycloak.py

@@ -4,7 +4,7 @@
 
 import typer
 
-from nebari.keycloak import do_keycloak, export_keycloak_users
+from _nebari.keycloak import do_keycloak, export_keycloak_users
 
 app_keycloak = typer.Typer(
     add_completion=False,

nebari/cli/main.py → src/_nebari/cli/main.py

@@ -10,8 +10,8 @@
 from ruamel import yaml
 from typer.core import TyperGroup
 
-from nebari.cli.dev import app_dev
-from nebari.cli.init import (
+from _nebari.cli.dev import app_dev
+from _nebari.cli.init import (
     check_auth_provider_creds,
     check_cloud_provider_creds,
     check_project_name,
@@ -20,11 +20,11 @@
     guided_init_wizard,
     handle_init,
 )
-from nebari.cli.keycloak import app_keycloak
-from nebari.deploy import deploy_configuration
-from nebari.destroy import destroy_configuration
-from nebari.render import render_template
-from nebari.schema import (
+from _nebari.cli.keycloak import app_keycloak
+from _nebari.deploy import deploy_configuration
+from _nebari.destroy import destroy_configuration
+from _nebari.render import render_template
+from _nebari.schema import (
     AuthenticationEnum,
     CiEnum,
     GitRepoEnum,
@@ -33,9 +33,9 @@
     TerraformStateEnum,
     verify,
 )
-from nebari.upgrade import do_upgrade
-from nebari.utils import load_yaml
-from nebari.version import __version__
+from _nebari.upgrade import do_upgrade
+from _nebari.utils import load_yaml
+from _nebari.version import __version__
 
 SECOND_COMMAND_GROUP_NAME = "Additional Commands"
 GUIDED_INIT_MSG = (

nebari/deploy.py → src/_nebari/deploy.py

@@ -3,10 +3,10 @@
 import subprocess
 import textwrap
 
-from nebari.provider import terraform
-from nebari.provider.dns.cloudflare import update_record
-from nebari.stages import checks, input_vars, state_imports
-from nebari.utils import (
+from _nebari.provider import terraform
+from _nebari.provider.dns.cloudflare import update_record
+from _nebari.stages import checks, input_vars, state_imports
+from _nebari.utils import (
     check_cloud_credentials,
     keycloak_provider_context,
     kubernetes_provider_context,

nebari/destroy.py → src/_nebari/destroy.py

@@ -2,9 +2,9 @@
 import logging
 import os
 
-from nebari.provider import terraform
-from nebari.stages import input_vars, state_imports
-from nebari.utils import (
+from _nebari.provider import terraform
+from _nebari.stages import input_vars, state_imports
+from _nebari.utils import (
     check_cloud_credentials,
     keycloak_provider_context,
     kubernetes_provider_context,

nebari/initialize.py → src/_nebari/initialize.py

@@ -8,10 +8,10 @@
 
 import requests
 
-from nebari.provider import git
-from nebari.provider.cicd import github
-from nebari.provider.oauth.auth0 import create_client
-from nebari.utils import (
+from _nebari.provider import git
+from _nebari.provider.cicd import github
+from _nebari.provider.oauth.auth0 import create_client
+from _nebari.utils import (
     check_cloud_credentials,
     namestr_regex,
     set_docker_image_tag,

nebari/provider/cicd/github.py → src/_nebari/provider/cicd/github.py

@@ -6,8 +6,8 @@
 from nacl import encoding, public
 from pydantic import BaseModel, Field
 
-from nebari.constants import LATEST_SUPPORTED_PYTHON_VERSION
-from nebari.provider.cicd.common import pip_install_nebari
+from _nebari.constants import LATEST_SUPPORTED_PYTHON_VERSION
+from _nebari.provider.cicd.common import pip_install_nebari
 
 GITHUB_BASE_URL = "https://api.github.com/"
 

nebari/provider/cicd/gitlab.py → src/_nebari/provider/cicd/gitlab.py

@@ -2,8 +2,8 @@
 
 from pydantic import BaseModel, Field
 
-from nebari.constants import LATEST_SUPPORTED_PYTHON_VERSION
-from nebari.provider.cicd.common import pip_install_nebari
+from _nebari.constants import LATEST_SUPPORTED_PYTHON_VERSION
+from _nebari.provider.cicd.common import pip_install_nebari
 
 
 class GLCI_extras(BaseModel):

nebari/provider/cicd/linter.py → src/_nebari/provider/cicd/linter.py

@@ -5,7 +5,7 @@
 
 import requests
 
-from nebari.schema import verify
+from _nebari.schema import verify
 
 
 def nebari_validate(config):

nebari/provider/cloud/amazon_web_services.py → src/_nebari/provider/cloud/amazon_web_services.py

@@ -5,7 +5,7 @@
 
 import boto3
 
-from nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
+from _nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
 
 
 @functools.lru_cache()

nebari/provider/cloud/azure_cloud.py → src/_nebari/provider/cloud/azure_cloud.py

@@ -5,7 +5,7 @@
 from azure.identity import DefaultAzureCredential
 from azure.mgmt.containerservice import ContainerServiceClient
 
-from nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
+from _nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
 
 logger = logging.getLogger("azure")
 logger.setLevel(logging.ERROR)

nebari/provider/cloud/commons.py → src/_nebari/provider/cloud/commons.py

@@ -1,4 +1,4 @@
-from nebari.constants import HIGHEST_SUPPORTED_K8S_VERSION
+from _nebari.constants import HIGHEST_SUPPORTED_K8S_VERSION
 
 
 def filter_by_highest_supported_k8s_version(k8s_versions_list):

nebari/provider/cloud/digital_ocean.py → src/_nebari/provider/cloud/digital_ocean.py

@@ -3,7 +3,7 @@
 
 import requests
 
-from nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
+from _nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
 
 
 def digital_ocean_request(url, method="GET", json=None):

nebari/provider/cloud/google_cloud.py → src/_nebari/provider/cloud/google_cloud.py

@@ -2,7 +2,7 @@
 import json
 import subprocess
 
-from nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
+from _nebari.provider.cloud.commons import filter_by_highest_supported_k8s_version
 
 
 @functools.lru_cache()

nebari/provider/git.py → src/_nebari/provider/git.py

@@ -2,7 +2,7 @@
 import os
 import subprocess
 
-from nebari.utils import change_directory
+from _nebari.utils import change_directory
 
 
 def is_git_repo(path=None):

nebari/provider/terraform.py → src/_nebari/provider/terraform.py

@@ -12,8 +12,8 @@
 import zipfile
 from typing import Any, Dict, List
 
-from nebari import constants
-from nebari.utils import deep_merge, run_subprocess_cmd, timer
+from _nebari import constants
+from _nebari.utils import deep_merge, run_subprocess_cmd, timer
 
 logger = logging.getLogger(__name__)
 

nebari/render.py → src/_nebari/render.py

@@ -12,16 +12,16 @@
 from rich.table import Table
 from ruamel.yaml import YAML
 
-import nebari
-from nebari.deprecate import DEPRECATED_FILE_PATHS
-from nebari.provider.cicd.github import gen_nebari_linter, gen_nebari_ops
-from nebari.provider.cicd.gitlab import gen_gitlab_ci
-from nebari.stages import tf_objects
+import _nebari
+from _nebari.deprecate import DEPRECATED_FILE_PATHS
+from _nebari.provider.cicd.github import gen_nebari_linter, gen_nebari_ops
+from _nebari.provider.cicd.gitlab import gen_gitlab_ci
+from _nebari.stages import tf_objects
 
 
 def render_template(output_directory, config_filename, dry_run=False):
     # get directory for nebari templates
-    template_directory = pathlib.Path(nebari.__file__).parent / "template"
+    template_directory = pathlib.Path(_nebari.__file__).parent / "template"
 
     # would be nice to remove assumption that input directory
     # is in local filesystem and a directory
@@ -148,7 +148,7 @@ def render_template(output_directory, config_filename, dry_run=False):
 
 
 def render_contents(config: Dict):
-    """Dynamically generated contents from Nebari configuration."""
+    """Dynamically generated contents from _nebari configuration."""
     contents = {
         **tf_objects.stage_01_terraform_state(config),
         **tf_objects.stage_02_infrastructure(config),