QGIS Plugins

Python support was introduced in QGIS 0.9 (2007). Today, there are several ways how to use Python in QGIS Desktop. They are covered in the following sections:

• Enter commands in the QGIS Python interactive console

• Create and use QGIS plugins

• Automatically run Python code when QGIS starts

• Create custom applications based on the QGIS API

(source: PyQGIS Developer Cookbook)

Important

All examples are QGIS 3.28 LTR compatible. Python 3 and Qt 5 required. Functionality in other QGIS versions is not guaranteed.

Contents

• QGIS and Python
  • Launching code on startup of QGIS
  • Interactive console
  • Creating custom applications built on QGIS libraries
  • Calling processing tools from Python
  • PyQGIS introduction
• Setup QGIS
• Start QGIS Plugin
• Build the plugin
  • Configuration file pb_tool.cfg
  • Using plugin in place
  • Activate plugin in QGIS
  • Notes
• Qt Designer
• Save views plugin
  • User Inputs
  • Development workflow
• Publish the plugin
  • Create zip package
  • Official QGIS plugin repository
  • Local QGIS plugin repository
• Installation and environment
  • Text Editor
  • Qt Designer

Important links

• https://qgis.org

• API

• https://qgis.org/pyqgis/3.28/ (Python)

• https://qgis.org/api/3.28/ (C++)

Important

Cookbook (very useful!!!)

About

Licensed under Creative Commons Attribution-ShareAlike 4.0 International License.

Version: 1.0 (built Jan 15, 2025)

Authors

On behalf of GISMentors group:

• Jáchym Čepický

• Martin Landa

• Ľudmila Furtkevičová

Source code

Source code is available at:

• https://github.com/GISMentors/qgis-plugins

Feel free to report issues at:

• https://github.com/GISMentors/qgis-plugins/issues