Testing#
Flake8#
Themerr-kodi uses Flake8 for enforcing consistent code styling. Flake8 is
included in the requirements-dev.txt
.
The config file for flake8 is .flake8
. This is already included in the root of the repo and should not be modified.
- Test with Flake8
python -m flake8
Sphinx#
Themerr-kodi uses Sphinx for documentation building. Sphinx is included
in the requirements-dev.txt
.
Themerr-kodi follows numpydoc styling and formatting in
docstrings. This will be tested when building the docs. numpydoc is included in the requirements-dev.txt
.
The config file for Sphinx is docs/source/conf.py
. This is already included in the root of the repo and should not
be modified.
- Test with Sphinx
cd docs make html
Alternatively
cd docs sphinx-build -b html source build
- Lint with rstcheck
rstcheck -r .
pytest#
Themerr-kodi uses pytest for unit testing. pytest is included in the
requirements-dev.txt
.
No config is required for pytest.
- Test with pytest
python -m pytest -rxXs --tb=native --verbose --cov=src tests