qgis / QGIS-Hub-Plugin

A QGIS plugins to fetch resources from the QGIS Hub

QGIS Hub Plugin - QGIS Plugin

A QGIS plugins to fetch resources from the QGIS Hub

Resource Browser

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/qgis/QGIS-Hub-Plugin
• repository: https://github.com/qgis/QGIS-Hub-Plugin
• tracker: https://github.com/qgis/QGIS-Hub-Plugin/issues

---

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:

   git init

2. Follow the embedded documentation to set up your development environment

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

Try to build documentation locally

1. Have a look to the plugin's metadata.txt file: review it, complete it or fix it if needed (URLs, etc.).
2. Follow the embedded documentation to build plugin documentation locally

---

License

Distributed under the terms of the GPLv3 license.