Development environment setup#

Clone the repository, then follow these steps.

It’s strongly recomended to develop into a virtual environment:

python3 -m venv --system-site-packages .venv

Note

We link to system packages to keep the link with installed QGIS Python libraries: PyQGIS, PyQT, etc.

In your virtual environment:

# use the latest pip version
python -m pip install -U pip
# install basic packages
python -m pip install -U -r requirements/base.txt
# install development tools
python -m pip install -U -r requirements/development.txt
# install external dependencies
python -m pip install --no-deps -U -r requirements/embedded.txt -t qgis_resource_sharing/ext_libs
# install pre-commit to respect common development guidelines
pre-commit install