Install Poetry by following the official installation instructions. Optionally (but recommended), configure Poetry to create a virtual environment in a folder named .venv within the root directory of the project:
poetry config virtualenvs.in-project trueTo create a development environment and install the runtime and development dependencies, run:
poetry installThen enter the virtual environment created by Poetry:
poetry shellThe project uses static checks using fantastic pre-commit. Every change is checked on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then run following command to install pre-commit.
To turn on pre-commit checks for commit operations in git, enter:
pre-commit installTo run all checks on your staged files, enter:
pre-commit runTo run all checks on all files, enter:
pre-commit run --all-filesPre-commit check results are also attached to your PR through integration with Github Action.