Development

Running Tests

To run the unit tests, install the following packages:

pip install pytest
pip install pytest-runner
pip install pytest-benchmark
pip install coverage

Running documentation

To build the documentation, install the following packages:

pip install sphinx
pip install recommonmark
pip install sphinx_rtd_theme
pip install sphinx-autodoc-typehints

To launch the documentation:

cd doc
make html

Spyder IDE

Spyder can be used as an IDE for Tracklib development.

pip install spyder
pip install spyder-kernels
spyder &

To use spyder, you have to create a new project with an existing directory.

Figure 1 - Tracklib project in Spyder

Make sure the Tracklib directory is included in Spyder’s Python path.