Setup a Development Environment¶
Pipenv¶
Use Pipenv to manage the development packages.
pipenv install --dev # for initial installation
pipenv shell # to work in the virtual environment
Code Formatter¶
We use pre-commit for automatic code formatting before committing.
It is automatically installed with the development packages.
The command to enable the hooks is:
pre-commit install
EditorConfig¶
Please make sure to have an editor (or a plugin) that supports EditorConfig. It will avoid many unnecessary formatting problems.
PyTest¶
We are using pytest to run our Python unittests. It is a bit further simplified by the command:
make test
Container¶
Currently we are using Docker containers with docker-compose.
We are open to move to another container provider (podman), but for now it is rather new and the podman-compose functionality is not able to replace docker-compose, yet.