QGIS Plugins mit Python

QGIS Plugin metadata

Importance of metadata

The metadata.txt file is essential for defining the properties of a QGIS plugin. It provides key information such as the plugin name, author details, description, and category. Properly structured metadata ensures that plugins are correctly categorized, easily discoverable, and well-documented.

Keep metadata.txt updated – Especially when releasing new versions.

Structure of metadata.txt

A metadata.txt file consists of mandatory and optional attributes. Below is a breakdown of the most important attributes.

General Information

• name: The official name of the plugin.
• author: Name(s) of the developer(s).
• email: Contact email for support or inquiries.
• qgisMinimumVersion: Minimum version of QGIS required to run the plugin (e.g., 3.0).
• description=Short and clear description of the plugin functionality.
• about=Detailed explanation of the plugin, including its purpose, features, and how it works.
• tags= Example: vector, geocoding, point, address
• hasProcessingProvider: yes if the plugin provides QGIS processing tools.

Versioning and Status

version=1.0
experimental=False
Changelog: 1.0 - Initial release.

Category

Ensure category is valid – Choose one from the predefined list:

• Raster
• Vector
• Database
• Mesh
• Web

Links

Include a homepage or repository link – Essential for documentation and support.

tracker=https://github.com/johndoe/spatial-analysis-plugin/issues
repository=https://github.com/johndoe/spatial-analysis-plugin
homepage=https://github.com/johndoe/spatial-analysis-plugin

Additional Settings

• icon: Path to the plugin icon.
• server: Set to True if the plugin runs on a server.

Example of a Well-Formatted metadata.txt File

[general]
name=Advanced Spatial Analysis
author=John Doe
email=johndoe@example.com
qgisMinimumVersion=3.0
description=Perform advanced spatial analysis on vector layers.
about=This plugin allows users to conduct advanced spatial analysis operations such as buffering, clipping, and overlay analysis. It integrates seamlessly with the QGIS processing framework.
category=Vector
tags=vector, spatial analysis, geoprocessing
version=1.2
experimental=False
Changelog: 1.2 - Added new analysis tools.
tracker=https://github.com/johndoe/spatial-analysis-plugin/issues
repository=https://github.com/johndoe/spatial-analysis-plugin
homepage=https://github.com/johndoe/spatial-analysis-plugin
hasProcessingProvider=yes
icon=icon.png
server=False

There is more information about how a metadata.txt file should look like in the pyqgis developer cookbook.

Weblinks

• Homepage: http://www.qgis.org/ (Project-Team QGIS)
• Wiki: http://wiki.qgis.org/
• Blog: http://blog.qgis.org
• Bug tracker: https://trac.osgeo.org/qgis/