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)

Code style: black flake8 Imports: isort 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

✨ Features

  • Manage QGIS profiles easily: define, store, and deploy profiles with a simple profile.json file.
  • 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?

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.38.0.tar.gz (13.5 MB view details)

Uploaded Source

Built Distribution

qgis_deployment_toolbelt-0.38.0-py3-none-any.whl (112.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for qgis_deployment_toolbelt-0.38.0.tar.gz
Algorithm Hash digest
SHA256 b519ab4eedbff57e2651f730e3029103c64219c4cf99db1ecc0d333214482f6c
MD5 18e8c4ffac43d999dadf22597dce41ee
BLAKE2b-256 38eb9308739c327dd4504c80a8992a3098ad0bee10c7eab3daa04a1852120e65

See more details on using hashes here.

Provenance

The following attestation bundles were made for qgis_deployment_toolbelt-0.38.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.38.0-py3-none-any.whl.

File metadata

File hashes

Hashes for qgis_deployment_toolbelt-0.38.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e51e9f5845f167b90d36e11db9c4525cc81e4d54a9b8fc03fcfa013b6d9b024
MD5 8a28cd30e0947491bb77b2c6fa3369f6
BLAKE2b-256 9ba1ac28c4b16836c07df61ceb8775d428e9c2cd92778db9519b9218037fcac8

See more details on using hashes here.

Provenance

The following attestation bundles were made for qgis_deployment_toolbelt-0.38.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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page