Generic Copier Template

This repository provides a Copier template for a Python package. It offers two flavours:

1. Python Only – a pure Python implementation.
2. Python with Rust – includes a PyO3 extension.

Run copier copy and answer the prompts to generate a project.

Running Tests

The test suite relies on the pytest-copier plugin and renders generated projects that run Ruff, Pylint via a PyPy-backed runner, ty, pytest, and, when the Rust extension is enabled, Clippy, Whitaker, and nextest-aware Rust tests. Generated Python linting also runs Interrogate as a 100% docstring-coverage gate.

Run the parent template tests through the repository Makefile. Run make help to list the available parent Makefile targets. Parent gates include make check-fmt, make lint, make typecheck, and make test. The test target uses uvx to provide pytest-copier, pyyaml, syrupy, and make-parser without a manually managed virtual environment:

make test

Run make test WITH_ACT=1 to include the act-backed workflow integration tests when act and Docker are available. Parent repository CI runs this mode in a separate act-validation workflow so rendered in-template GitHub workflows do not hold up the normal template test workflow.

Generated projects install and run their own tooling, including Ruff, Interrogate, Pylint via PyPy, ty, pytest, and, when Rust is enabled, Clippy, Whitaker, and nextest.

You can also run scripts/setup_test_deps.sh to install parent test dependencies into the current Python environment manually.

Generated Quality Gate Flow

Figure: The generated make all quality gate runs build, formatting, linting, typechecking, and testing. Rust-specific lint and test branches run only when the Rust extension is enabled. The audit target checks Python dependencies via pip-audit and, when Rust is enabled, Rust dependencies via cargo audit.

flowchart LR
    Dev[Developer runs make all] --> All[all]
    All --> Build["build (uv sync dev deps)"]
    All --> CheckFmt[check-fmt]
    All --> Lint[lint]
    All --> Typecheck[typecheck]
    All --> Audit[audit]
    All --> Test[test]

    Lint --> RuffCheck[ruff check]
    Lint --> Interrogate[interrogate --fail-under 100]
    Lint --> PylintPyPy[pylint-pypy via PyPy]
    Typecheck --> TyCheck[ty check]
    Audit --> PipAudit[pip-audit]
    Test --> Pytest[pytest -v -n auto]

    subgraph Rust_extension_enabled[use_rust == true]
        Lint --> RustDoc[cargo doc]
        Lint --> Clippy[cargo clippy]
        Lint --> Whitaker[whitaker --all]
        Audit --> CargoAudit[cargo audit]
        Test --> Nextest[cargo nextest run]
        Test --> RustDocTests[cargo test --doc]
    end

Loading