Development

To develop dcodex, you should clone the latest version from github:

git clone https://github.com/rbturnbull/dcodex.git
cd dcodex

Then install the dependencies with poetry:

poetry install
poetry shell

You should then be able to run the tests:

./runtests.py

To check the testing coverage:

coverage run ./runtests.py
coverage report

To generate the documentation:

sphinx-autobuild docs docs/_build/html --open-browser

If this clashes with a port that you’re already running, then you can set a port manually with --port.