Merge pull request #13

General Fixes

Author: 56kyle

.pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = --show-capture=all

README.md

@@ -3,23 +3,23 @@
 A Python project template robust enough to follow up [cookiecutter-hypermodern-python]
 
 # Caveat
-I really believe this idea has a lot of good ideas and best practices, however creating it is a ton of work.
+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 and all advice, support, PR's, etc are welcome and would be greatly appreciated.
+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.
 
 
 # Why does this project exist?
 Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.
 While it will always have a place in my heart, there have been far too many improvements in Python tooling to keep using it as is.
 
-For a while I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however when it came time to switch
-to new tooling such as [ruff], [uv], [maturin], etc, I found the process of updating the existing tooling to be extremly painful.
+For a while I maintained [a personal fork](https://github.com/56kyle/cookiecutter-hypermodern-python) that I would update, however, when it came time to switch
+to new tooling such as [ruff], [uv], [maturin], etc., I found the process of updating the existing tooling to be extremely painful.
 
-The [Hypermodern Python Cookiecutter] remains as a fantastic sendoff point for devs interested in building a 2021 style Python Package, but there were
-a handfull of issues with it that prevented it from being able to adapt to new Python developments over the years.
+The [Hypermodern Python Cookiecutter] remains as a fantastic sendoff point for devs interested in building a 2021-style Python Package. However, there were
+a handful of issues with it that prevented it from being able to adapt to new Python developments over the years.
 
 # Okay, so what's different this time?
 The [Robust Python Cookiecutter] exists to solve a few main concerns
@@ -30,7 +30,7 @@ The [Robust Python Cookiecutter] exists to solve a few main concerns
 - [Project Neglect](#project-neglect)
 
 
-## Template Update Propogation
+## Template Update Propagation
 One of the main issues I encountered with [my personal fork] of the [Hypermodern Python Cookiecutter] was that any change
 I made to my repos would mean a later conflict if I tried to rerun [cookiecutter] to sync a change from a different project.
 
@@ -42,9 +42,9 @@ in the pyproject.toml.
 
 
 ## Project Domain Expansion
-Now, I'm not one to advocate for mixing languages together in a project. However, there is a really unique case that has arisen with the creation of [maturin].
+Now, I'm not one to advocate for mixing languages in a project. However, there is a unique case that has arisen with the creation of [maturin].
 
-There are a plethora of great projects such as [ruff], [uv], [polars], [just], etc all making use of [maturin] to get the performance improvements of [rust] while
+There are a plethora of great projects such as [ruff], [uv], [polars], [just], etc. all making use of [maturin] to get the performance improvements of [rust] while
 submitting their package to both pypi and crates.io
 
 Now, this definitely is not required by any means to make a good Python package, however this pattern only seems to be picking up momentum and has honestly been a massive boon
@@ -60,9 +60,6 @@ Additionally, the [Robust Python Cookiecutter] is designed with both normal and
 a quick [rust] module for performance or you are trying to publish a series of crates and packages, either case will be handled using a setup inspired by [polars].
 
 
-
-
-
 ## Documenting Tooling Decisions
 One of the really stand out features of the [Hypermodern Python Cookiecutter] was its incredibly detailed documentation.
 It did a pretty great job of describing the tooling to use, but there was a distinct lack of ***why*** these decisions were made.
@@ -72,11 +69,11 @@ It may seem like a small detail, but detailing why a decision was made has an in
 Rather than having to go through a mini crusade to determine whether we use [poetry] or [uv], we can just point to the
 [existing reasoning](https://cookiecutter-robust-python.readthedocs.io/en/latest/topics/02_dependency_management.md#option-2--term--poetry) to see if it still is true or not.
 
-Overall it's rather rare that people debate over tooling for no reason. Most things have merit in some cases, and a large goal of this template is identifying the tools that have the most merit in almost all cases.
+Overall, it's rather rare that people debate over tooling for no reason. Most things have merit in some cases, and a large goal of this template is identifying the tools that have the most merit in almost all cases.
 
 ## CI/CD Vendor Lock
 Now don't get me wrong, I love [github-actions] and do pretty much everything in my power to avoid [bitbucket-pipelines].
-However, not all jobs have the luxury of github, and I would love to be able to just use the same template for both my personal and professional projects.
+However, not all jobs have the luxury of GitHub, and I would love to be able to just use the same template for both my personal and professional projects.
 
 The [Robust Python Cookiecutter] focuses on being as modular as possible for areas that connect to the CI/CD pipeline. Additionally, there will always be either alternative
 CI/CD options or at a minimum basic examples of what the translated CI/CD pipeline would look like.
@@ -94,7 +91,7 @@ implementing best practices in their python packages.
 
 However, Open Source work is draining, and is especially so for a project template including metacode.
 
-I can guarantee that if the [Robust Python Cookiecutter] ever sees any amount of users I will immediately transfer it to an organization to enable at least a handful
+I can guarantee that if the [Robust Python Cookiecutter] ever sees any number of users, I will immediately transfer it to an organization to enable at least a handful
 of trusted individuals to ensure the project is taken care of.
 
 [bitbucket-pipelines]: https://support.atlassian.com/bitbucket-cloud/docs/write-a-pipe-for-bitbucket-pipelines/

tests/conftest.py

@@ -2,8 +2,10 @@
 
 import subprocess
 from pathlib import Path
+from typing import Any
 
 import pytest
+from _pytest.fixtures import FixtureRequest
 from _pytest.tmpdir import TempPathFactory
 from cookiecutter.main import cookiecutter
 
@@ -20,31 +22,53 @@ def demos_folder(tmp_path_factory: TempPathFactory) -> Path:
 
 
 @pytest.fixture(scope="session")
-def robust_python_demo_path(demos_folder: Path) -> Path:
-    """Creates a temporary example python project for testing against and returns its Path."""
+def robust_demo(
+    request: FixtureRequest,
+    demos_folder: Path,
+    robust_demo__path: Path,
+    robust_demo__extra_context: dict[str, Any],
+    robust_demo__is_setup: bool
+) -> Path:
     cookiecutter(
         str(REPO_FOLDER),
         no_input=True,
         overwrite_if_exists=True,
         output_dir=demos_folder,
-        extra_context={"project_name": "robust-python-demo", "add_rust_extension": False},
+        extra_context=robust_demo__extra_context,
     )
-    path: Path = demos_folder / "robust-python-demo"
-    subprocess.run(["nox", "-s", "setup-git"], cwd=path, capture_output=True)
-    subprocess.run(["nox", "-s", "setup-venv"], cwd=path, capture_output=True)
-    return path
+    if robust_demo__is_setup:
+        subprocess.run(["nox", "-s", "setup-git"], cwd=robust_demo__path, capture_output=True)
+        subprocess.run(["nox", "-s", "setup-venv"], cwd=robust_demo__path, capture_output=True)
+    return getattr(request, "param", robust_demo__path)
 
 
 @pytest.fixture(scope="session")
-def robust_maturin_demo_path(demos_folder: Path) -> Path:
-    """Creates a temporary example maturin project for testing against and returns its Path."""
-    cookiecutter(
-        str(REPO_FOLDER),
-        no_input=True,
-        overwrite_if_exists=True,
-        output_dir=demos_folder,
-        extra_context={"project_name": "robust-maturin-demo", "add_rust_extension": True}
-    )
-    path: Path = demos_folder / "robust-maturin-demo"
-    subprocess.run(["nox", "-s", "setup-repo"], cwd=path, capture_output=True)
-    return path
+def robust_demo__path(request: FixtureRequest, demos_folder: Path, robust_demo__name: str) -> Path:
+    return getattr(request, "param", demos_folder / robust_demo__name)
+
+
+@pytest.fixture(scope="session")
+def robust_demo__name(request: FixtureRequest) -> str:
+    return getattr(request, "param", "robust-python-demo-with-setup")
+
+
+@pytest.fixture(scope="session")
+def robust_demo__extra_context(
+    request: FixtureRequest,
+    robust_demo__name: str,
+    robust_demo__add_rust_extension: bool
+) -> dict[str, Any]:
+    return getattr(request, "param", {
+        "project_name": robust_demo__name,
+        "add_rust_extension": robust_demo__add_rust_extension
+    })
+
+
+@pytest.fixture(scope="session")
+def robust_demo__add_rust_extension(request: FixtureRequest) -> bool:
+    return getattr(request, "param", False)
+
+
+@pytest.fixture(scope="session")
+def robust_demo__is_setup(request: FixtureRequest) -> bool:
+    return getattr(request, "param", True)

tests/constants.py

@@ -20,7 +20,7 @@
 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]
+TESTS_NOX_SESSIONS: list[str] = [f"tests-python-{python_version}" for python_version in PYTHON_VERSIONS]
 
 GLOBAL_NOX_SESSIONS: list[str] = [
     "pre-commit",

tests/integration_tests/test_robust_python_demo.py

@@ -8,43 +8,50 @@
 from tests.constants import GLOBAL_NOX_SESSIONS
 
 
-def test_demo_project_generation(robust_python_demo_path: Path) -> None:
-    assert robust_python_demo_path.exists()
+def test_demo_project_generation(robust_python_demo_with_setup: Path) -> None:
+    assert robust_python_demo_with_setup.exists()
 
 
 @pytest.mark.parametrize("session", GLOBAL_NOX_SESSIONS)
-def test_demo_project_nox_session(robust_python_demo_path: Path, session: str) -> None:
+def test_demo_project_nox_session(robust_demo: Path, session: str) -> None:
     command: list[str] = ["nox", "-s", session]
-    result: subprocess.CompletedProcess = subprocess.run(
-        command,
-        cwd=robust_python_demo_path,
-        capture_output=True,
-    )
-    print(result.stdout)
-    print(result.stderr)
-    result.check_returncode()
-
-
-def test_demo_project_nox_pre_commit(robust_python_demo_path: Path) -> None:
+    try:
+        subprocess.run(
+            command,
+            cwd=robust_demo,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            text=True,
+            check=True
+        )
+    except subprocess.CalledProcessError as e:
+        pytest.fail(
+            f"nox session '{session}' failed with exit code {e.returncode}\n"
+            f"{'-'*20} STDOUT {'-'*20}\n{e.stdout}\n"
+            f"{'-'*20} STDERR {'-'*20}\n{e.stderr}"
+        )
+
+
+def test_demo_project_nox_pre_commit(robust_demo: Path) -> None:
     command: list[str] = ["nox", "-s", "pre-commit"]
     result: subprocess.CompletedProcess = subprocess.run(
         command,
-        cwd=robust_python_demo_path,
+        cwd=robust_demo,
         capture_output=True,
         text=True,
         timeout=20.0
     )
     assert result.returncode == 0
 
 
-def test_demo_project_nox_pre_commit_with_install(robust_python_demo_path: Path) -> None:
+def test_demo_project_nox_pre_commit_with_install(robust_demo: Path) -> None:
     command: list[str] = ["nox", "-s", "pre-commit", "--", "install"]
-    pre_commit_hook_path: Path = robust_python_demo_path / ".git" / "hooks" / "pre-commit"
+    pre_commit_hook_path: Path = robust_demo / ".git" / "hooks" / "pre-commit"
     assert not pre_commit_hook_path.exists()
 
     result: subprocess.CompletedProcess = subprocess.run(
         command,
-        cwd=robust_python_demo_path,
+        cwd=robust_demo,
         capture_output=True,
         text=True,
         timeout=20.0

{{cookiecutter.project_name}}/noxfile.py

@@ -157,7 +157,14 @@ def tests_python(session: Session) -> None:
     test_results_dir.mkdir(parents=True, exist_ok=True)
     junitxml_file = test_results_dir / f"test-results-py{session.python}.xml"
 
-    session.run("pytest", "--cov={}".format(PACKAGE_NAME), "--cov-report=xml", f"--junitxml={junitxml_file}", "tests/")
+    session.run(
+        "pytest",
+        "--cov={}".format(PACKAGE_NAME),
+        "--cov-report=term",
+        "--cov-report=xml",
+        f"--junitxml={junitxml_file}",
+        "tests/"
+    )
 
 
 {% if cookiecutter.add_rust_extension == 'y' -%}
@@ -190,10 +197,6 @@ def docs_build(session: Session) -> None:
 @nox.session(python=DEFAULT_PYTHON_VERSION, name="build-python", tags=[BUILD, PYTHON])
 def build_python(session: Session) -> None:
     """Build sdist and wheel packages (uv build)."""
-    session.log("Installing build dependencies...")
-    # Sync core & dev deps are needed for accessing project source code.
-    session.install("-e", ".", "--group", "dev")
-
     session.log(f"Building sdist and wheel packages with py{session.python}.")
     {% if cookiecutter.add_rust_extension == "y" -%}
     session.run("maturin", "develop", "--uv")
@@ -252,7 +255,7 @@ 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.install("-e", ".", "--group", "dev")
+    session.install("twine")
 
     session.log("Checking built packages with Twine.")
     session.run("twine", "check", "dist/*")
@@ -280,8 +283,6 @@ def release(session: Session) -> None:
     Optionally accepts increment (major, minor, patch) after '--'.
     """
     session.log("Running release process using Commitizen...")
-    session.install("-e", ".", "--group", "dev")
-
     try:
         session.run("git", "version", success_codes=[0], external=True, silent=True)
     except CommandFailed:

{{cookiecutter.project_name}}/pyproject.toml

@@ -49,13 +49,13 @@ Repository = "https://github.com/{{ cookiecutter.github_user | lower | replace('
 
 {% if cookiecutter.add_rust_extension == 'y' -%}
 [build-system]
-requires = "maturin>=1.3.0,<2.0"
+requires = ["maturin>=1.3.0,<2.0"]
 build-backend = "maturin"
 
 [tool.maturin]
 rust-src = "rust"
 {% else -%}
 [build-system]
-requires = "setuptools>=61.0"
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 {% endif -%}

{{cookiecutter.project_name}}/scripts/setup-venv.py

@@ -1,6 +1,6 @@
 """Script responsible for first time setup of the project's venv.
 
-Since this a first time setup script, we intentionally only use builtin Python dependencies.
+Since this is a first time setup script, we intentionally only use builtin Python dependencies.
 """
 
 import argparse

{{cookiecutter.project_name}}/scripts/util.py

@@ -13,14 +13,12 @@ class MissingDependencyError(Exception):
 
     def __init__(self, project: Path, dependency: str):
         """Initializes MisssingDependencyError."""
-        super().__init__(
-            "\n".join(
-                [
-                    f"Unable to find {dependency=}.",
-                    f"Please ensure that {dependency} is installed before setting up the repo at {project.absolute()}",
-                ]
-            )
-        )
+        message_lines: list[str] = [
+            f"Unable to find {dependency=}.",
+            f"Please ensure that {dependency} is installed before setting up the repo at {project.absolute()}",
+        ]
+        message: str = "\n".join(message_lines)
+        super().__init__(message)
 
 
 def check_dependencies(path: Path, dependencies: list[str]) -> None:

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

@@ -12,4 +12,4 @@ def main() -> None:
 
 
 if __name__ == "__main__":
-    app()
+    app()  # pragma: no cover