CONTRIBUTING.md

Local Development

Install

Project code

cd && git clone # path-to-this-repository.git

uv

curl -LsSf https://astral.sh/uv/install.sh | sh

https://docs.astral.sh/uv/getting-started/installation/

Pre-commit

pre-commit install
pre-commit autoupdate
pre-commit run --all-files

Develop

Tox

See tox for all test environments.

To run all:

uvx tox

To run a specific environment:

uvx tox -e py311

To generate documentation:

uvx tox -e docs

The HTML pages are in docs/build/html.