Merge pull request #8 from 56kyle/develop

Develop

Author: 56kyle

noxfile.py

@@ -1,16 +1,14 @@
-# noxfile.py
-# Nox configuration for the cookiecutter-robust-python TEMPLATE development and maintenance.
-# See https://nox.thea.codes/en/stable/config.html
-
+"""Noxfile for the cookiecutter-robust-python template."""
 from pathlib import Path
 import shutil
 import tempfile
-import sys
 
 import nox
 import platformdirs
+from nox.command import CommandFailed
 from nox.sessions import Session
 
+
 nox.options.default_venv_backend = "uv"
 
 DEFAULT_TEMPLATE_PYTHON_VERSION = "3.9"
@@ -45,6 +43,8 @@
 
 TEMPLATE_PYTHON_LOCATIONS: tuple[Path, ...] = (
     Path("noxfile.py"),
+    Path("scripts/*"),
+    Path("hooks/*")
 )
 
 TEMPLATE_CONFIG_AND_DOCS: tuple[Path, ...] = (
@@ -105,6 +105,31 @@ def uv_in_demo(session: Session) -> None:
     )
 
 
+@nox.session(name="in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def in_demo(session: Session) -> None:
+    session.install("cookiecutter", "platformdirs", "loguru", "typer")
+    session.run(
+        "python",
+        "scripts/generate-demo-project.py",
+        *GENERATE_DEMO_PROJECT_OPTIONS,
+    )
+    original_dir: Path = Path.cwd()
+    session.cd(DEMO_ROOT_FOLDER)
+    session.run(*session.posargs)
+    session.cd(original_dir)
+
+
+@nox.session(name="clear-cache", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def clear_cache(session: Session) -> None:
+    """Clear the cache of generated project demos.
+
+    Not commonly used, but sometimes permissions might get messed up if exiting mid-build and such.
+    """
+    session.log("Clearing cache of generated project demos...")
+    shutil.rmtree(PROJECT_DEMOS_FOLDER, ignore_errors=True)
+    session.log("Cache cleared.")
+
+
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)
 def lint(session: Session):
     """Lint the template's own Python files and configurations."""
@@ -170,7 +195,6 @@ def test(session: Session) -> None:
     generated_project_dir = temp_dir / "test_project" # Use the slug defined in --extra-context
     if not generated_project_dir.exists():
         session.error(f"Generated project directory not found: {generated_project_dir}")
-        return
 
     session.log(f"Changing to generated project directory: {generated_project_dir}")
     session.cd(generated_project_dir)
@@ -196,10 +220,9 @@ def release_template(session: Session):
     session.log("Running release process for the TEMPLATE using Commitizen...")
     try:
         session.run("git", "version", success_codes=[0], external=True, silent=True)
-    except nox.command.CommandFailed:
+    except CommandFailed:
         session.log("Git command not found. Commitizen requires Git.")
         session.skip("Git not available.")
-        return
 
     session.log("Checking Commitizen availability via uvx.")
     session.run("uvx", "cz", "--version", successcodes=[0], external=True)

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for cookiecutter-robust-python."""

tests/conftest.py

@@ -0,0 +1,71 @@
+"""Fixtures used in all tests for cookiecutter-robust-python."""
+
+import os
+import subprocess
+
+from pathlib import Path
+from typing import Generator
+
+import pytest
+from _pytest.tmpdir import TempPathFactory
+from cookiecutter.main import cookiecutter
+
+from tests.constants import REPO_FOLDER
+
+
+pytest_plugins: list[str] = ["pytester"]
+
+
+@pytest.fixture(scope="session")
+def robust_python_demo_path(tmp_path_factory: TempPathFactory) -> Path:
+    """Creates a temporary example python project for testing against and returns its Path."""
+    demos_path: Path = tmp_path_factory.mktemp("demos")
+    cookiecutter(
+        str(REPO_FOLDER),
+        no_input=True,
+        overwrite_if_exists=True,
+        output_dir=demos_path,
+        extra_context={
+            "project_name": "robust-python-demo",
+            "add_rust_extension": False
+        }
+    )
+    path: Path = demos_path / "robust-python-demo"
+    subprocess.run(["uv", "lock"], cwd=path)
+    return path
+
+
+@pytest.fixture(scope="session")
+def robust_maturin_demo_path(tmp_path_factory: TempPathFactory) -> Path:
+    """Creates a temporary example maturin project for testing against and returns its Path."""
+    demos_path: Path = tmp_path_factory.mktemp("demos")
+    cookiecutter(
+        str(REPO_FOLDER),
+        no_input=True,
+        overwrite_if_exists=True,
+        output_dir=demos_path,
+        extra_context={
+            "project_name": "robust-maturin-demo",
+            "add_rust_extension": True
+        }
+    )
+    path: Path = demos_path / "robust-maturin-demo"
+    subprocess.run(["uv", "sync"], cwd=path)
+    return path
+
+
+@pytest.fixture(scope="function")
+def inside_robust_python_demo(robust_python_demo_path: Path) -> Generator[Path, None, None]:
+    """Changes the current working directory to the robust-python-demo project."""
+    original_path: Path = Path.cwd()
+    os.chdir(robust_python_demo_path)
+    yield robust_python_demo_path
+    os.chdir(original_path)
+
+
+@pytest.fixture(scope="function")
+def inside_robust_maturin_demo(robust_maturin_demo_path: Path) -> Generator[Path, None, None]:
+    original_path: Path = Path.cwd()
+    os.chdir(robust_maturin_demo_path)
+    yield robust_maturin_demo_path
+    os.chdir(original_path)

tests/constants.py

@@ -0,0 +1,47 @@
+"""Module containing constants used throughout all tests."""
+import json
+from pathlib import Path
+from typing import Any
+
+REPO_FOLDER: Path = Path(__file__).parent.parent
+COOKIECUTTER_FOLDER: Path = REPO_FOLDER / "{{cookiecutter.project_name}}"
+HOOKS_FOLDER: Path = REPO_FOLDER / "hooks"
+SCRIPTS_FOLDER: Path = REPO_FOLDER / "scripts"
+
+COOKIECUTTER_JSON_PATH: Path = REPO_FOLDER / "cookiecutter.json"
+COOKIECUTTER_JSON: dict[str, Any] = json.loads(COOKIECUTTER_JSON_PATH.read_text())
+
+MIN_PYTHON_SLUG: int = int(COOKIECUTTER_JSON["min_python_version"].lstrip("3."))
+MAX_PYTHON_SLUG: int = int(COOKIECUTTER_JSON["max_python_version"].lstrip("3."))
+PYTHON_VERSIONS: list[str] = [f"3.{VERSION_SLUG}" for VERSION_SLUG in range(MIN_PYTHON_SLUG, MAX_PYTHON_SLUG + 1)]
+DEFAULT_PYTHON_VERSION: str = PYTHON_VERSIONS[1]
+
+
+TYPE_CHECK_NOX_SESSIONS: list[str] = [f"typecheck-{python_version}" for python_version in PYTHON_VERSIONS]
+TESTS_NOX_SESSIONS: list[str] = [f"tests-{python_version}" for python_version in PYTHON_VERSIONS]
+CHECK_NOX_SESSIONS: list[str] = [f"check-{python_version}" for python_version in PYTHON_VERSIONS]
+FULL_CHECK_NOX_SESSIONS: list[str] = [f"full-check-{python_version}" for python_version in PYTHON_VERSIONS]
+
+
+GLOBAL_NOX_SESSIONS: list[str] = [
+    "pre-commit",
+    "format-python",
+    "lint-python",
+    *TYPE_CHECK_NOX_SESSIONS,
+    "docs-build",
+    "build-python",
+    "build-container",
+    "publish-python",
+    "release",
+    "tox",
+    *CHECK_NOX_SESSIONS,
+    *FULL_CHECK_NOX_SESSIONS,
+    "coverage"
+]
+
+RUST_NOX_SESSIONS: list[str] = [
+    "format-rust",
+    "lint-rust",
+    "tests-rust",
+    "publish-rust"
+]

tests/integration_tests/__init__.py

@@ -0,0 +1,2 @@
+"""Integration tests for cookiecutter-robust-python."""
+

tests/integration_tests/conftest.py

@@ -0,0 +1 @@
+"""Fixtures used in integration tests for cookiecutter-robust-python."""

tests/integration_tests/test_robust_python_demo.py

@@ -0,0 +1,29 @@
+"""Tests project generation and template functionality using a Python build backend."""
+import subprocess
+from pathlib import Path
+
+import pytest
+
+from tests.constants import GLOBAL_NOX_SESSIONS
+
+
+def test_demo_project_generation(robust_python_demo_path: Path) -> None:
+    assert robust_python_demo_path.exists()
+
+
+@pytest.mark.parametrize("session", GLOBAL_NOX_SESSIONS)
+def test_demo_project_noxfile(robust_python_demo_path: Path, session: str) -> None:
+    command: list[str] = ["uvx", "nox", "-s", session]
+    result: subprocess.CompletedProcess = subprocess.run(
+        command,
+        cwd=robust_python_demo_path,
+        capture_output=True,
+        text=True,
+        timeout=10.0,
+    )
+    print(result.stdout)
+    print(result.stderr)
+    result.check_returncode()
+
+
+

{{cookiecutter.project_name}}/noxfile.py

@@ -1,12 +1,12 @@
 """Noxfile for the {{cookiecutter.project_name}} project."""
-
 from pathlib import Path
 from typing import List
 
 import nox
 from nox.command import CommandFailed
 from nox.sessions import Session
 
+
 nox.options.default_venv_backend = "uv"
 
 # Logic that helps avoid metaprogramming in cookiecutter-robust-python
@@ -86,12 +86,11 @@ def tests_python(session: Session) -> None:
     junitxml_file = test_results_dir / f"test-results-py{session.python}.xml"
 
     session.run(
-        "uv", "run", "pytest",
+        "pytest",
         "--cov={}".format(PACKAGE_NAME),
         "--cov-report=xml",
         f"--junitxml={junitxml_file}",
-        "tests/",
-        external=True
+        "tests/"
     )
 
 
@@ -151,15 +150,15 @@ def build_container(session: Session) -> None:
     try:
         session.run("docker", "info", success_codes=[0], external=True, silent=True)
         container_cli = "docker"
-    except nox.command.CommandFailed:
+    except CommandFailed:
         try:
             session.run("podman", "info", success_codes=[0], external=True, silent=True)
             container_cli = "podman"
-        except nox.command.CommandFailed:
+        except CommandFailed:
             session.log("Neither Docker nor Podman command found. Please install a container runtime.")
             session.skip("Container runtime not available.")
 
-    current_dir = Path(".")
+    current_dir: Path = Path.cwd()
     session.log(f"Ensuring core dependencies are synced in {current_dir.resolve()} for build context...")
     session.run("uv", "sync", "--locked", external=True)
 
@@ -177,6 +176,8 @@ def publish_python(session: Session) -> None:
     Requires packages to be built first (`nox -s build-python` or `nox -s build`).
     Requires TWINE_USERNAME/TWINE_PASSWORD or TWINE_API_KEY environment variables set (usually in CI).
     """
+    session.run("uv", "sync", "--locked", "--group", "dev", external=True)
+
     session.log("Checking built packages with Twine.")
     session.run("uvx", "twine", "check", "dist/*", external=True)
 
@@ -201,9 +202,11 @@ def release(session: Session) -> None:
     Optionally accepts increment (major, minor, patch) after '--'.
     """
     session.log("Running release process using Commitizen...")
+    session.run("uv", "sync", "--locked", "--group", "dev", external=True)
+
     try:
         session.run("git", "version", success_codes=[0], external=True, silent=True)
-    except nox.command.CommandFailed:
+    except CommandFailed:
         session.log("Git command not found. Commitizen requires Git.")
         session.skip("Git not available.")
 
@@ -243,6 +246,8 @@ def tox(session: Session) -> None:
     Accepts tox args after '--' (e.g., `nox -s tox -- -e py39`).
     """
     session.log("Running Tox test matrix via uvx...")
+    session.run("uv", "sync", "--locked", "--group", "dev", external=True)
+
     tox_ini_path = Path("tox.ini")
     if not tox_ini_path.exists():
         session.log("tox.ini file not found at %s. Tox requires this file.", str(tox_ini_path))
@@ -309,13 +314,13 @@ def coverage(session: Session) -> None:
     session.log("Installing dependencies for coverage report session...")
     session.run("uv", "sync", "--locked", "--group", "dev", "--group", "test", external=True)
 
-    coverage_combined_file = Path(".") / ".coverage"
+    coverage_combined_file: Path = Path.cwd() / ".coverage"
 
     session.log("Combining coverage data.")
     try:
         session.run("uv", "run", "coverage", "combine", external=True)
         session.log(f"Combined coverage data into {coverage_combined_file.resolve()}")
-    except nox.command.CommandFailed as e:
+    except CommandFailed as e:
         if e.returncode == 1:
              session.log("No coverage data found to combine. Run tests first with coverage enabled.")
         else:
@@ -329,4 +334,4 @@ def coverage(session: Session) -> None:
     session.log("Running terminal coverage report.")
     session.run("uv", "run", "coverage", "report", external=True)
 
-    session.log(f"Coverage reports generated in ./{str(coverage_html_dir)} and terminal.")
+    session.log(f"Coverage reports generated in ./{coverage_html_dir} and terminal.")

{{cookiecutter.project_name}}/pyproject.toml

@@ -22,6 +22,7 @@ classifiers = [
 dependencies = [
     "loguru>=0.7.3",
     "platformdirs>=4.3.8",
+    "typer>=0.15.4"
 ]
 
 [dependency-groups]

{{cookiecutter.project_name}}/src/{{cookiecutter.package_name}}/__main__.py

@@ -3,11 +3,12 @@
 import typer
 
 
-@typer.command()
-@typer.version_option()
+app: typer.Typer = typer.Typer()
+
+@app.command(name="{{cookiecutter.project_name}}")
 def main() -> None:
     """{{cookiecutter.friendly_name}}."""
 
 
 if __name__ == "__main__":
-    main(prog_name="{{cookiecutter.project_name}}")  # pragma: no cover
+    app()