crispy-form-foundation is developed with:
- Unittests using Pytest;
- Respecting flake and pip8 rules using Flake8;
- Sphinx for documentation with enabled Napoleon extension (using only the Google style);
- tox to test again different Python and Django versions;
Every requirement is available in file
requirements/dev.txt (except for tox).
Install for development¶
First ensure you have pip and
python-venv package installed, clone crispy-form-foundation repository, enter its directory and just type:
Unittests are made to works on Pytest, a shortcut in Makefile is available to start them on your current development install:
To ease development again multiple Python and Django versions, a tox configuration has been added. You are strongly encouraged to use it to test your pull requests.
Before using it you will need to install tox, it is recommended to install it at your system level so dependancy is not in tests requirements file:
sudo pip install tox
Then go in the crispy-form-foundation repository directory where live the
tox.ini files and execute tox: