The software was developed in Python 3 (v3.5 and above).
To install the required package for the development:
pip install -r requirements-dev.txt
That will install the following package:
Needed to use the software:
Needed to build the documentation:
Advised for development:
pylint does offer more advise to improve the code and give a note at the code which reflected some good coding practice. It is advised to be as close to 10 as possible.
For the unit test the following packages are needed:
To run all the tests present in the tests directory:
pytest
When modifiying the code it is important to verify that all the tests are still working. It is also strongly advised to expand them when adding or modifying the codes.
It is also encouraged to use:
It is also advised to use tox to automate testing using a virtual environment.
To use it:
tox