Build your own QGIS plugin

Get help in transforming your code to a QGIS plugin, but also:

  • Write test classes for your code;
  • Create online documentation (like what you are reading now);
  • What are the requirements to upload your plugin to the official QGIS repository;
  • Build and upload a python package to PyPi.

The instruction pages can be found at <>.

The code repository can be found at


When using this project as the base for your own plugin, please give us some credit in your acknowledgements like this:

The project structure is based on ‘Create A QGIS Plugin’ created by Crabbé Ann, Jakimow Benjamin and Somers Ben and funded by BELSPO STEREO III (Project LUMOS - SR/01/321). The full code is available from


The creation of this project is funded primarily through BELSPO (the Belgian Science Policy Office) in the framework of the STEREO III Programme – Project LUMOS - SR/01/321.

The LUMOS logo was created for free at


This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License (COPYING.txt). If not see

For issues, bugs, proposals or remarks, visit the issue tracker.