Contributing to proxpi

Thanks for wanting to help proxpi out!

Please review the code of conduct before participating.

Development set-up

Requires Python and a Python package installer (eg pip).

After cloning (and optionally setting up a virtual environment), install the package and the testing dependencies:

python -m pip install . -r tests/requirements.txt

Replace . with -e . to install the project as editable (ie not requiring a reinstall every time you make a change).

Tests are running using pytest (installed above):

python -m pytest

Code is linted with Black. It needs to be installed first:

python -m pip install black

Then run and commit before submitting a pull-request:

python -m black src