CONTRIBUTING.md

Local Development

Install

Project code

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

Python

Verify if Python is installed.

python --version

To install multiple Python versions, use pyenv.

To activate:

pyenv local 3.10 3.11 3.12

Virtual environment

cd # path-to-downloaded-repository
python -m venv .env
source .env/bin/activate

pip and setuptools

python -m pip install --upgrade pip setuptools

Dependencies

pip install -e .[dev]

Pre-commit

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

Develop

Tox

See tox for all test environments.

To run all:

tox

To run a specific environment:

tox -e py311

To generate documentation:

tox -e docs

The HTML pages are in docs/build/html.