Tool for downloading/managing QGIS plugins from CLI.
Project description
QGIS-Plugin-Manager
Mainly designed for QGIS Server plugins.
Not tested on Windows.
The CLI API is not stable yet.
Installation
Python 3.6 minimum, you can make a Python venv if needed.
python3 --version
pip3 install qgis-plugin-manager
python3 -m pip install qgis-plugin-manager
Utilisation
cd /path/where/you/have/plugins
# usually
cd /usr/lib/qgis/plugins
$ qgis-plugin-manager --help
usage: qgis-plugin-manager [-h] [-v] {init,list,remote,update,cache,install} ...
optional arguments:
-h, --help show this help message and exit
-v, --version Print the version and exit (default: False)
commands:
qgis-plugin-manager command
{init,list,remote,update,cache,install}
init Create the `sources.list` with plugins.qgis.org as remote
list List all plugins in the directory
remote List all remote server
update Update all index files
cache Look for a plugin in the cache
install Install a plugin
Init
To create the first sources.list
in the directory with at least the default repository https://plugins.qgis.org :
$ qgis-plugin-manager init
$ cat sources.list
https://plugins.qgis.org/plugins/plugins.xml?qgis=3.19
You can have one or many servers, one on each line.
List
List all plugins installed :
$ qgis-plugin-manager list
QGIS server version 3.19.0
List all plugins in /home/etienne/dev/qgis/server_plugin
----------------------------------------------------------------------------------------
| Name | Version | QGIS min | QGIS max | Author | Action ⚠ |
----------------------------------------------------------------------------------------
|Lizmap |master |3.4 |3.99 |3Liz |Unkown version |
|wfsOutputExtension|1.5.3 |3.0 | |3Liz | |
|QuickOSM |1.14.0 |3.4 |3.99 |Etienne Trimaille|Upgrade to 1.16.0|
|cadastre |1.6.2 |3.0 |3.99 |3liz | |
|atlasprint |3.2.2 |3.10 | |3Liz | |
----------------------------------------------------------------------------------------
Remote
$ qgis-plugin-manager remote
List of remotes :
https://plugins.qgis.org/plugins/plugins.xml?qgis=3.22
$ cat sources.list
https://plugins.qgis.org/plugins/plugins.xml?qgis=[VERSION]
[VERSION]
is a token in the sources.list
file to be replaced by the QGIS version, for instance 3.22
.
If QGIS is upgraded, the XML file will be updated as well.
You don't have to set the TOKEN for all URL :
https://docs.3liz.org/plugins.xml
is valid.
Update
To fetch the XML files from each repository :
$ qgis-plugin-manager update
Downloading https://plugins.qgis.org/plugins/plugins.xml?qgis=3.19...
Ok
$ ls .cache_qgis_plugin_manager/
https-plugins-qgis-org-plugins-plugins-xml-qgis-3-19.xml
Cache
Check if a plugin is available :
$ qgis-plugin-manager cache atlasprint
Plugin atlasprint : v3.2.2 available
Install
Install the latest version :
$ qgis-plugin-manager install QuickOSM
Installation QuickOSM latest
Ok QuickOSM.1.16.0.zip
or a specific version :
$ qgis-plugin-manager install QuickOSM==1.14.0
Installation QuickOSM 1.14.0
Ok QuickOSM.1.14.0.zip
Run tests
export PYTHONPATH=/home/etienne/dev/app/qgis-master/share/qgis/python/:/usr/lib/python3/dist-packages/
cd test
python3 -m unittest
flake8
TODO
- proper exit code
- API
- documentation
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for qgis-plugin-manager-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9334733c8de77037d5499b868c6ffe1e0560852089b6bd97f9065fef9baa2295 |
|
MD5 | d31d04e5d40efcb3bc0f973d7e746af8 |
|
BLAKE2b-256 | 149a6f31c7f44b722b9f16ecc7fa17efaf9555f4157d206f05c731311b7e83ba |