Géoplateforme - QGIS Plugin

Generated options

Plugin

Here is a list of the options you picked when creating the plugin with the cookiecutter template.

Cookiecutter option	Picked value
Plugin name	Géoplateforme
Plugin name slugified	geoplateforme
Plugin name class (used in code)	Geoplateforme
Plugin category	None
Plugin description short	Tirer parti de la puissance de la Géoplateforme directement depuis QGIS !
Plugin description long	Connectez-vous avec votre compte cartes.gouv.fr, accédez à votre communauté, publiez vos données sous forme de services hébergés sur la Géoplateforme de l'IGN.
Plugin tags	IGN,Géoplateforme,téléversement,publication,Entrepôt
Plugin icon	default_icon.png
Plugin with processing provider	True
Author name	Julien Moura
Author organization	Oslandia
Author email	qgis@oslandia.com
Minimum QGIS version	3.40
Maximum QGIS version	3.99
Support Qt6	True
Git repository URL	https://github.com/Geoplateforme/plugin-qgis-geoplateforme/
Git default branch	main
License	GPLv2+
Python linter	Flake8
CI/CD platform	GitHub
Publish to https://plugins.qgis.org using CI/CD	True
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.

• homepage: https://github.com/Geoplateforme/plugin-qgis-geoplateforme/
• repository: https://github.com/Geoplateforme/plugin-qgis-geoplateforme/
• tracker: https://github.com/Geoplateforme/plugin-qgis-geoplateforme//issues/

---

Next steps post generation

1. Set up development environment

Typical commands on Linux (Ubuntu).

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

   git init

2. Follow the embedded documentation to set up your development environment to create virtual environment and install development dependencies.

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

2. Build the documentation locally

1. Have a look to the plugin's metadata.txt file: review it, complete it or fix it if needed (URLs, etc.)., especially the homepage URL which should be to your GitLab or GitHub Pages.
2. Change the plugin's icon stored in geoplateforme/resources/images
3. Follow the embedded documentation to build plugin documentation locally

3. Prepare your remote repository

1. If you did not yet, create a remote repository on your Git hosting platform (GitHub, GitLab, etc.)

2. Create labels listed in labeler.yml file to make PR auto-labelling work.

3. Switch the source of GitHub Pages to GitHub Actions in your repository settings https://github.com/Geoplateforme/plugin-qgis-geoplateforme//settings/pages

4. Add the remote repository to your local repository:

   git remote add origin <https://github.com/Geoplateforme/plugin-qgis-geoplateforme/>

5. Commit changes:

   git commit -m "init(plugin): adding first files of Géoplateforme" -m "generated with QGIS Plugin Templater (https://oslandia.gitlab.io/qgis/template-qgis-plugin)"

6. Push the initial commit to the remote repository:

   git push -u origin main

7. Create a new release following the packaging/release guide with the tag 0.1.0-beta1 to trigger the CI/CD pipeline and publish the plugin on the official QGIS plugins repository (if you picked up the option).

---

License

Distributed under the terms of the GPLv2+ license.