Development¶

Setup¶

poetry install --with dev

Tests¶

poetry run pytest

The test suite keeps one test function per test file. Parametrized tests may cover multiple cases in one file.

Formatting¶

poetry run isort logging_bullet_train tests
poetry run black logging_bullet_train tests

Or use the Makefile:

make format-all

Documentation¶

Serve the docs locally:

poetry run mkdocs serve

Build the static site:

poetry run mkdocs build --strict

The GitHub Actions workflow builds and deploys the site to GitHub Pages when main is pushed.

Release Checklist¶

1. Update logging_bullet_train/version.py.
2. Update pyproject.toml.
3. Run tests and docs build.
4. Publish the package.
5. Create the release tag.