Skip to content

Build and Test

This project uses a Python build backend that configures and builds the C++ core with CMake.

Local setup

python -m pip install --upgrade pip
python -m pip install -e .[dev]

If your environment does not provide extras, install the minimal tools directly:

python -m pip install -e .
python -m pip install pytest mkdocs mkdocs-material

Build and install

Install the package (this triggers a full native build):

python -m pip install -v .

For editable development:

python -m pip install -e .

Run tests

Run the full Python test suite:

python -m pytest

Run a single test module while iterating:

python -m pytest tests/encoding/test_color_encoder.py -q

Build docs

Strict docs build (fails on warnings):

mkdocs build --strict