BD TOPO® Extractor - QGIS Plugin

Generated options

Plugin

Cookiecutter option	Picked value
Plugin name	BD Topo Extractor
Plugin name slugified	bd_topo_extractor
Plugin name class (used in code)	BdTopoExtractor
Plugin category	Vector
Plugin description short	It allows the user to extract elements from IGN's BD Topo with an extent of a drawn rectangle or from layer.
Plugin description long	It allows the user to extract elements from IGN's BD Topo with an extent of a drawn rectangle or from layer. You can select wich element you want to extract,from the database. Choose if you want to keep it as a memory layer or directly save it into a folder. It's also possible to select if you want the intersecting data or the data within the selected extent.
Plugin tags	vector
Plugin icon	default_icon.png
Plugin with processing provider	yes
Author name	Jules GRILLOT
Author organization	Company
Author email	[email protected]
Minimum QGIS version	3.10
Maximum QGIS version	3.99
Git repository URL	https://github.com/JulesGrillot/plugin_bd_topo_extractor
Git default branch	main
License	None
Python linter	None
CI/CD platform	GitHub
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 generated using Sphinx and is automatically generated through the CI and published on Pages.

• homepage: https://julesgrillot.github.io/plugin_bd_topo_extractor/
• repository: https://github.com/JulesGrillot/plugin_bd_topo_extractor
• tracker: https://github.com/JulesGrillot/plugin_bd_topo_extractor/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 GNU General Public License v2.0 license.