Developing Python Plugins

• Structuring Python Plugins
  • Writing a plugin
  • Plugin content
  • Documentation
  • Translation
  • Tips and Tricks
• Code Snippets
  • How to call a method by a key shortcut
  • How to toggle Layers
  • How to access attribute table of selected features
• Using Plugin Layers
  • Subclassing QgsPluginLayer
• IDE settings for writing and debugging plugins
  • A note on configuring your IDE on Windows
  • Debugging using Eclipse and PyDev
  • Debugging using PDB
• Releasing your plugin
  • Metadata and names
  • Code and help
  • Official Python plugin repository

It is possible to create plugins in the Python programming language. In comparison with classical plugins written in C++ these should be easier to write, understand, maintain and distribute due to the dynamic nature of the Python language.

Python plugins are listed together with C++ plugins in QGIS plugin manager. They are searched for in ~/(UserProfile)/python/plugins and these paths:

• UNIX/Mac: (qgis_prefix)/share/qgis/python/plugins

• Windows: (qgis_prefix)/python/plugins

For definitions of ~ and (UserProfile) see Core and External plugins.

注解

By setting QGIS_PLUGINPATH to an existing directory path, you can add this path to the list of paths that are searched for plugins.