Planet Plugin for QGIS
Browse, filter, preview and download Planet Inc imagery in QGIS.
Official documentation can be found here
QGIS 3.6 (minimum)
Note, if you just need to install the plugin, jump to Plugin Setup (below).
A quick setup of the development environment needed for the plugin and to work
with the Planet API tutorials is available via the
conda packaging system.
The dev environ provides:
- QGIS desktop app
- Python package of bindings for QGIS
- Python package of bindings to Qt (LTS version) via PyQt
pipPython package for installing packages (try to use
condapackages first, if available)
- Python packages necessary for Planet API tutorials
First, clone this repository.
conda env create -f=/path/to/qgis3-conda-forge-env.yml
This will create a
conda environment named
qgis3-conda-forge, which you
can activate in a Terminal session:
conda activate qgis3-conda-forge
Or, you can use the environ as a basis for your Python interpreter within
VSCode, PyCharm or similar IDE that natively supports parsing
Then, install the following into the
conda install --force-reinstall -n qgis3-conda-forge -c conda-forge conda-wrappers
conda-wrappers utility creates
conda environ wrappers for ALL executables/scripts in
qgis3-conda-forge/bin, so needs to be run after setting up the environment. The same
install --force-reinstall command needs re-run if you install any new packages that add executables/scripts to
qgis3-conda-forge/bin, so they can also be wrapped.
The wrapped executables/scripts are available at this path (note added
For example, you should use the following python3 exe path for IDE setups:
To install the latest version of the plugin:
Clone this repository or download and unzip the latest code of the plugin, if you have not already.
If you do not have paver installed, install it by typing the following in a console (contributor note: it is already in the dev environment):
pip install paver
Open a console in the folder created in the first step, and type
This will get all the dependencies needed by the plugin.
Install into QGIS by running
That will copy the code into your QGIS user plugin folder, or create a symlink in it, depending on your OS.
pavertask only installs to the 'default' QGIS profile; so, you will have to ensure that is the active profile in order to see the plugin. You will also need to initially activate the plugin inside of the QGIS plugin manager.
To package the plugin (not needed during development), run
Documentation will be built in the docs folder and added to the resulting zip file. It includes dependencies as well, but it will not download them, so the setup task has to be run before packaging.