Installation

Note, to run the script in this repository, you need to have a version of Python >= 3.10

Using Poetry (recommended)

Check out the Poetry documentation for more information.

Then run:

poetry install

If you want to remove development dependencies (such as pytest, black, mkdocs, ...) to reduce size in production, you can run:

poetry install --without dev

To run the poetry venv:

poetry shell

To add a package in poetry:

poetry add <package_name>

You can also add a package as a specified group dependency:

poetry add --group <group_name> <package_name>

To list all dependencies:

poetry show

To list all available commands:

poetry list

Poetry handles your dependencies and merge conflicts for you. It also creates a virtual environment for you.

Using pip

pip install -r requirements.txt

Accessing the Docs

You can access the docs by using the following command:

mkdocs serve

Docs will be served at localhost:8000 and automatically updated when you make changes to the docs or in the tracked source files.