ssb-project-cli 1.3.8__tar.gz → 1.4.0__tar.gz

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ssb-project-cli
-Version: 1.3.8
+Version: 1.4.0
 Summary: SSB Project CLI
 Home-page: https://github.com/statisticsnorway/ssb-project-cli
 License: MIT

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-project-cli"
-version = "1.3.8"
+version = "1.4.0"
 description = "SSB Project CLI"
 authors = ["Statistics Norway <stat-dev@ssb.no>"]
 license = "MIT"
@@ -94,6 +94,7 @@ tests = ["tests", "*/tests"]
 [tool.coverage.run]
 branch = true
 source = ["ssb_project_cli", "tests"]
+relative_files = true
 
 [tool.coverage.report]
 show_missing = true
@@ -112,6 +113,14 @@ show_column_numbers = true
 show_error_codes = true
 show_error_context = true
 
+[[tool.mypy.overrides]]
+module = [
+    "attr.*",
+    "cruft.*",
+    "tomli_w.*",
+]
+ignore_missing_imports = true
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/app.py

@@ -4,6 +4,7 @@ from pathlib import Path
 
 import typer
 from rich.console import Console
+from typing_extensions import Annotated
 
 from ssb_project_cli.ssb_project.util import set_debug_logging
 
@@ -48,7 +49,7 @@ app = typer.Typer(
 
 
 @app.command()
-def create(  # noqa: C901
+def create(  # noqa: C901, S107
     project_name: str = typer.Argument(..., help="Project name"),  # noqa: B008
     description: str = typer.Argument(  # noqa: B008
         "", help="A short description of your project"
@@ -56,29 +57,38 @@ def create(  # noqa: C901
     repo_privacy: RepoPrivacy = typer.Argument(  # noqa: B008
         RepoPrivacy.internal, help="Visibility of the Github repo"
     ),
-    add_github: bool = typer.Option(  # noqa: B008
-        False,
-        "--github",
-        help="Create the repo on Github as well",
-    ),
-    github_token: str = typer.Option(  # noqa: B008
-        "",
-        help="Your Github Personal Access Token, follow these instructions to create one: https://manual.dapla.ssb.no/git-github.html#personal-access-token-pat",
-    ),
-    verify_config: bool = typer.Option(  # noqa: B008
-        True,
-        "--no-verify",
-        help="Verify git configuration files. Use --no-verify to disable verification (defaults to True).",
-        show_default=True,
-    ),
-    template_git_url: str = typer.Option(  # noqa: B008
-        STAT_TEMPLATE_REPO_URL,
-        help="The Cookiecutter template URI.",
-    ),
-    checkout: t.Optional[str] = typer.Option(  # noqa: B008
-        None,
-        help="The git reference to check against. Supports branches, tags and commit hashes.",
-    ),
+    add_github: Annotated[
+        bool, typer.Option("--github", help="Create the repo on Github as well")
+    ] = False,
+    github_token: Annotated[
+        str,
+        typer.Option(
+            help="Your Github Personal Access Token, follow these instructions to create one: https://manual.dapla.ssb.no/git-github.html#personal-access-token-pat"
+        ),
+    ] = "",
+    verify_config: Annotated[
+        bool,
+        typer.Option(
+            "--no-verify",
+            help="Verify git configuration files. Use --no-verify to disable verification (defaults to True).",
+        ),
+    ] = True,
+    template_git_url: Annotated[
+        str, typer.Option(help="The Cookiecutter template URI.")
+    ] = STAT_TEMPLATE_REPO_URL,
+    checkout: Annotated[
+        t.Optional[str],
+        typer.Option(
+            help="The git reference to check against. Supports branches, tags and commit hashes.",
+        ),
+    ] = None,
+    no_kernel: Annotated[
+        bool,
+        typer.Option(
+            "--no-kernel",
+            help="Do not create a kernel after the project is created (defaults to False).",
+        ),
+    ] = False,
 ) -> None:
     """:sparkles:  Create a project locally, and optionally on GitHub with the flag --github. The project will follow SSB's best practice for development."""
     if not checkout and template_git_url is STAT_TEMPLATE_REPO_URL:
@@ -96,6 +106,7 @@ def create(  # noqa: C901
         template_git_url,
         checkout,
         verify_config,
+        no_kernel,
     )
 
 

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/build/build.py

@@ -9,14 +9,10 @@ from typing import List
 
 import kvakk_git_tools.validate_ssb_gitconfig  # type: ignore
 
-from .environment import JUPYTER_IMAGE_SPEC, verify_local_config
-from .environment import PIP_INDEX_URL
-from .environment import running_onprem
+from .environment import verify_local_config
 from .poetry import install_ipykernel
 from .poetry import poetry_install
-from .poetry import poetry_source_add
-from .poetry import poetry_source_includes_source_name
-from .poetry import poetry_source_remove
+from .poetry import check_and_fix_onprem_source
 from rich import print
 
 from .prompt import confirm_fix_ssb_git_config
@@ -33,6 +29,7 @@ def build_project(
     template_repo_url: str,
     checkout: str | None,
     verify_config: bool = True,
+    no_kernel: bool = False,
 ) -> None:
     """Installs dependencies and kernel for a given project.
 
@@ -42,6 +39,7 @@ def build_project(
         template_repo_url: Template repository url
         checkout: The git reference to check against. Supports branches, tags and commit hashes.
         verify_config: Determines if gitconfig is verified.
+        no_kernel: Determines if a kernel shall be generated or not.
     """
     if path is None:
         project_directory = working_directory
@@ -57,45 +55,51 @@ def build_project(
         sys.exit()
 
     if verify_config:
-        try:
-            valid_global_git_config = kvakk_git_tools.validate_git_config()
-        except FileExistsError:
-            # If gitconfig does not exist the configuration is invalid
-            valid_global_git_config = False
-        valid_project_git_config = verify_local_config(
-            template_repo_url,
-            checkout,
-            cwd=str(project_root),
+        validate_and_fix_git_config(
+            template_repo_url, checkout, project_name, project_root
         )
-        if not valid_global_git_config or not valid_project_git_config:
-            print(
-                ":x:\tYour project's Git configuration does not follow SSB recommendations,\n:x:\twhich may result in sensitive data being pushed to GitHub."
-            )
-            confirm_fix_ssb_git_config(
-                project_name,
-                template_repo_url,
-                checkout,
-                project_root,
-                valid_global_git_config,
-                valid_project_git_config,
-            )
-
-    if running_onprem(JUPYTER_IMAGE_SPEC):
+
+    check_and_fix_onprem_source(project_root)
+
+    poetry_install(project_root)
+    if not no_kernel:
+        install_ipykernel(project_root, project_name)
+        ipykernel_attach_bashrc(project_name)
+
+
+def validate_and_fix_git_config(
+    template_repo_url: str, checkout: str | None, project_name: str, project_root: Path
+) -> None:
+    """Validate and fix the git config.
+
+    Args:
+        template_repo_url: Template repository url
+        checkout: The git reference to check against. Supports branches, tags and commit hashes.
+        project_name: The name of the project
+        project_root: The root directory of the project/repo.
+    """
+    try:
+        valid_global_git_config = kvakk_git_tools.validate_git_config()
+    except FileExistsError:
+        # If gitconfig does not exist the configuration is invalid
+        valid_global_git_config = False
+    valid_project_git_config = verify_local_config(
+        template_repo_url,
+        checkout,
+        cwd=str(project_root),
+    )
+    if not valid_global_git_config or not valid_project_git_config:
         print(
-            ":twisted_rightwards_arrows:\tDetected onprem environment, using proxy for package installation"
+            ":x:\tYour project's Git configuration does not follow SSB recommendations,\n:x:\twhich may result in sensitive data being pushed to GitHub."
         )
-        if poetry_source_includes_source_name(project_root):
-            poetry_source_remove(project_root, lock_update=False)
-        poetry_source_add(PIP_INDEX_URL, project_root)
-    elif poetry_source_includes_source_name(project_root):
-        print(
-            ":twisted_rightwards_arrows:\tDetected non-onprem environment, removing proxy for package installation"
+        confirm_fix_ssb_git_config(
+            project_name,
+            template_repo_url,
+            checkout,
+            project_root,
+            valid_global_git_config,
+            valid_project_git_config,
         )
-        poetry_source_remove(project_root)
-
-    poetry_install(project_root)
-    install_ipykernel(project_root, project_name)
-    ipykernel_attach_bashrc(project_name)
 
 
 def ipykernel_attach_bashrc(project_name: str) -> None:

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/build/poetry.py

@@ -8,6 +8,9 @@ from rich import print
 
 from .environment import NEXUS_SOURCE_NAME
 from ssb_project_cli.ssb_project.util import execute_command
+from .environment import JUPYTER_IMAGE_SPEC
+from .environment import PIP_INDEX_URL
+from .environment import running_onprem
 
 
 def poetry_install(project_directory: Path) -> None:
@@ -35,6 +38,33 @@ def poetry_install(project_directory: Path) -> None:
         )
 
 
+def poetry_update_lockfile_dependencies(project_directory: Path) -> None:
+    """Call poetry update --lock in project_directory.
+
+    Update the lock file dependencies without installing packages.
+
+    Args:
+        project_directory: Path of project
+    """
+    with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+    ) as progress:
+        progress.add_task(
+            description="Updating lock file dependencies... This may take some time.",
+            total=None,
+        )
+
+        execute_command(
+            "poetry update --lock".split(" "),
+            "poetry-update-lock-deps",
+            ":white_check_mark:\tUpdated lock file dependencies",
+            "Error: Something went wrong when updating lock file dependencies with Poetry.",
+            project_directory,
+        )
+
+
 def poetry_source_includes_source_name(
     cwd: Path, source_name: str = NEXUS_SOURCE_NAME
 ) -> bool:
@@ -164,3 +194,23 @@ def install_ipykernel(project_directory: Path, project_name: str) -> None:
             "Something went wrong while installing ipykernel.",
             project_directory,
         )
+
+
+def check_and_fix_onprem_source(project_root: Path) -> None:
+    """Check if running onprem and fix source in pyproject.toml if so.
+
+    Args:
+        project_root: Path to the root of the project
+    """
+    if running_onprem(JUPYTER_IMAGE_SPEC):
+        print(
+            ":twisted_rightwards_arrows:\tDetected onprem environment, using proxy for package installation"
+        )
+        if poetry_source_includes_source_name(project_root):
+            poetry_source_remove(project_root, lock_update=False)
+        poetry_source_add(PIP_INDEX_URL, project_root)
+    elif poetry_source_includes_source_name(project_root):
+        print(
+            ":twisted_rightwards_arrows:\tDetected non-onprem environment, removing proxy for package installation"
+        )
+        poetry_source_remove(project_root)

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/build/temp_template_repo.py

@@ -4,7 +4,7 @@ from types import TracebackType
 from typing import Optional
 from typing import Type
 
-from git import Repo  # type: ignore[attr-defined]
+from git import Repo
 
 
 class TempTemplateRepo:

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/create/create.py

@@ -36,6 +36,7 @@ def create_project(  # noqa: C901
     template_repo_url: str,
     checkout: str | None,
     verify_config: bool = True,
+    no_kernel: bool = False,
 ) -> None:
     """Create an SSB-project.
 
@@ -51,6 +52,7 @@ def create_project(  # noqa: C901
         template_repo_url: The Cookiecutter template URI.
         checkout: The git reference to check against. Supports branches, tags and commit hashes.
         verify_config: Determines if gitconfig is verified.
+        no_kernel: Determines if a kernel shall be generated or not.
     """
     is_memory_full()
 
@@ -105,6 +107,7 @@ def create_project(  # noqa: C901
             template_repo_url,
             checkout,
             verify_config,
+            no_kernel,
         )
 
         git_repo_dir = Path(working_directory.joinpath(project_name))

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/create/github.py

@@ -40,7 +40,7 @@ def create_github(
     try:
         # Ignoring mypy warning: Unexpected keyword argument "visibility"
         # for "create_repo" of "Organization"  [call-arg]
-        g.get_organization(github_org_name).create_repo(  # type: ignore
+        g.get_organization(github_org_name).create_repo(
             repo_name,
             visibility=repo_privacy,
             auto_init=False,
@@ -207,6 +207,8 @@ def set_branch_protection_rules(
         required_approving_review_count=1,
         dismiss_stale_reviews=True,
         enforce_admins=True,
+        # Need to supply the line under as a workaround until PyGithub is updated to v2
+        users_bypass_pull_request_allowances=[],
     )
 
 

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/create/local_repo.py

@@ -6,10 +6,12 @@ from datetime import datetime
 from pathlib import Path
 from typing import Optional
 
-import cruft  # type: ignore[import]
-from git import Repo  # type: ignore[attr-defined]
+import cruft
+from git import Repo
 from rich import print
 
+from ssb_project_cli.ssb_project.build.poetry import check_and_fix_onprem_source
+from ssb_project_cli.ssb_project.build.poetry import poetry_update_lockfile_dependencies
 from ssb_project_cli.ssb_project.create import temp_git_repo
 from ssb_project_cli.ssb_project.create.github import (
     get_environment_specific_github_object,
@@ -71,6 +73,9 @@ def create_project_from_template(
         no_input=(template_repo_url == STAT_TEMPLATE_REPO_URL),
         extra_context=template_info,
     )
+    project_root = project_dir / project_name
+    check_and_fix_onprem_source(project_root)
+    poetry_update_lockfile_dependencies(project_root)
 
     return project_dir
 

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/create/temp_git_repo.py

@@ -3,7 +3,7 @@ from types import TracebackType
 from typing import Optional
 from typing import Type
 
-from git import Repo  # type: ignore[attr-defined]
+from git import Repo
 
 
 class TempGitRemote:

{ssb_project_cli-1.3.8 → ssb_project_cli-1.4.0}/src/ssb_project_cli/ssb_project/util.py

@@ -16,7 +16,7 @@ from rich import print
 from .settings import HOME_PATH
 
 
-kernelspec_manager = jupyter_client.kernelspec.KernelSpecManager()  # type: ignore[no-untyped-call]
+kernelspec_manager = jupyter_client.kernelspec.KernelSpecManager()
 
 
 def set_debug_logging(home_path: Path = HOME_PATH) -> None:
@@ -109,12 +109,12 @@ def get_kernels_dict() -> dict[str, dict[str, str]]:
     Returns:
         kernel_dict: Dictionary of installed kernel specifications
     """
-    return kernelspec_manager.get_all_specs()  # type: ignore
+    return kernelspec_manager.get_all_specs()
 
 
 def remove_kernel_spec(kernel_name: str) -> None:
     """Remove a kernel spec."""
-    kernelspec_manager.remove_kernel_spec(kernel_name)  # type: ignore[no-untyped-call]
+    kernelspec_manager.remove_kernel_spec(kernel_name)
 
 
 def get_project_name_and_root_path(