IVRE uses code linters to prevent some easy-to-spot (for a computer) mistakes and to enforce a consistent code style (or at least, attempt to do so).
For all the code and the documentation, we also use Codespell to prevent typos.
Running the linters¶
To install the Python code linters and Codespell you can simply use
requirements-linting.txt file with Pip, or use any method to
install the latest versions of the
pylint Python modules.
pkg/runchecks will run all the tests for you with the
expected options and exceptions.
Code linting and spell checking is performed in a dedicated GitHub action (see GitHub actions), togethter with the Maxmind tests. Pylint and Codespell only run with Python 3.11, while Flake8 runs with all Python versions.