Skip to content


Getting Started

Make sure you have Poetry installed. After cloning the repo, create the environment with

poetry install

The Makefile contains commands for common tasks.

Running Tests

make test


make lint


This will activate a virtual environment with logdir's dependencies.

poetry shell


With the dev requirements installed, serve the docs locally with:

make servedocs

To build the docs to the site folder, run:

make docs


To deploy, make sure the dev requirements are installed. Then run:

make release

Alternatively, mark a new version with bump2version (do this in a shell) and push the commit and tag with:

git push
git push --tags

GitHub Actions will then build and deploy the appropriate versions.