This project is being actively developed on GitLab, with a mirror set up on GitHub.
If you are exploring the project in GitHub and wish to open an issue, please do it directly via the project's Issues page on GitLab.
We use poetry
to manage the dependencies.
If you dont have poetry
, you should install with make poetry-download
.
To install dependencies and prepare pre-commit
hooks you would need to run
install
command:
make install
make pre-commit-install
To activate your virtualenv
run poetry shell
.
After installation you may execute code formatting.
make codestyle
Many checks are configured for this project. Command make check-codestyle
will check
pyupgrade, black and isort.
The make check-safety
command will look at the security of your code.
Comand make lint
applies all checks.
Before submitting your code please do the following steps:
- Add any changes you want
- Add tests for the new changes
- Edit documentation if you have changed something significant
- Run
make codestyle
to format your changes. - Run
make lint
to ensure that types, security and docstrings are okay.
You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.