Thanks for getting involved! PRs and github issues are more than welcome.
You will need to install tox
to run tests and auto-formatting:
pip install tox
MyGrad uses:
- flake8 to enforce the pep8 style
- isort to organize import statements
- black
Once you have made your changes/additions to MyGrad's code, you can run all of these auto-formatting tools via tox
:
tox -e format
This will (temporarily) install and run all of these formatting tools on MyGrad's code base for you.
MyGrad adheres to the NumPy docstring style,
and strives to adhere to formally-correct type hints in the Parameters
section.
PRs will automatically execute a full test suite on Travis.
To test locally
tox -e py
will run the tests in a hermetic environment (without even having to install mygrad
, and
pytest tests
will run in your local python environment.