{"id":15942444,"url":"https://github.com/guts/test-qgis-plugin-templater","last_synced_at":"2026-06-09T05:31:55.257Z","repository":{"id":222276897,"uuid":"756413716","full_name":"Guts/test-qgis-plugin-templater","owner":"Guts","description":"A 'fake' repository to test the autogenerated content by QGIS Plugin Templater (https://oslandia.gitlab.io/qgis/template-qgis-plugin) with GitHub.","archived":false,"fork":false,"pushed_at":"2026-02-06T12:04:14.000Z","size":293,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-02-06T19:59:21.792Z","etag":null,"topics":["cookiecutter","fake","qgis-plugin","test"],"latest_commit_sha":null,"homepage":"https://guts.github.io/test-qgis-plugin-templater/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Guts.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-02-12T16:09:18.000Z","updated_at":"2026-02-06T12:04:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"3d28325b-7e3f-43a0-9db5-1fbfe989d3c7","html_url":"https://github.com/Guts/test-qgis-plugin-templater","commit_stats":null,"previous_names":["guts/test-qgis-plugin-templater"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/Guts/test-qgis-plugin-templater","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Ftest-qgis-plugin-templater","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Ftest-qgis-plugin-templater/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Ftest-qgis-plugin-templater/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Ftest-qgis-plugin-templater/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Guts","download_url":"https://codeload.github.com/Guts/test-qgis-plugin-templater/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guts%2Ftest-qgis-plugin-templater/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34093773,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","fake","qgis-plugin","test"],"created_at":"2024-10-07T07:41:26.517Z","updated_at":"2026-06-09T05:31:55.250Z","avatar_url":"https://github.com/Guts.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qgis_plugin_templater_test_github - QGIS Plugin\n\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat\u0026labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white)](https://github.com/pre-commit/pre-commit)\n\n\n[![flake8](https://img.shields.io/badge/linter-flake8-green)](https://flake8.pycqa.org/)\n\n## Generated options\n\n### Plugin\n\n\u003e Here is a list of the options you picked when creating the plugin with the cookiecutter template.\n\n| Cookiecutter option | Picked value |\n| :------------------ | :----------: |\n| Plugin name | qgis_plugin_templater_test_github |\n| Plugin name slugified | qgis_plugin_templater_test_github |\n| Plugin name class (used in code) | QgisPluginTemplaterTestGithub |\n| Plugin category | Vector |\n| Plugin description short | Autogenerated QGIS plugin boilerplate using GitHub CI |\n| Plugin description long | Extends QGIS with revolutionary features that every single GIS end-users was expected (or not)! |\n| Plugin tags | topic1,topic2 |\n| Plugin icon | default_icon.png |\n| Plugin with processing provider | true |\n| Author name | Julien M. |\n| Author organization | Oslandia |\n| Author email | julien.moura@oslandia.com |\n| Minimum QGIS version | 3.40 |\n| Maximum QGIS version | 3.99 |\n| Support Qt6 | True |\n| Git repository URL | https://github.com/Guts/test-qgis-plugin-templater |\n| Git default branch | main |\n| License | GPLv2+ |\n| Python linter | Flake8 |\n| CI/CD platform | GitHub |\n| Publish to \u003chttps://plugins.qgis.org\u003e using CI/CD | false |\n| IDE | VSCode |\n\n### Tooling\n\nThis project is configured with the following tools:\n\n- [Black](https://black.readthedocs.io/en/stable/) to format the code without any existential question\n- [iSort](https://pycqa.github.io/isort/) to sort the Python imports\n\nCode rules are enforced with [pre-commit](https://pre-commit.com/) hooks.  \nStatic code analysis is based on: Flake8\n\nSee also: [contribution guidelines](CONTRIBUTING.md).\n\n## CI/CD\n\nPlugin is linted, tested, packaged and published with GitHub.\n\nIf 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.\n\n\n### Documentation\n\nThe 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: \u003chttps://github.com/Guts/test-qgis-plugin-templater/pages\u003e (see [post generation steps](#2-build-the-documentation-locally) below).\n\n----\n\n## Next steps post generation\n\n### 1. Set up development environment\n\n\u003e Typical commands on Linux (Ubuntu).\n\n1. If you didn't pick the `git init` option, initialize your local repository:\n\n    ```sh\n    git init\n    ```\n\n1. Follow the [embedded documentation to set up your development environment](./docs/development/environment.md) to create  virtual environment and install development dependencies.\n1. Add all files to git index to prepare initial commit:\n\n    ```sh\n    git add -A\n    ```\n\n1. Run the git hooks to ensure that everything runs OK and to start developing on quality standards:\n\n    ```sh\n    # run all pre-commit hooks on all files\n    pre-commit run -a\n    # don't be shy, run it again until it's all green\n    ```\n\n### 2. Adjust URL and build the documentation locally\n\n\u003e [!NOTE]\n\u003e 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.\n\u003e The final URL should be something like this: \u003chttps://{user_org}.github.io/{project_slug}\u003e. You can find it in Pages settings of your repository: \u003chttps://github.com/Guts/test-qgis-plugin-templater/pages\u003e.\n\n1. 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.\n1. Update the base URL of custom repository in [installation doc page](./docs/usage/installation.md).\n1. Change the plugin's icon stored in `qgis_plugin_templater_test_github/resources/images`\n1. Follow the [embedded documentation to build plugin documentation locally](./docs/development/documentation.md)\n\n### 3. Prepare your remote repository\n\n1. If you did not yet, create a remote repository on your Git hosting platform (GitHub, GitLab, etc.)\n1. Create labels listed in [labeler.yml file](.github/labeler.yml) to make PR auto-labelling work.\n1. Switch the source of GitHub Pages to `GitHub Actions` in your repository settings \u003chttps://github.com/Guts/test-qgis-plugin-templater/pages\u003e\n1. Add the remote repository to your local repository:\n\n    ```sh\n    git remote add origin https://github.com/Guts/test-qgis-plugin-templater\n    ```\n\n1. Commit changes:\n\n    ```sh\n    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)\"\n    ```\n\n1. Push the initial commit to the remote repository:\n\n    ```sh\n    git push -u origin main\n    ```\n\n1. 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).\n\n\n1. 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).\n\n\n----\n\n## License\n\nDistributed under the terms of the [`GPLv2+` license](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguts%2Ftest-qgis-plugin-templater","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguts%2Ftest-qgis-plugin-templater","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguts%2Ftest-qgis-plugin-templater/lists"}