Skip to content
QGIS SDK

Quick start

Install Pixi and Bun, then install the locked environments and JavaScript dependencies:

Terminal window
curl -fsSL https://pixi.sh/install.sh | bash
pixi install -e default
pixi install -e build
pixi install -e bun
pixi run -e bun install-js

Check the package wiring from the workspace — __all__ is the entire public surface:

Terminal window
pixi run -e default python -c 'import qgis_sdk; print(qgis_sdk.__all__)'

That prints the declarations API and nothing else; everything beyond it lives in an explicit submodule. To start a plugin project, install the package (pip install qgis-sdk or pixi add --pypi qgis-sdk) and run qgis-sdk new <directory>, which is the same entry point as python -m qgis_sdk; qgis_sdk.scaffold is the public API behind it. doc-12 covers Desktop versus standalone Qt mode, and the scaffold evidence below is the headless QGIS Desktop load/unload proof.