Test and Development¶

For testing and development, additional installations are required. Testing needs this:

python -m pip install -r requirements-test.txt

Development needs even more:

python -m pip install -r requirements-dev.txt

Development includes producing documentation, which relies on PlantUML.

Testing¶

Testing uses tox. Here’s the command

tox

That’s it. It will build it’s own virtual environment based on requirements.txt and then execute the test commands.

Documentation is built by Sphinx. Here are the commands:

cd docs
make html

It’s often helpful to run this without making a change to the command-line environment.

(cd docs; make html)