Pull requests are welcome, but please read this guidelines first.
This project uses poetry. Have it installed and setup first.
Attention: Even though this library is designed to be runnable on python>=3.8.0 some development-tools require python>=3.8.1
To install dev-dependencies and tools:
poetry installThis project uses PEP8 Style Guide for Python Code.
This project loves sorted imports.
Get it all applied via:
poetry run isort .
poetry run autopep8 -ir serializable/ tests/This project prefers f'strings' over 'string'.format().
This project prefers 'single quotes' over "double quotes".
This project uses Sphinx to generate documentation which is automatically published to RTFD.
Source for documentation is stored in the docs folder in RST format.
You can generate the documentation locally by running:
cd docs
pip install -r requirements.txt
make htmlpoetry run toxPlease sign your commits, to show that you agree to publish your changes under the current terms and licenses of the project.
git commit --signed-off ...