Develop on Windows¶

Tested on:

Windows 10 Professional - build 19041 (= version 2004)

Requirements¶

Python 3.10+ installed with the Windows MSI installer (version from the Windows store is not working with virtual environments)
Git and/or GitHub Desktop

Enable remote scripts (for virtual environment)¶

Open a Powershell prompt as administrator inside the repository folder:

# if not already done, enable scripts - required by virtualenv
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Installation steps¶

Clone the repository¶

Clone the repository where you want using GitHub Desktop as graphical interface or a PowerShell terminal:

git clone https://github.com/Guts/qgis-deployment-cli.git
# or using ssh
git clone git@github.com:Guts/qgis-deployment-cli.git

Set up the virtual environment¶

# create a virtual env
py -3.10 -m venv .venv

# enable virtual env
.\.venv\Scripts\activate

# upgrade basic tooling
python -m pip install -U pip setuptools wheel

# install dependencies
python -m pip install -U -r requirements/development.txt

Install git hooks¶

pre-commit install

Install project¶

python -m pip install -e .

Try it with:

qgis-deployment-toolbelt --help

Happy coding!