map2loop - 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	map2loop
Plugin name slugified	plugin_map2loop
Plugin name class (used in code)	Map2LoopPlugin
Plugin category	None
Plugin description short	Loop tools for augmenting geological map data into 3D model datasets
Plugin description long	Extends QGIS with revolutionary features that every single GIS end-users was expected (or not)!
Plugin tags	geology, modelling, structural geology, loop3d
Plugin icon	default_icon.png
Plugin with processing provider	True
Author name	Lachlan GROSE
Author organization	Monash University
Author email	[email protected]
Minimum QGIS version	3.4
Maximum QGIS version	3.99
Support Qt6	True
Git repository URL	https://github.com/Loop3d/plugin_map2loop
Git default branch	main
License	GPLv2+
Python linter	None
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.

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 located in docs subfolder, written in Markdown using myst-parser, structured in two main parts, Usage and Contribution, generated using Sphinx (have a look to the configuration file) and is automatically generated through the CI and published on Pages: https://github.com/Loop3d/plugin_map2loop (see post generation steps below).

---

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:

   # run all pre-commit hooks on all files
   pre-commit run -a
   # don't be shy, run it again until it's all grren

2. Adjust URL and build the documentation locally

Note

Since it's very hard to determine which the final documentation URL will be, the templater does not set it up. You have to do it manually. The final URL should be something like this: https://{user_org}.github.io/{project_slug}. You can find it in Pages settings of your repository: https://github.com/Loop3d/plugin_map2loop/settings/pages.

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. Update the base URL of custom repository in installation doc page.
3. Change the plugin's icon stored in plugin_map2loop/resources/images
4. 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/Loop3d/plugin_map2loop/settings/pages

4. Add the remote repository to your local repository:

   git remote add origin https://github.com/Loop3d/plugin_map2loop

5. Commit changes:

   git commit -m "init(plugin): adding first files of map2loop" -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.