Script that is run at startup before cookiecutter is invoked (#9)

Author: davidbrownell

src/PythonProjectBootstrapper/EntryPoint.py

@@ -6,6 +6,7 @@
 # ----------------------------------------------------------------------
 """This file serves as an example of how to create scripts that can be invoked from the command line once the package is installed."""
 
+import importlib
 import sys
 
 from enum import Enum
@@ -17,6 +18,7 @@
 from typer.core import TyperGroup  # type: ignore [import-untyped]
 
 from cookiecutter.main import cookiecutter
+from dbrownell_Common.ContextlibEx import ExitStack
 from dbrownell_Common import PathEx
 from PythonProjectBootstrapper import __version__
 
@@ -65,6 +67,7 @@ class ProjectType(str, Enum):
 _replay_option = typer.Option(
     "--replay", help="Do not prompt for input, instead read from saved json."
 )
+_yes_option = typer.Option("--yes", help="Answer yes to all prompts.")
 _version_option = typer.Option("--version", help="Display the current version and exit.")
 
 
@@ -91,6 +94,7 @@ def FrozenExecute(
         ],
         configuration_filename: Annotated[Optional[Path], _configuration_filename_option] = None,
         replay: Annotated[bool, _replay_option] = False,
+        yes: Annotated[bool, _yes_option] = False,
         version: Annotated[bool, _version_option] = False,
     ) -> None:
         if output_dir.is_file():
@@ -105,6 +109,7 @@ def FrozenExecute(
             output_dir,
             configuration_filename,
             replay=replay,
+            yes=yes,
             version=version,
         )
 
@@ -122,13 +127,15 @@ def StandardExecute(
         ],
         configuration_filename: Annotated[Optional[Path], _configuration_filename_option] = None,
         replay: Annotated[bool, _replay_option] = False,
+        yes: Annotated[bool, _yes_option] = False,
         version: Annotated[bool, _version_option] = False,
     ) -> None:
         _ExecuteOutputDir(
             project,
             output_dir,
             configuration_filename,
             replay=replay,
+            yes=yes,
             version=version,
         )
 
@@ -145,14 +152,29 @@ def _ExecuteOutputDir(
     configuration_filename: Optional[Path],
     *,
     replay: bool,
+    yes: bool,
     version: bool,
 ) -> None:
     if version:
         sys.stdout.write(__version__)
         return
 
+    project_dir = PathEx.EnsureDir(_project_root_dir / project.value)
+
+    # Does the project have a startup script? If so, invoke it dynamically.
+    potential_startup_script = project_dir / "hooks" / "startup.py"
+    if potential_startup_script.is_file():
+        sys.path.insert(0, str(potential_startup_script.parent))
+        with ExitStack(lambda: sys.path.pop(0)):
+            module = importlib.import_module(potential_startup_script.stem)
+
+            execute_func = getattr(module, "Execute", None)
+            if execute_func:
+                if execute_func(project_dir, output_dir, yes=yes) is False:
+                    return
+
     cookiecutter(
-        str(PathEx.EnsureDir(_project_root_dir / project.value)),
+        str(project_dir),
         output_dir=str(output_dir),
         config_file=str(configuration_filename) if configuration_filename is not None else None,
         replay=replay,

src/PythonProjectBootstrapper/package/hooks/post_gen_project.py

@@ -13,7 +13,7 @@
 from pathlib import Path
 
 from dbrownell_Common import PathEx
-from rich import print
+from rich import print  # pylint: disable=redefined-builtin
 from rich.panel import Panel
 
 

src/PythonProjectBootstrapper/package/hooks/startup.py

@@ -0,0 +1,73 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+import sys
+import textwrap
+import uuid
+
+from pathlib import Path
+
+from rich import print  # pylint: disable=redefined-builtin
+from rich.panel import Panel
+
+
+# ----------------------------------------------------------------------
+def Execute(
+    template_dir: Path,  # pylint: disable=unused-argument
+    output_dir: Path,
+    *,
+    yes: bool,
+) -> bool:
+    # Ensure that the panel content is easy to read and modify here, but also leverages Panel's word
+    # wrapping capabilities.
+    panel_content = textwrap.dedent(
+        """\
+        This project creates a Python package hosted on GitHub that uploads a Python wheel to PyPi.
+        It also includes opt-in functionality to create docker images that ensure the exact
+        reproducibility of all commits (which is especially useful for scientific software).
+
+        If you continue, you will be asked a series of questions about your project and given
+        step-by-step instructions on how to set up your project so that it works with 3rd party
+        solutions (GitHub, PyPi, etc.).
+
+        The entire process should take about 10 minutes to complete.
+        """,
+    )
+
+    paragraph_sentinel = str(uuid.uuid4())
+
+    panel_content = (
+        panel_content.replace("\n\n", paragraph_sentinel)
+        .replace("\n", " ")
+        .replace(paragraph_sentinel, "\n\n")
+    )
+
+    sys.stdout.write("\n")
+
+    print(
+        Panel(
+            panel_content.rstrip(),
+            border_style="red",
+            padding=1,
+            title="Python Package",
+        ),
+    )
+
+    if not yes:
+        while True:
+            sys.stdout.write("\nEnter 'yes' to continue or 'no' to exit: ")
+            result = input().strip().lower()
+
+            if result in ["yes", "y"]:
+                break
+
+            if result in ["no", "n"]:
+                return False
+
+    if not (output_dir / ".git").is_dir():
+        raise Exception(f"{output_dir} is not a git repository.")
+
+    return True

tests/EntryPoint_UnitTest.py

@@ -6,6 +6,10 @@
 # ----------------------------------------------------------------------
 """Unit tests for EntryPoint.py"""
 
+from pathlib import Path
+from unittest.mock import patch
+
+from dbrownell_Common import PathEx
 from typer.testing import CliRunner
 
 from PythonProjectBootstrapper import __version__
@@ -17,3 +21,15 @@ def test_Version():
     result = CliRunner().invoke(app, ["package", "<output_dir>", "--version"])
     assert result.exit_code == 0
     assert result.stdout == __version__
+
+
+# ----------------------------------------------------------------------
+def test_Standard():
+    with patch("PythonProjectBootstrapper.EntryPoint.cookiecutter") as mock_cookiecutter:
+        repo_root = PathEx.EnsureDir(Path(__file__).parent.parent)
+
+        result = CliRunner().invoke(app, ["package", str(repo_root), "--yes"])
+
+        assert result.exit_code == 0
+        assert "This project creates a Python package" in result.stdout
+        assert len(mock_cookiecutter.call_args_list) == 1