64 lines
2.0 KiB
Markdown
64 lines
2.0 KiB
Markdown
# Development
|
|
|
|
## Environment setup
|
|
|
|
> Typically on Ubuntu (but should also work on Windows with potential small adjustments).
|
|
|
|
### 1. Install virtual environment
|
|
|
|
Using [qgis-venv-creator](https://github.com/GispoCoding/qgis-venv-creator) (see [this article](https://blog.geotribu.net/2024/11/25/creating-a-python-virtual-environment-for-pyqgis-development-with-vs-code-on-windows/#with-the-qgis-venv-creator-utility)) through [pipx](https://pipx.pypa.io) (`sudo apt install pipx`):
|
|
|
|
```sh
|
|
pipx run qgis-venv-creator --venv-name ".venv"
|
|
```
|
|
|
|
Then enter into the virtual environment:
|
|
|
|
```sh
|
|
. .venv/bin/activate
|
|
# or
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
Old school way:
|
|
|
|
```bash
|
|
# create virtual environment linking to system packages (for pyqgis)
|
|
python3 -m venv .venv --system-site-packages
|
|
source .venv/bin/activate
|
|
```
|
|
|
|
### 2. Install development dependencies
|
|
|
|
```sh
|
|
# bump dependencies inside venv
|
|
python -m pip install -U pip
|
|
python -m pip install -U -r requirements/development.txt
|
|
|
|
# install git hooks (pre-commit)
|
|
pre-commit install
|
|
```
|
|
|
|
### 3. Dedicated QGIS profile
|
|
|
|
It's recommended to create a dedicated QGIS profile for the development of the plugin to avoid conflicts with other plugins.
|
|
|
|
1. From the command-line (a terminal with qgis executable in `PATH` or OSGeo4W Shell):
|
|
|
|
```sh
|
|
# Linux
|
|
qgis --profile plg_gn_tools
|
|
# Windows - OSGeo4W Shell
|
|
qgis-ltr --profile plg_gn_tools
|
|
# Windows - PowerShell opened in the QGIS installation directory
|
|
PS C:\Program Files\QGIS 3.40.4\LTR\bin> .\qgis-ltr-bin.exe --profile plg_gn_tools
|
|
```
|
|
|
|
1. Then, set the `QGIS_PLUGINPATH` environment variable to the path of the plugin in profile preferences:
|
|
|
|
|
|
|
|
1. Finally, enable the plugin in the plugin manager (ignore invalid folders like documentation, tests, etc.):
|
|
|
|
|