Follow recommendations for QGIS plugins
https://plugins.qgis.org/publish/ lists a lot of recommendations. I think, we don't strictly follow the following:
Requirements
- Plugins need to have at least minimal documentation - we currently have none. See #4
- The plugin metadata contains a link to the source code, an issue tracker and a license - it does, but it's not publicly available
- The plugin license is compatible with the GPLv2 or later (more information about licensing) - we don't have a license
- If the plugin has an external dependency, this needs to be clearly stated in the About metadata field - we should document the pandas dependency, or drop it. See #3
Recommendations
- Provide a minimal data set for testing - we currently don't test at all
- Put the plugin into the appropriate menu (Vector, Raster, Web, Database) - I don't know which one that is. I assume
Vector
. - Before publishing a new plugin, check if it duplicates existing functionality and explore collaboration possibilities - I don't think anyone does this, but again, I don't know
- Check if source code uploaded to the QGIS plugin repo as zip is identical to "Code repository" indicated in metadata.txt - it is sort of, we still have a few remnants of the plugin builder
- Mention any requirements, dependencies and restrictions in the description text section (which can be multi-line). Examples of requirements, dependencies and restrictions are, if the plugin is running only on selected platforms, requires SW to be installed separately or some user account, but also if the plugin is spatially covering just some countries or regions. - as above
Tips and Tricks
- Keep your source repository in good shape:
- No generated files left in the repository (ui_*.py, resources_rc.py, gen. help files…). - I'm not sure about this
- Good code organization (subfolders). - I don't think this is complicated enough for anything
- PEP8 & Python/QGIS guidelines compliance. - haven't checked them
- A README file and a LICENCE file are present. - they aren't, but code isn't public yet…
- If some dependencies are not available in OSGeo4w Python, provide instructions on how to install them on Windows. - That should be for s/o to check