Merge pull request #19 from 56kyle/develop

Develop

Author: 56kyle

README.md

@@ -6,11 +6,11 @@ A Python project template robust enough to follow up [cookiecutter-hypermodern-p
 
 I really believe this idea has a lot of good ideas and best practices, however, creating it is a ton of work.
 
-There is definitely a lot left to do before this project is truly a daily driver, but I think there are just a few more pieces missing from this being at least useful in many cases.
-
 If you have any interest in this project, please don't hesitate to reach out!
 Any advice, support, PR's, etc. are welcome and would be greatly appreciated.
 
+As it stands this project is getting rather close to being ready, but not quite yet. Mainly I want to ensure the github actions pipeline is steady, but once that is done it should be alright for use.
+
 # Why does this project exist?
 
 Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.

noxfile.py

@@ -1,7 +1,6 @@
 """Noxfile for the cookiecutter-robust-python template."""
 import os
 import shutil
-import tempfile
 from pathlib import Path
 
 import nox
@@ -36,15 +35,15 @@
 
 GENERATE_DEMO_SCRIPT: Path = SCRIPTS_FOLDER / "generate-demo.py"
 GENERATE_DEMO_OPTIONS: tuple[str, ...] = (
-    *("--repo-folder", REPO_ROOT),
     *("--demos-cache-folder", PROJECT_DEMOS_FOLDER),
-    *("--demo-name", DEFAULT_DEMO_NAME),
 )
 
-
 LINT_FROM_DEMO_SCRIPT: Path = SCRIPTS_FOLDER / "lint-from-demo.py"
 LINT_FROM_DEMO_OPTIONS: tuple[str, ...] = GENERATE_DEMO_OPTIONS
 
+UPDATE_DEMO_SCRIPT: Path = SCRIPTS_FOLDER / "update-demo.py"
+UPDATE_DEMO_OPTIONS: tuple[str, ...] = GENERATE_DEMO_OPTIONS
+
 
 @nox.session(name="generate-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
 def generate_demo(session: Session) -> None:
@@ -123,6 +122,19 @@ def test(session: Session) -> None:
     session.run("pytest", "tests")
 
 
+@nox.parametrize(arg_names="add_rust_extension", arg_values_list=[False], ids=["no-rust"])
+@nox.session(name="update-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def update_demo(session: Session, add_rust_extension: bool) -> None:
+    session.log("Installing script dependencies for updating generated project demos...")
+    session.install("cookiecutter", "cruft", "platformdirs", "loguru", "typer")
+
+    session.log("Updating generated project demos...")
+    args: list[str] = [*UPDATE_DEMO_OPTIONS]
+    if add_rust_extension:
+        args.append("--add-rust-extension")
+    session.run("python", UPDATE_DEMO_SCRIPT, *args)
+
+
 @nox.session(venv_backend="none")
 def release_template(session: Session):
     """Run the release process for the TEMPLATE using Commitizen.
@@ -158,3 +170,11 @@ def release_template(session: Session):
 
     session.log("Template version bumped and tag created locally via Commitizen/uvx.")
     session.log("IMPORTANT: Push commits and tags to remote (`git push --follow-tags`) to trigger CD for the TEMPLATE.")
+
+
+@nox.session(python=False)
+def remove_demo_release(session: Session) -> None:
+    """Deletes the latest demo release."""
+    session.run("git", "branch", "-d", f"release/{session.posargs[0]}", external=True)
+    session.run("git", "push", "--progress", "--porcelain", "origin", f"release/{session.posargs[0]}", external=True)
+

pyproject.toml

@@ -30,7 +30,6 @@ docs = [
     "sphinx-tabs>=3.4.7",
 ]
 lint = [
-    "pydocstyle>=6.3.0",
     "ruff>=0.11.9",
 ]
 security = [

scripts/generate-demo.py

@@ -15,17 +15,15 @@
 
 @cli.callback(invoke_without_command=True)
 def main(
-    repo_folder: Annotated[Path, FolderOption("--repo-folder", "-r")],
     demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c")],
-    demo_name: Annotated[str, typer.Option("--demo-name", "-d")],
-    no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False,
+    add_rust_extension: Annotated[bool, typer.Option("--add-rust-extension", "-r")] = False,
+    no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False
 ) -> None:
     """Updates the poetry.lock file."""
     try:
         generate_demo(
-            repo_folder=repo_folder,
             demos_cache_folder=demos_cache_folder,
-            demo_name=demo_name,
+            add_rust_extension=add_rust_extension,
             no_cache=no_cache
         )
     except Exception as error:

scripts/lint-from-demo.py

@@ -16,17 +16,15 @@
 
 @cli.callback(invoke_without_command=True)
 def lint_from_demo(
-    repo_folder: Annotated[Path, FolderOption("--repo-folder", "-r")],
     demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c")],
-    demo_name: Annotated[str, typer.Option("--demo-name", "-d")],
-    no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False,
+    add_rust_extension: Annotated[bool, typer.Option("--add-rust-extension", "-r")] = False,
+    no_cache: Annotated[bool, typer.Option("--no-cache", "-n")] = False
 ) -> None:
     """Runs precommit in a generated project and matches the template to the results."""
     try:
         with in_new_demo(
-            repo_folder=repo_folder,
             demos_cache_folder=demos_cache_folder,
-            demo_name=demo_name,
+            add_rust_extension=add_rust_extension,
             no_cache=no_cache
         ) as demo_path:
             pre_commit.main.main(["run", "--all-files", "--hook-stage=manual", "--show-diff-on-failure"])

scripts/update-demo.py

@@ -0,0 +1,45 @@
+import sys
+from pathlib import Path
+from typing import Annotated
+
+import cruft
+import typer
+from cookiecutter.utils import work_in
+
+from util import get_demo_name
+from util import git
+from util import FolderOption
+from util import REPO_FOLDER
+
+
+cli: typer.Typer = typer.Typer()
+
+
+@cli.callback(invoke_without_command=True)
+def update_demo(
+    demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c")],
+    add_rust_extension: Annotated[bool, typer.Option("--add-rust-extension", "-r")] = False
+) -> None:
+    """Runs precommit in a generated project and matches the template to the results."""
+    try:
+        demo_name: str = get_demo_name(add_rust_extension=add_rust_extension)
+        demo_path: Path = demos_cache_folder / demo_name
+        typer.secho(f"Updating demo project at {demo_path=}.", fg="yellow")
+        with work_in(demo_path):
+            git("status", "--porcelain")
+            cruft.update(
+                project_dir=demo_path,
+                template_path=REPO_FOLDER,
+                extra_context={"project_name": demo_name, "add_rust_extension": add_rust_extension},
+            )
+            git("add", ".")
+            git("commit", "-m", "chore: update demo to the latest cookiecutter-robust-python", "--no-verify")
+            git("push")
+
+    except Exception as error:
+        typer.secho(f"error: {error}", fg="red")
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    cli()

scripts/util.py

@@ -13,12 +13,14 @@
 
 import cruft
 import typer
-from cookiecutter.main import cookiecutter
 from cookiecutter.utils import work_in
 from pygments.lexers import q
 from typer.models import OptionInfo
 
 
+REPO_FOLDER: Path = Path(__file__).resolve().parent.parent
+
+
 FolderOption: partial[OptionInfo] = partial(
     typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path
 )
@@ -50,17 +52,15 @@ def run_command(command: str, *args: str) -> subprocess.CompletedProcess:
 
 @contextmanager
 def in_new_demo(
-    repo_folder: Path,
     demos_cache_folder: Path,
-    demo_name: str,
+    add_rust_extension: bool,
     no_cache: bool,
     **kwargs: Any
 ) -> Generator[Path, None, None]:
     """Returns a context manager for working within a new demo."""
     demo_path: Path = generate_demo(
-        repo_folder=repo_folder,
         demos_cache_folder=demos_cache_folder,
-        demo_name=demo_name,
+        add_rust_extension=add_rust_extension,
         no_cache=no_cache,
         **kwargs
     )
@@ -69,20 +69,20 @@ def in_new_demo(
 
 
 def generate_demo(
-    repo_folder: Path,
     demos_cache_folder: Path,
-    demo_name: str,
+    add_rust_extension: bool,
     no_cache: bool,
     **kwargs: Any
 ) -> Path:
     """Generates a demo project and returns its root path."""
+    demo_name: str = get_demo_name(add_rust_extension=add_rust_extension)
     demos_cache_folder.mkdir(exist_ok=True)
     if no_cache:
         _remove_existing_demo(demo_path=demos_cache_folder / demo_name)
     cruft.create(
-        template_git_url=str(repo_folder),
+        template_git_url=str(REPO_FOLDER),
         output_dir=demos_cache_folder,
-        extra_context={"project_name": demo_name, **kwargs},
+        extra_context={"project_name": demo_name, "add_rust_extension": add_rust_extension, **kwargs},
         no_input=True,
         overwrite_if_exists=True
     )
@@ -104,3 +104,8 @@ def _remove_existing_demo(demo_path: Path) -> None:
 
         typer.secho(f"Removing existing demo project at {demo_path=}.", fg="yellow")
         shutil.rmtree(demo_path, onerror=remove_readonly)
+
+
+def get_demo_name(add_rust_extension: bool) -> str:
+    name_modifier: str = "maturin" if add_rust_extension else "python"
+    return f"robust-{name_modifier}-demo"

tests/constants.py

@@ -22,7 +22,7 @@
 TYPE_CHECK_NOX_SESSIONS: list[str] = [f"typecheck-{python_version}" for python_version in PYTHON_VERSIONS]
 TESTS_NOX_SESSIONS: list[str] = [f"tests-python-{python_version}" for python_version in PYTHON_VERSIONS]
 
-GLOBAL_NOX_SESSIONS: list[str] = [
+IDEMPOTENT_NOX_SESSIONS: list[str] = [
     "pre-commit",
     "lint-python",
     "format-python",
@@ -31,8 +31,13 @@
     "docs-build",
     "build-python",
     "build-container",
-    "publish-python",
-    "release",
     "tox",
     "coverage",
 ]
+CONTEXT_DEPENDENT_NOX_SESSIONS: list[str] = [
+    "coverage",
+    "publish-python",
+    "release",
+]
+
+ALL_NOX_SESSIONS: list[str] = IDEMPOTENT_NOX_SESSIONS + CONTEXT_DEPENDENT_NOX_SESSIONS

tests/integration_tests/test_robust_python_demo.py

@@ -4,12 +4,11 @@
 from pathlib import Path
 
 import pytest
-from pbr.options import TRUE_VALUES
 
-from tests.constants import GLOBAL_NOX_SESSIONS
+from tests.constants import IDEMPOTENT_NOX_SESSIONS
 
 
-@pytest.mark.parametrize("session", GLOBAL_NOX_SESSIONS)
+@pytest.mark.parametrize("session", IDEMPOTENT_NOX_SESSIONS)
 def test_demo_project_nox_session(robust_demo: Path, session: str) -> None:
     command: list[str] = ["nox", "-s", session]
     try:

tests/unit_tests/test_github_workflows.py

@@ -6,24 +6,24 @@
 from util import templates_matching
 
 
+@pytest.mark.parametrize(
+    argnames="robust_demo__is_setup",
+    argvalues=[False],
+    indirect=True,
+    ids=["no-setup"]
+)
 @pytest.mark.parametrize(
     argnames="robust_demo__add_rust_extension",
     argvalues=[False, True],
     indirect=True,
     ids=["base", "maturin"]
 )
 @pytest.mark.parametrize(
-    argnames="robust_demo__is_setup",
-    argvalues=[False],
+    argnames="robust_file__path__relative",
+    argvalues=templates_matching(".github/workflows/*.yml"),
     indirect=True,
-    ids=["no-setup"]
+    ids=lambda path: path.stem
 )
 class TestWorkflow:
-    @pytest.mark.parametrize(
-        argnames="robust_file__path__relative",
-        argvalues=templates_matching(".github/workflows/*.yml"),
-        indirect=True,
-        ids=lambda path: path.name
-    )
     def test_workflow_basic_loading(self, robust_yaml: dict[str, Any]) -> None:
         assert robust_yaml