Contributions to this repository must pass tests and linting.

CI is the canonical source of truth.

Install Python dependencies in a virtual environment.

$ pip install --editable '.[dev]'

Spell checking requires enchant. This can be installed on macOS, for example, with Homebrew:

$ brew install enchant

and on Ubuntu with apt:

$ apt-get install -y enchant

Install prek hooks:

$ prek install

Run lint tools either by committing, or with:

$ prek run --all-files --hook-stage pre-commit --verbose
$ prek run --all-files --hook-stage pre-push --verbose
$ prek run --all-files --hook-stage manual --verbose

Run pytest:

$ pytest

Documentation is built on Read the Docs.

Run the following commands to build and view documentation locally:

$ uv run --extra=dev sphinx-build -M html docs/source docs/build -W
$ python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'

Tests are run on GitHub Actions. The configuration for this is in :file:`.github/workflows/`.

See :doc:`release-process`.