qgis-sdk Python package guide
The reference for the qgis-sdk Python package: the declarations, the pure
contract layer, the scoped runtime, the Desktop host, forms and native
surfaces, Processing, the bridge host side, networking, scoped jobs, the
project scaffold and the qgis-sdk command, with the migration notes of every
release at the end. The documentation site at
archont561.github.io/qgis-sdk
renders it one page per section. Status at the time of writing: Python 0.7.0
(python-v0.7.0: qgis-sdk, qgis-sdk-runtime and qgis-sdk-tools on PyPI
and prefix.dev) released as a triple with the bridge @archont561/qgis-sdk
0.5.0 (ts-v0.5.0) and the web components @archont561/qgis-sdk-ui
0.1.0 (ui-v0.1.0), all tagged on one merge commit; the previous pair was
0.6.0 + 0.4.0.
Companion guides: doc-13 (TypeScript bridge) and doc-14 (workspace tooling, harnesses and qualification evidence).
Sections
Section titled “Sections”- Installation
- Supported targets
- Declarations
- Pure contract layer
- Scoped plugin runtime
- Desktop host:
host()and the project manifest - Forms: an action’s inputs as a window
- Desktop bindings and native surfaces
- Processing algorithms and safe outputs
- Providers: algorithms in the QGIS Processing toolbox
- WebEngine bridge, host side
- Networking
- Scoped jobs
- Project scaffold
- Project checks
- Running tests:
qgis-sdk test - Developing against QGIS:
qgis-sdk dev - From the QGIS Python console
- Running an app:
qgis-sdk run - Building an installable ZIP:
qgis-sdk build - Optional controlled-deployment adapter
- 0.1.0 experimental release and migration policy
- 0.2.0 migration notes
- 0.3.0 migration notes
- 0.9.0 migration notes
- 0.8.0 migration notes
- 0.7.0 migration notes
- 0.6.0 migration notes
- 0.5.0 migration notes
- 0.4.0 migration notes