Development

Base setup

  • Use a virtualenv (e.g. with virtualenvwrapper mkvirtualenv -a . atr-data-gen)

  • Install atr-data-generator as a package (e.g. with pip pip install -e .)

Unit tests

Tests are executed with tox, based on pytest.

  • Run a single test module: tox -- <test_path>

  • Run a single test: tox -- <test_path>::<test_function>

Documentation

The documentation is generated via Antora. Please keep it updated when modifying or adding features.

It’s pretty easy to do:

npm install
make antora
cd public
python -m http.server

You can then write in Asciidoc in the relevant docs/*.adoc files, and see live output on http://localhost:8000.