Skip to main content

Developer Guide

Initial setup​

To get started, you'll need to set up your development environment:

  1. Install Poetry:
curl -sSL https://install.python-poetry.org | python3 -
  1. Set up the development environment (run from the project root):
poetry install --all-extras  # Remove --all-extras to ignore plugin dependencies.
  1. Start the poetry shell:
poetry shell

Now you can run doteki within the shell:

doteki --help

The doteki command will be available within the poetry shell and is linked to the project's source code. Any changes to the code will be reflected in the command.

Useful commands​

Running tests​

poetry run pytest

Checking code coverage​

poetry run pytest --cov=doteki

Checking types​

poetry run mypy doteki

Formatting code​

dōteki uses Black to format the code. To format a file or directory:

poetry run black {source file or directory}

Further reading​

Questions?​

If you have any questions, don't hesitate to reach out via the issue tracker or email.