QGIS Plugin tools

The library 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
• fetching compiled translation file in resources/i18n folder
• removing QRC resources file easily
• translate using the i18n.tr() function.
• providing some common widgets/code for plugins
• typing helpers to help with type checking

How to install it

It is recommended to use this library as an external dependency with the help of qgis-plugin-dev-tools. Or some other tool that can download the library through pip.

The tool can be installed via pip:

pip install qgis_plugin_tools

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

[project]
dependencies = [
  "qgis_plugin_tools"
]

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

Development

See development readme.

Translating with QT Linguist

The translation files are in i18n folder. Translatable content in python files is code such as tr(u"Hello World").

Translation files can be updated with qpdt transup or wait them to be updated automatically with "update-translations" pre-commit hook.

After updating ts files, you can open file you wish to translate with Qt Linguist or code editor, make the changes and compile the translations to .qm files using qpdt transcompile (works only on Linux, on Windows use Qt Linguist's File -> Release menu action).

How to use it

Refer to usage documentation.

Contributing

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

License

qgis_plugin_tools is licensed under the GNU General Public License, version 2 or (at your option) any later version (GPL-2.0-or-later). See LICENSE for the full text of GPLv2. Every source file carries a license notice.

By contributing to this project you agree that your contributions are licensed under the same terms.