eNMS uses :
- Black for python code formatting
- Flake8 to make sure that the python code is PEP8-compliant
- Mypy for python static type hinting
- Pytest for the test suite.
There is a dedicated
requirements_dev.txt file to install these python libraries:
pip install -r requirements_dev.txt
Before opening a pull request with your changes, you should make sure that:
If one of these checks fails, so will Travis CI after opening the pull request.
The CI/CD and PR processes are the same, because when you open a PR, this automatically triggers Travis.
If you are updating the documentation, you can build a local version of the docs:
# build a local version of the docs cd /docs make html