Contributing¶
Few things to know before diving in the code.
Project Guidelines¶
Be pythonic
Document your code
Test your code
That is all.
Dev Environment¶
To tinker with the code, it's recommended that you install the library from the cloned folder with:
pip install --editable .
This will allow you to import Flask-cache-manifest in other projects directly while being able to edit the extension directly from the git folder. This way, you can make sure Flask-cache-manifest will work as intended in the context of your own project.
Documenting¶
The documentation is done with Sphinx. To build the Sphinx documentation, you need:
pip install -r docs/requirements.txt # one-time setup
sphinx-autobuild docs/source docs/build
The documentation pages will be served on http://127.0.0.1:8000 by default.
Testing¶
Tests can be ran from the root folder using:
pip install -r requirements.txt # one-time setup
pytest
If you have a more elaborate setup with tox and pyenv, you'll have access to a few more automations by running tox.
tox # to run the full test suite
tox -e py37 # to test a specific environment
tox -e docs # to build the documentation
