Skip to main content

QGIS deployment toolbelt is a CLI (Command Line Interface) to perform redundant operations after a QGIS deployment, managing QGIS profiles, plugins, environment variables, start menu / desktop shortcuts and many things to rationalize your QGIS installations.

Project description

QGIS Deployment Toolbelt (QDT)

Ruff pre-commit pre-commit.ci status security: bandit Quality Gate Status

🎳 Tester codecov 📦 Build & 🚀 Release

PyPi version badge PyPI - Downloads PyPI - Python Version

QGIS Deployment Toolbelt (QDT) is a cross-platform (primarily Windows-focused) command-line tool that streamlines the deployment and management of QGIS profiles, plugins, and related settings within organizations.

It helps standardize user environments, simplify updates, and integrate with IT deployment strategies like GPO, SCCM, or InTune.

⭐ Why QDT?

  • Save hours of manual QGIS configuration and profile management
  • Reduce configuration errors and user friction
  • Scale QGIS deployments in professional environments easily
  • Reconciling GIS service expectations and IT constraints
  • Community driven development and developed by experienced QGIS teams (especially Oslandia)

Come, talk and ask, we're a friendly (small) group of persons behind:

🚀 They use and trust QDT

Here comes some of known organization which do use QDT to deploy QGIS profiles seamlessly:

ISL Ingénierie EP Loire Métropole Grand Lyon Département de la Loire Grenoble Alpes Métropole LPO Auvergne Rhône Alpes ANFSI EP Eaux et Vilaine Métropole Aix Marseille Provence Eurométropole de Strasbourg Clermont Auvergne Métropole Opale
logo ISL logo EP Loire logo logo logo logo logo logo logo logo Eurométropole de Strasbourg logo Clermont Auvergne Métropole logo Opale énergies engagées

See more in documentation.

✨ Features

  • Manage QGIS profiles easily: define, store, and deploy profiles with a simple profile.json file. You can also use the Profile Manager plugin to export your existing profiles right from QGIS.
  • Version control integration: Git-powered backend for tracking changes and enabling collaborative profile management.
  • IT-friendly: designed to work with Active Directory, GPOs, SCCM, InTune, and other enterprise tools.
  • Seamless user experience: deliver a consistent QGIS experience across your organization with minimal friction.
  • Advanced configuration handling: use variabilized QGIS3.ini files to handle dynamic or environment-specific settings.
  • Conditional deployments: deploy specific profiles based on rules, environment variables, or user criteria.
  • Optimized plugin management: reduce bandwidth usage by rationalizing plugin downloads and installations.

🚀 Try it quickly

You have multiple options to try QDT:

  • Using Python and the official modern CLI installer pipx:

    pipx run qgis-deployment-toolbelt -s https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/raw/main/examples/scenarios/demo-scenario.qdt.yml
    
  • Using Python and the official package installer pip:

    pip install qgis-deployment-toolbelt
    qdt -s https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/raw/main/examples/scenarios/demo-scenario.qdt.yml
    
  • Using a pre-built executable (downloadable through releases assets). For example on Windows:

    ./Windows_QGISDeploymentToolbelt_0-37-0.exe  -s https://github.com/qgis-deployment/qgis-deployment-toolbelt-cli/raw/main/examples/scenarios/demo-scenario.qdt.yml
    

Once completed, check:

  • The Start menu / Desktop for new shortcuts.
  • The QGIS Profiles menu for new profiles.

QGIS - List of profiles with ones added by QDT demonstration scenario

Splash screen when launching the Demo Profile:

QGIS splash screen - QDT Demo Profile

Splash screen for the Viewer Profile:

QGIS splash screen - QDT Viewer Profile

Have you tried it on Linux? Well, you should find an additional profile simply named "QDT Only Linux".

[!TIP] Interested? For further details, read the documentation :books:.

🤝 Contribute

Want to help? Come on it's definitely open, everything here is under Apache 2.0 license.

Check out the contribution guide and "Development" section in the documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qgis_deployment_toolbelt-0.41.0.tar.gz (13.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qgis_deployment_toolbelt-0.41.0-py3-none-any.whl (115.4 kB view details)

Uploaded Python 3

File details

Details for the file qgis_deployment_toolbelt-0.41.0.tar.gz.

File metadata

File hashes

Hashes for qgis_deployment_toolbelt-0.41.0.tar.gz
Algorithm Hash digest
SHA256 6265e228b192dc4c9a4e4303338b3633305291825855292c46e3ba4033df0f80
MD5 4be8e4f637cfdb497c5ea69b87162ff7
BLAKE2b-256 41d17ed924b69569c1aae3cdde6fda84c550595e8118bd86972d6a68045903c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for qgis_deployment_toolbelt-0.41.0.tar.gz:

Publisher: build_release.yml on qgis-deployment/qgis-deployment-toolbelt-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qgis_deployment_toolbelt-0.41.0-py3-none-any.whl.

File metadata

File hashes

Hashes for qgis_deployment_toolbelt-0.41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64f699c528072a55a8a04230a5a9099443d08cbf86452cf94faa98f545e3783c
MD5 72208d0bea24735335c05b0e3c9f71aa
BLAKE2b-256 d057085a8c6ef2ff08bf9f4dee88f8e411f7ae10a5486ac24a66bdfbaf3c9992

See more details on using hashes here.

Provenance

The following attestation bundles were made for qgis_deployment_toolbelt-0.41.0-py3-none-any.whl:

Publisher: build_release.yml on qgis-deployment/qgis-deployment-toolbelt-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page