Skip to content

lpoaura/PluginQGis-LPOData

Repository files navigation

Scripts de processing framework de la LPO AuRA - QGIS Plugin

🎳 Tester codecov ✅ Linter 🚀 Releaser

Code style: black Imports: isort pre-commit flake8

GPLv3 license

Ce plugin ajoute à QGIS des scripts d'exploitation des données naturalistes de la LPO Auvergne-Rhône-Alpes. Il s'appuie sur une base de données Géonature.

L'installation et l'utilisation sont documentatées ici.

Outre la structure de la base de données Géonature, il nécessite :

  • la présence de vues matérialisées dans le schéma taxonomie (sql dans le dossier config)
  • la création du schéma dbadmin et de vues matérialisées (sql dans le dossier config)
  • la création du schéma src_lpodatas et des vues associées (sql dans le dossier config)
  • la présence du fichier startup.py dans le dossier racine de configuration de QGIS:
    • Linux: ~/.local/share/QGIS/QGIS3/
    • Windows: %AppData%/QGIS/QGIS3/

La base de données sur laquelle les développements ont été faits dispose également des fonctionnalités de gn_vn2synthese.

Pour permettre l'export des données formatées, il est nécessaire de disposer de la libraire openpyxl. Pour l'installer py3_env puis python3 -m pip install --user openpyxl.

Development

Refer to development for developing this QGIS3 plugin.

License

This plugin is licenced withGNU General Public License, version 3

See LICENSE for more information.

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: both

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

Contributors