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: over 1 year 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: 2024-08-05T17:02:50.000Z (almost 2 years ago)
• Last Synced: 2025-01-14T04:26:35.524Z (over 1 year ago)
• Topics: cookiecutter, fake, qgis-plugin, test
• Language: Python
• Homepage: https://guts.github.io/test-qgis-plugin-templater/
• Size: 116 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# qgis_plugin_templater_test_github - QGIS Plugin

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![flake8](https://img.shields.io/badge/linter-flake8-green)](https://flake8.pycqa.org/)

## Generated options

### Plugin

| 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.34 |

| Maximum QGIS version | 3.99 |

| Git repository URL | https://github.com/Guts/test-qgis-plugin-templater |

| Git default branch | main |

| License | GPLv2+ |

| Python linter | Flake8 |

| CI/CD platform | GitHub |

| 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 analisis 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 generated using Sphinx and is automatically generated through the CI and published on Pages.

- homepage: 

- repository: 

- tracker: 

----

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

    ```sh

    git init

    ```

1. Follow the [embedded documentation to set up your development environment](./docs/development/environment.md)

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

    pre-commit run -a

    ```

### Try to build documentation locally

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.).

1. Follow the [embedded documentation to build plugin documentation locally](./docs/development/environment.md)

----

## License

Distributed under the terms of the [`GPLv2+` license](LICENSE).