How qgis-deployment/qgis-deployment-toolbelt-cli works
QDT is a cross-platform CLI for applying organizational QGIS deployment scenarios. Its main workflow reads a scenario, selects and runs deployment jobs, and updates local QGIS profiles, plugins, settings, and related environment conveniences. The README also documents Git-backed profile management, conditional rules, variable-aware INI configuration, and bandwidth-conscious plugin handling; these appear as capability branches, though the sampled source does not establish all their runtime wiring. Job and handler paths are shown where supported by the tree; unsampled job internals are not inferred.
Main entry points: orchestrator.py Jobs orchestrator · job_profiles_synchronizer.py Profile sync and download · deployment.py Deploy command · cli.py Command-line interface
Components 21
CLI and scenarios
- Command-line interface
qgis_deployment_toolbelt/cli.py - Deploy command
qgis_deployment_toolbelt/commands/deployment.py - Scenario reader
qgis_deployment_toolbelt/scenarios/scenario_reader.py
Deployment jobs
- Jobs orchestrator
qgis_deployment_toolbelt/jobs/orchestrator.py - Profile sync and download
qgis_deployment_toolbelt/jobs/job_profiles_synchronizer.py - Plugin sync and download
qgis_deployment_toolbelt/jobs/job_plugins_synchronizer.py - Stale resource cleanup
qgis_deployment_toolbelt/jobs/job_cleanup_manager.py - Settings and environment jobs
qgis_deployment_toolbelt/jobs/job_environment_variables.py - Shortcut management
qgis_deployment_toolbelt/jobs/job_shortcuts.py - Splash management
qgis_deployment_toolbelt/jobs/job_splash_screen.py - Cleanup manager
qgis_deployment_toolbelt/jobs/job_cleanup_manager.py
Profiles and rules
- Profile model
qgis_deployment_toolbelt/profiles/qdt_profile.py - Conditional rules context
qgis_deployment_toolbelt/profiles/rules_context.py - Git profile sources
qgis_deployment_toolbelt/profiles/profiles_handler_base.py - HTTP profile source
qgis_deployment_toolbelt/profiles/remote_http_handler.py
QGIS integration
- QGIS INI handling
qgis_deployment_toolbelt/profiles/qgis_ini_handler.py - Shortcut creation
qgis_deployment_toolbelt/shortcuts/shortcuts_handler.py
Other components
- Operator
- Git repository
- HTTP repository
- Local QGIS installation
Connections 22
- Operator → Command-line interface: invokes
- Command-line interface → Deploy command: dispatches
- Deploy command → Scenario reader: reads scenario
- Deploy command → Jobs orchestrator: runs jobs
- Jobs orchestrator → Profile sync and download: dispatches
- Jobs orchestrator → Plugin sync and download: dispatches
- Jobs orchestrator → Stale resource cleanup: dispatches
- Jobs orchestrator → Settings and environment jobs: dispatches
- Jobs orchestrator → Shortcut management: dispatches
- Jobs orchestrator → Splash management: dispatches
- Stale resource cleanup → Cleanup manager: runs cleanup
- Profile sync and download → Profile model: syncs profiles
- Plugin sync and download → Profile model: uses profile data
- Git profile sources → Git repository: reads repository
- HTTP profile source → HTTP repository: downloads files
- Profile sync and download → Git profile sources: uses source
- Profile sync and download → HTTP profile source: uses source
- Settings and environment jobs → QGIS INI handling: updates settings
- Shortcut management → Shortcut creation: creates shortcuts
- QGIS INI handling → Local QGIS installation: configures
- Shortcut creation → Local QGIS installation: targets installation
- Conditional rules context → Scenario reader: supports conditions