https://github.com/guts/test-qgis-plugin-templater
A 'fake' repository to test the autogenerated content by QGIS Plugin Templater (https://oslandia.gitlab.io/qgis/template-qgis-plugin) with GitHub.
https://github.com/guts/test-qgis-plugin-templater
cookiecutter fake qgis-plugin test
Last synced: about 1 month ago
JSON representation
A 'fake' repository to test the autogenerated content by QGIS Plugin Templater (https://oslandia.gitlab.io/qgis/template-qgis-plugin) with GitHub.
- Host: GitHub
- URL: https://github.com/guts/test-qgis-plugin-templater
- Owner: Guts
- License: gpl-2.0
- Created: 2024-02-12T16:09:18.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-06T12:04:14.000Z (5 months ago)
- Last Synced: 2026-02-06T19:59:21.792Z (5 months ago)
- Topics: cookiecutter, fake, qgis-plugin, test
- Language: Python
- Homepage: https://guts.github.io/test-qgis-plugin-templater/
- Size: 286 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# qgis_plugin_templater_test_github - QGIS Plugin
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort/)
[](https://github.com/pre-commit/pre-commit)
[](https://flake8.pycqa.org/)
## 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 | qgis_plugin_templater_test_github |
| Plugin name slugified | qgis_plugin_templater_test_github |
| Plugin name class (used in code) | QgisPluginTemplaterTestGithub |
| Plugin category | Vector |
| Plugin description short | Autogenerated QGIS plugin boilerplate using GitHub CI |
| Plugin description long | Extends QGIS with revolutionary features that every single GIS end-users was expected (or not)! |
| Plugin tags | topic1,topic2 |
| Plugin icon | default_icon.png |
| Plugin with processing provider | true |
| Author name | Julien M. |
| Author organization | Oslandia |
| Author email | julien.moura@oslandia.com |
| Minimum QGIS version | 3.40 |
| Maximum QGIS version | 3.99 |
| Support Qt6 | True |
| Git repository URL | https://github.com/Guts/test-qgis-plugin-templater |
| Git default branch | main |
| License | GPLv2+ |
| Python linter | Flake8 |
| CI/CD platform | GitHub |
| Publish to using CI/CD | false |
| IDE | VSCode |
### Tooling
This project is configured with the following tools:
- [Black](https://black.readthedocs.io/en/stable/) to format the code without any existential question
- [iSort](https://pycqa.github.io/isort/) to sort the Python imports
Code rules are enforced with [pre-commit](https://pre-commit.com/) hooks.
Static code analysis is based on: Flake8
See also: [contribution guidelines](CONTRIBUTING.md).
## CI/CD
Plugin is linted, tested, packaged and published with GitHub.
If you mean to deploy it to the [official QGIS plugins repository](https://plugins.qgis.org/), 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](https://myst-parser.readthedocs.io/), structured in two main parts, Usage and Contribution, generated using Sphinx (have a look to [the configuration file](./docs/conf.py)) and is automatically generated through the CI and published on Pages: (see [post generation steps](#2-build-the-documentation-locally) 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:
```sh
git init
```
1. Follow the [embedded documentation to set up your development environment](./docs/development/environment.md) to create virtual environment and install development dependencies.
1. Add all files to git index to prepare initial commit:
```sh
git add -A
```
1. Run the git hooks to ensure that everything runs OK and to start developing on quality standards:
```sh
# run all pre-commit hooks on all files
pre-commit run -a
# don't be shy, run it again until it's all green
```
### 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: . You can find it in Pages settings of your repository: .
1. Have a look to the [plugin's metadata.txt file](qgis_plugin_templater_test_github/metadata.txt): review it, complete it or fix it if needed (URLs, etc.)., especially the `homepage` URL which should be to your GitLab or GitHub Pages.
1. Update the base URL of custom repository in [installation doc page](./docs/usage/installation.md).
1. Change the plugin's icon stored in `qgis_plugin_templater_test_github/resources/images`
1. Follow the [embedded documentation to build plugin documentation locally](./docs/development/documentation.md)
### 3. Prepare your remote repository
1. If you did not yet, create a remote repository on your Git hosting platform (GitHub, GitLab, etc.)
1. Create labels listed in [labeler.yml file](.github/labeler.yml) to make PR auto-labelling work.
1. Switch the source of GitHub Pages to `GitHub Actions` in your repository settings
1. Add the remote repository to your local repository:
```sh
git remote add origin https://github.com/Guts/test-qgis-plugin-templater
```
1. Commit changes:
```sh
git commit -m "init(plugin): adding first files of qgis_plugin_templater_test_github" -m "generated with QGIS Plugin Templater (https://oslandia.gitlab.io/qgis/template-qgis-plugin)"
```
1. Push the initial commit to the remote repository:
```sh
git push -u origin main
```
1. Create a new release following the [packaging/release guide](./docs//development/packaging.md) with the tag `0.1.0-beta1` to trigger the CI/CD pipeline and publish the plugin on the [official QGIS plugins repository](https://plugins.qgis.org/) (if you picked up the option).
1. After publishing the plugin for the first time on the official QGIS repository, remember to indicate the plugin ID in the [documentation configuration](./docs/conf.py).
----
## License
Distributed under the terms of the [`GPLv2+` license](LICENSE).