Development

Notes on development.

Python

Thusly, suit to taste:

git clone https://spacecruft.org/deepcrayon/multivoice
cd multivoice/
python -m venv venv
source venv/bin/activate
pip install -U setuptools pip wheel
pip install -e .
pip install -e .[dev]

Formatting

Format with black.

black src/multivoice/*.py src/multivoice/lib/*.py

Linting

Check code with ruff.

ruff check src/multivoice/

Build Wheel

Before building the wheel, build after creating a git tag, unless you want a “dev” build. Then install it locally, for the latest version.

pip install -e .
python -m build

Documentation

This documentation uses Sphinx.

pip install -e .[docs]
make html
rsync -ultav docs/_build/html/ multivoice:/var/www/html/multivoice-org/