Contributing

When writing code, you MUST ALWAYS follow the naming-things guidelines.

To run the tests, use the following command:

uv run pytest

Avoid mocking in your tests and instead use real dependencies to ensure that your tests are as close to real-world scenarios as possible. You may only mock transports to avoid network IO or to mimic network counterparts.

Testing with Extra Dependencies

uv run --extra=cli --extra=pygments --extra=audio pytest

Before your first commit, ensure that the pre-commit hooks are installed by running:

uvx prek install

Writing documentation

The documentation is built using MkDocs with mkdocstrings for automatic API documentation generation.

To serve the documentation locally for development, run:

uv run --group docs mkdocs serve --livereload