QGIS Plugin tools

Warning: The API is not stable yet. Function and files may move between commits.

As it's a submodule, you can configure your GIT to auto update the submodule commit by running:

git config --global submodule.recurse true

The module is helping you with:

• setting up some logging (QgsMessageLog, file log, remote logs...)
• fetching resources in resources or other folders
• fetching compiled UI file in resources/ui folder (will be deprecated in the future)
• fetching compiled translation file in resources/i18n folder (will be deprecated in the future)
• removing QRC resources file easily
• translate using the i18n.tr() function.
• managing the release process : zip, upload on plugins.qgis.org, tag, GitHub release (will be deprecated in the future)
• providing some common widgets/code for plugins
• setting up a debug server (will be deprecated in the future)

How to install it

As external dependency

It is recommended to use this module as an external dependency with the help of qgis-plugin-dev-tools.

The tool can be installed via pip:

pip install qgis_plugin_tools

Remember to add this as a runtime requirement in your pyproject.toml:

[tool.qgis_plugin_dev_tools]
plugin_package_name = "your_plugin_package_name"
runtime_requires = [
    "qgis_plugin_dev_tools"
]

As a submodule

[!WARNING] Using qgis_plugin_tools as a submodule is not recommended and will be deprecated in the future.

For a new plugin

This will create needed structure for your plugin

1. Create new plugin using cookiecutter-qgis-plugin. This will automatically initialize git and add qgis_plugin_tools as a submodule for the plugin.
2. Next set up the development environment, edit metadata.txt with description etc. and commit changes.

For existing plugin

1. Go to the root folder of your plugin code source
2. git submodule add https://github.com/osgeosuomi/qgis_plugin_tools.git
3. To get most out of the submodule, try to refactor the plugin to use the default plugin tree

Setting up development environment

This project uses uv to manage python packages. Make sure to have it installed first.

• Create a venv that is aware of system QGIS libraries: uv venv --system-site-packages
  • On Windows, maybe use a tool like qgis-venv-creator.

# Activate the virtual environment
$ source .venv/bin/activate
# Install dependencies
$ uv sync
# Install pre-commit hooks
$ pre-commit install

Updating dependencies

uv lock --upgrade

How to use it

Refer to usage documentation.

Contributing

Contributions are very welcome. Get started by reading OSGeo Suomi CONTRIBUTING guidelines.