ssb-project-cli 1.4.2__tar.gz → 1.4.4__tar.gz

{ssb_project_cli-1.4.2 → ssb_project_cli-1.4.4}/PKG-INFO

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

{ssb_project_cli-1.4.2 → ssb_project_cli-1.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-project-cli"
-version = "1.4.2"
+version = "1.4.4"
 description = "SSB Project CLI"
 authors = ["Statistics Norway <stat-dev@ssb.no>"]
 license = "MIT"

{ssb_project_cli-1.4.2 → ssb_project_cli-1.4.4}/src/ssb_project_cli/ssb_project/app.py

@@ -18,6 +18,7 @@ from .settings import GITHUB_ORG_NAME
 from .settings import HOME_PATH
 from .settings import STAT_TEMPLATE_DEFAULT_REFERENCE
 from .settings import STAT_TEMPLATE_REPO_URL
+from .util import handle_no_kernel_argument
 
 
 # Don't print with color, it's difficult to read when run in Jupyter
@@ -83,6 +84,12 @@ def create(  # noqa: C901, S107
             help="The git reference to check against. Supports branches, tags and commit hashes.",
         ),
     ] = None,
+    name: Annotated[
+        t.Optional[str], typer.Option("--name", help="Project author's full name.")
+    ] = None,
+    email: Annotated[
+        t.Optional[str], typer.Option("--email", help="Project author's email.")
+    ] = None,
     no_kernel: Annotated[
         bool,
         typer.Option(
@@ -106,8 +113,10 @@ def create(  # noqa: C901, S107
         GITHUB_ORG_NAME,
         template_git_url,
         checkout,
+        name,
+        email,
         verify_config,
-        no_kernel,
+        handle_no_kernel_argument(no_kernel),
     )
 
 
@@ -123,6 +132,13 @@ def build(
         help="Verify git configuration files. Use --no-verify to disable verification (defaults to True).",
         show_default=True,
     ),
+    no_kernel: Annotated[
+        bool,
+        typer.Option(
+            "--no-kernel",
+            help="Do not install a kernel after the project is built (defaults to False).",
+        ),
+    ] = False,
 ) -> None:
     """:wrench:  Create a virtual environment and corresponding Jupyter kernel. Runs in the current folder if no arguments are supplied."""
     build_project(
@@ -131,6 +147,7 @@ def build(
         STAT_TEMPLATE_REPO_URL,
         STAT_TEMPLATE_DEFAULT_REFERENCE,
         verify_config,
+        handle_no_kernel_argument(no_kernel),
     )
 
 

{ssb_project_cli-1.4.2 → ssb_project_cli-1.4.4}/src/ssb_project_cli/ssb_project/create/create.py

@@ -36,6 +36,8 @@ def create_project(  # noqa: C901
     github_org_name: str,
     template_repo_url: str,
     checkout: str | None,
+    name: str | None,
+    email: str | None,
     verify_config: bool = True,
     no_kernel: bool = False,
 ) -> None:
@@ -52,6 +54,8 @@ def create_project(  # noqa: C901
         github_org_name: Name of GitHub organization
         template_repo_url: The Cookiecutter template URI.
         checkout: The git reference to check against. Supports branches, tags and commit hashes.
+        name: The project author's name (optional).
+        email: The project author's email (optional).
         verify_config: Determines if gitconfig is verified.
         no_kernel: Determines if a kernel shall be generated or not.
     """
@@ -101,6 +105,8 @@ def create_project(  # noqa: C901
             template_repo_url,
             checkout,
             working_directory,
+            name=name,
+            email=email,
         )
         build_project(
             project_directory,

{ssb_project_cli-1.4.2 → ssb_project_cli-1.4.4}/src/ssb_project_cli/ssb_project/util.py

@@ -170,3 +170,26 @@ def get_project_name_and_root_path(
                     # Final fall back to project root directory name
                     return path.name, path
     return None, None
+
+
+def handle_no_kernel_argument(no_kernel: bool) -> bool:
+    """Handle the 'no_kernel' parameter and environment variable.
+
+    The CLI flag is always prioritised, otherwise it falls back to the environment
+    variable and then lastly defaults to False.
+    """
+    if no_kernel:
+        return no_kernel
+    env_var_no_kernel = os.environ.get("NO_KERNEL")
+    if env_var_no_kernel is None:  # handle NO_KERNEL is undefined case
+        return False
+    elif env_var_no_kernel not in ["True", "False"]:
+        print(
+            f"""
+              The value of the 'NO_KERNEL' environment variable is {os.environ["NO_KERNEL"]}.
+              The only valid values are True and False.
+            """
+        )
+        exit(1)
+    else:
+        return bool(env_var_no_kernel)