If you like nice diagrams you can also check repository code map.
Feel free to open pull requests but please keep in mind this checklist:
- write tests
- write changes to to
CHANGELOG.md - update
README.md(if needed) - update documentation (if needed)
We use poetry for dependency management. Please write your source code according to the
PEP8 code-style. flake8 is used for
code-style and code-quality checks. Please, be sure that your IDE is following settings according to .editorconfig
file. Use poetry install --all-extras to install all dependencies for development.
We useDjango-style tests.
# Run tests
poetry run python runtests.py
# Run flake8
poetry run flake8 .Documentation is placed in docs directory and it's generated using
mkdocs-material. You can build docs calling poetry run mkdocs build.
Docs will be in sites directory after build. Documentation is updated after every push to origin/master branch
using GitHub Actions.