Merge pull request #5 from 56kyle/develop

Develop

Author: 56kyle

.gitignore

@@ -0,0 +1,64 @@
+.mypy_cache/
+/.coverage
+/.coverage.*
+/.nox/
+/.python-version
+/.pytype/
+/dist/
+/docs/_build/
+/src/*.egg-info/
+
+# Byte-code files
+*.pyc
+__pycache__
+*.pyd
+*.so
+*.o
+*.pyo # Older optimization files
+
+# Virtual environments
+.venv
+venv
+env
+__pypackages__ # If using PEP 582 default (uv does standard venv by default)
+.nox           # Nox environments
+# Other env dirs like virtualenvwrapper workdirs if applicable
+
+# Build outputs
+dist/          # Package distributions (sdist, wheel)
+build/         # Build artifacts from setuptools/build backends
+.hypothesis/   # Hypothesis testing cache
+
+# Test/Coverage related
+.pytest_cache/ # Pytest cache directory
+htmlcov/       # Coverage HTML reports (default output dir)
+.coverage*     # Coverage data files (default name pattern)
+test-results/  # Directory for JUnit/Coverage XML reports (as configured in noxfile)
+
+# Editor/IDE specific files
+.vscode/       # VS Code settings (if not shared via devcontainer)
+.idea/         # JetBrains IDE files
+*.swp          # Vim swap files
+
+# OS specific
+.DS_Store      # macOS files
+Thumbs.db      # Windows thumbnail cache
+
+# MyPy cache (if used standalone or by IDE)
+.mypy_cache/
+
+# Pyright cache
+.pyright/
+
+# Ruff cache
+.ruff_cache/
+
+# Bandit cache/baselines (if used standalone)
+.bandit_baseline
+
+# Development logs/outputs
+debug.log
+nohup.out
+
+# Cookiecutter/Cruft metadata (for template updates)
+.cruft.json

cookiecutter.json

@@ -4,6 +4,7 @@
   "friendly_name": "{{ cookiecutter.project_name.replace('-', ' ').title() }}",
   "min_python_version": "3.9",
   "max_python_version": "3.13",
+  "add_rust_extension": false,
   "author": "Kyle Oliver",
   "email": "56kyleoliver+cookiecutter-robust-python@gmail.com",
   "github_user": "56kyle",

noxfile.py

@@ -8,11 +8,40 @@
 import sys
 
 import nox
+import platformdirs
 from nox.sessions import Session
 
 nox.options.default_venv_backend = "uv"
 
-DEFAULT_TEMPLATE_PYTHON_VERSION = "3.12"
+DEFAULT_TEMPLATE_PYTHON_VERSION = "3.9"
+
+REPO_ROOT: Path = Path(__file__).parent.resolve()
+TEMPLATE_FOLDER: Path = REPO_ROOT / "{{cookiecutter.project_name}}"
+
+
+COOKIECUTTER_ROBUST_PYTHON_CACHE_FOLDER: Path = Path(
+    platformdirs.user_cache_path(
+        appname="cookiecutter-robust-python",
+        appauthor="56kyle",
+        ensure_exists=True,
+    )
+).resolve()
+
+PROJECT_DEMOS_FOLDER: Path = COOKIECUTTER_ROBUST_PYTHON_CACHE_FOLDER / "project_demos"
+DEFAULT_DEMO_NAME: str = "demo-project"
+DEMO_ROOT_FOLDER: Path = PROJECT_DEMOS_FOLDER / DEFAULT_DEMO_NAME
+
+GENERATE_DEMO_PROJECT_OPTIONS: tuple[str, ...] = (
+    *("--repo-folder", REPO_ROOT),
+    *("--demos-cache-folder", PROJECT_DEMOS_FOLDER),
+    *("--demo-name", DEFAULT_DEMO_NAME),
+)
+
+SYNC_UV_WITH_DEMO_OPTIONS: tuple[str, ...] = (
+    *("--template-folder", TEMPLATE_FOLDER),
+    *("--demos-cache-folder", PROJECT_DEMOS_FOLDER),
+    *("--demo-name", DEFAULT_DEMO_NAME),
+)
 
 TEMPLATE_PYTHON_LOCATIONS: tuple[Path, ...] = (
     Path("noxfile.py"),
@@ -34,8 +63,46 @@
 )
 
 
-# === TEMPLATE MAINTENANCE TASKS ===
-# Sessions for checking, formatting, building, and releasing the template itself.
+@nox.session(name="generate-demo-project", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def generate_demo_project(session: Session) -> None:
+    session.install("cookiecutter", "platformdirs", "loguru", "typer")
+    session.run(
+        "python",
+        "scripts/generate-demo-project.py",
+        *GENERATE_DEMO_PROJECT_OPTIONS,
+        external=True,
+    )
+
+
+@nox.session(name="sync-uv-with-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def sync_uv_with_demo(session: Session) -> None:
+    session.install("cookiecutter", "platformdirs", "loguru", "typer")
+    session.run(
+        "python",
+        "scripts/sync-uv-with-demo.py",
+        *SYNC_UV_WITH_DEMO_OPTIONS,
+        external=True,
+    )
+
+@nox.session(name="uv-in-demo", python=DEFAULT_TEMPLATE_PYTHON_VERSION)
+def uv_in_demo(session: Session) -> None:
+    session.install("cookiecutter", "platformdirs", "loguru", "typer")
+    session.run(
+        "python",
+        "scripts/generate-demo-project.py",
+        *GENERATE_DEMO_PROJECT_OPTIONS,
+        external=True,
+    )
+    original_dir: Path = Path.cwd()
+    session.cd(DEMO_ROOT_FOLDER)
+    session.run("uv", *session.posargs)
+    session.cd(original_dir)
+    session.run(
+        "python",
+        "scripts/sync-uv-with-demo.py",
+        *SYNC_UV_WITH_DEMO_OPTIONS,
+        external=True,
+    )
 
 
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)
@@ -74,15 +141,6 @@ def docs(session: Session):
     session.log(f"Template documentation built in {docs_build_dir.resolve()}.")
 
 
-@nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)
-def generate_project(session: Session) -> None:
-    """Generate a demo project using the template."""
-    session.log("Installing demo project generation dependencies...")
-    session.install("cookiecutter", "typer")
-    session.run("generate-demo-project", "--repo-folder=.", "--demos-cache-folder=.", "--demo-name=demo_project")
-
-
-
 @nox.session(python=DEFAULT_TEMPLATE_PYTHON_VERSION)
 def test(session: Session) -> None:
     """Run tests for the template's own functionality.
@@ -104,19 +162,7 @@ def test(session: Session) -> None:
     # Run cookiecutter to generate a project
     # Need to find cookiecutter executable - it's in the template dev env installed by uv sync.
     cookiecutter_command: list[str] = ["uv", "run", "cookiecutter", "--no-input", "--output-dir", str(temp_dir), "."]
-    # Add cookiecutter variables to customize the generated project for testing, using --extra-context
-    cookiecutter_command.extend([
-        "--extra-context",
-        "project_name='Test Project'",
-        "project_slug='test_project'",
-        "package_name='test_package'",
-        "author_name='Test Author'",
-        "author_email='test@example.com'",
-        "license='MIT'",
-        "python_version='3.13'", # Use a fixed version for test stability
-        "add_rust_extension='n'", # Test without Rust initially, add another test session for Rust
-        # Add other variables needed by cookiecutter.json here to ensure no prompts
-    ])
+
 
     session.run(*cookiecutter_command, external=True)
 

pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "cookiecutter-robust-python"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.9,<4.0"
+dependencies = [
+    "cookiecutter>=2.6.0",
+    "cruft>=2.16.0",
+    "loguru>=0.7.3",
+    "platformdirs>=4.3.8",
+]
+[project.optional-dependencies]
+dev = [
+    "nox>=2024.3.2",
+    "commitizen>=3.11.1",
+    "pre-commit>=3.7.0",
+]
+
+test = [
+    "pytest>=8.1.1",
+    "pytest-cov>=5.0.0",
+]
+
+typecheck = [
+    "pyright>=1.1.356"
+]
+
+lint = [
+    "ruff>=0.3.5",
+    "pydocstyle>=6.3.0",
+]
+
+security = [
+    "pip-audit>=2.8.4",
+    "bandit>=1.7.7",
+]
+
+docs = [
+    "sphinx>=7.3.7",
+    "myst-parser>=2.0.0",
+    "furo>=2024.3.4",
+    "sphinx-copybutton>=0.5",
+    "sphinx-autodoc-typehints>=1.24.0",
+]

scripts/generate-demo-project.py

@@ -2,14 +2,15 @@
 
 import shutil
 import sys
+from functools import partial
 from pathlib import Path
 from typing import Annotated
 
 import typer
 
 from cookiecutter.main import cookiecutter
 
-FOLDER_TYPE: click.Path = click.Path(dir_okay=True, file_okay=False, resolve_path=True, path_type=Path)
+FolderOption: partial[typer.Option] = partial(typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path)
 
 
 def generate_demo_project(repo_folder: Path, demos_cache_folder: Path, demo_name: str) -> Path:
@@ -31,23 +32,22 @@ def _remove_any_existing_demo(parent_path: Path) -> None:
     for path in parent_path.iterdir():
         shutil.rmtree(path)
 
+cli: typer.Typer = typer.Typer()
 
-@typer.command()
-@click.option("--repo-folder", "-r", required=True, type=FOLDER_TYPE)
-@click.option("--demos-cache-folder", "-c", required=True, type=FOLDER_TYPE)
-@click.option("--demo-name", "-d", required=True, type=str)
+
+@cli.callback(invoke_without_command=True)
 def main(
-    repo_folder: Annotated[Path, typer.Option()],
-    demos_cache_folder: Path,
-        demo_name: str
+    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")]
 ) -> None:
     """Updates the poetry.lock file."""
     try:
         generate_demo_project(repo_folder=repo_folder, demos_cache_folder=demos_cache_folder, demo_name=demo_name)
     except Exception as error:
-        click.secho(f"error: {error}", fg="red")
+        typer.secho(f"error: {error}", fg="red")
         sys.exit(1)
 
 
 if __name__ == "__main__":
-    main(prog_name="generate-demo-project")
+    cli()

scripts/sync-uv-with-demo.py

@@ -1,56 +1,65 @@
-"""Module used to sync the poetry.lock file with one generated using a demo project."""
+"""Module used to sync the uv.lock file with one generated using a demo project."""
 
 import shutil
 import sys
+from functools import partial
 from pathlib import Path
+from typing import Annotated
 
-import click
+import typer
 
-from loguru import logger
+from typer.models import OptionInfo
 
+from loguru import logger
 
-FOLDER_TYPE: click.Path = click.Path(dir_okay=True, file_okay=False, resolve_path=True, path_type=Path)
+FolderOption: partial[OptionInfo] = partial(
+    typer.Option, dir_okay=True, file_okay=False, resolve_path=True, path_type=Path
+)
 
 
-def sync_poetry_with_demo(template_folder: Path, demos_cache_folder: Path, demo_name: str) -> None:
+def sync_uv_with_demo(template_folder: Path, demos_cache_folder: Path, demo_name: str) -> None:
     demo_root: Path = demos_cache_folder / demo_name
-    demo_poetry_lock_path: Path = _find_poetry_lock_path(demo_root)
-    output_poetry_lock_path: Path = _find_poetry_lock_path(template_folder)
+    demo_uv_lock_path: Path = _find_uv_lock_path(demo_root)
+    output_uv_lock_path: Path = _find_uv_lock_path(template_folder)
 
-    _copy_poetry_lock_from_demo(
-        demo_poetry_lock_path=demo_poetry_lock_path, output_poetry_lock_path=output_poetry_lock_path
+    _copy_uv_lock_from_demo(
+        demo_uv_lock_path=demo_uv_lock_path, output_uv_lock_path=output_uv_lock_path
     )
-    logger.info(f"Copied demo from {demo_poetry_lock_path=} to {output_poetry_lock_path=}.")
+    logger.info(f"Copied demo from {demo_uv_lock_path=} to {output_uv_lock_path=}.")
 
 
-def _copy_poetry_lock_from_demo(demo_poetry_lock_path: Path, output_poetry_lock_path: Path) -> None:
-    """Copies over the poetry.lock file from the provided demo project root."""
+def _copy_uv_lock_from_demo(demo_uv_lock_path: Path, output_uv_lock_path: Path) -> None:
+    """Copies over the uv.lock file from the provided demo project root."""
     shutil.copy(
-        src=demo_poetry_lock_path,
-        dst=output_poetry_lock_path,
+        src=demo_uv_lock_path,
+        dst=output_uv_lock_path,
     )
 
 
-def _find_poetry_lock_path(search_root: Path) -> Path:
-    for path in search_root.rglob("poetry.lock"):
+def _find_uv_lock_path(search_root: Path) -> Path:
+    for path in search_root.rglob("uv.lock"):
         return path
-    raise FileNotFoundError(f"Failed to find a poetry.lock within the provided search path: {search_root=}")
+    raise FileNotFoundError(f"Failed to find a uv.lock within the provided search path: {search_root=}")
+
+
+cli: typer.Typer = typer.Typer()
 
 
-@click.command()
-@click.option("--template-folder", "-t", required=True, type=FOLDER_TYPE)
-@click.option("--demos-cache-folder", "-c", required=True, type=FOLDER_TYPE)
-@click.option("--demo-name", "-d", required=True, type=str)
-def main(template_folder: Path, demos_cache_folder: Path, demo_name: str) -> None:
-    """Updates the poetry.lock file."""
+@cli.callback(invoke_without_command=True)
+def main(
+    template_folder: Annotated[Path, FolderOption("--template-folder", "-t", exists=True)],
+    demos_cache_folder: Annotated[Path, FolderOption("--demos-cache-folder", "-c", exists=True)],
+    demo_name: Annotated[str, typer.Option("--demo-name", "-d")]
+) -> None:
+    """Updates the uv.lock file."""
     try:
-        sync_poetry_with_demo(
+        sync_uv_with_demo(
             template_folder=template_folder, demos_cache_folder=demos_cache_folder, demo_name=demo_name
         )
     except Exception as error:
-        click.secho(f"error: {error}", fg="red")
+        typer.secho(f"error: {error}", fg="red")
         sys.exit(1)
 
 
 if __name__ == "__main__":
-    main(prog_name="prepare-github-release")
+    cli()