Skip to content

Development

Install development tools

uv sync --frozen

Run tests

uv run pytest

Run linting

uv run ruff check .

CLI help tests

The test suite checks that every public CLI command supports --help and documents the expected run-directory behavior.

When adding a new entrypoint in pyproject.toml, add it to the CLI help tests and to CLI reference.

Documentation

Documentation source files live in docs/ and are configured by mkdocs.yml.

Serve locally:

uvx --with mkdocs-material mkdocs serve

Build locally:

uvx --with mkdocs-material mkdocs build --strict