Skip to content

Latest commit

 

History

History
100 lines (67 loc) · 3.44 KB

README.md

File metadata and controls

100 lines (67 loc) · 3.44 KB

GeoNature 2 QGIS - QGIS Plugin

Code style: black Imports: isort pre-commit

flake8

Generated options

Plugin

Cookiecutter option Picked value
Plugin name GeoNature 2 QGIS
Plugin name slugified gn2qgis
Plugin name class (used in code) Gn2Qgis
Plugin category Database
Plugin description short This plugin allow you to import data from GeoNature to QGIS
Plugin description long Allow the user to extract data from multiple GeoNature instances.
Plugin tags geonature, observations
Plugin icon default_icon.png
Plugin with processing provider False
Author name Jules GRILLOT
Author organization Asters - CEN74
Author email [email protected]
Minimum QGIS version 3.28
Maximum QGIS version 3.99
Git repository URL https://github.com/asterscen74/plugin_gn2qgis/
Git default branch main
License GPLv2+
Python linter Flake8
CI/CD platform GitHub
IDE VSCode

Tooling

This project is configured with the following tools:

  • Black to format the code without any existential question
  • iSort to sort the Python imports

Code rules are enforced with pre-commit hooks.
Static code analisis is based on: Flake8

See also: contribution guidelines.

CI/CD

Plugin is linted, tested, packaged and published with GitHub.

If you mean to deploy it to the official QGIS plugins repository, remember to set your OSGeo credentials (OSGEO_USER_NAME and OSGEO_USER_PASSWORD) as environment variables in your CI/CD tool.

Documentation

The documentation is generated using Sphinx and is automatically generated through the CI and published on Pages.

Next steps

Set up development environment

Typical commands on Linux (Ubuntu).

  1. If you don't pick the git init option, initialize your local repository:

    git init

  2. Follow the embedded documentation to set up your development environment

  3. Add all files to git index to prepare initial commit:

    git add -A

  4. Run the git hooks to ensure that everything runs OK and to start developing on quality standards:

    pre-commit run -a

Try to build documentation locally

  1. Have a look to the plugin's metadata.txt file: review it, complete it or fix it if needed (URLs, etc.).
  2. Follow the embedded documentation to build plugin documentation locally

License

Distributed under the terms of the GPLv2+ license.