Planet API Client

Python client library and CLI for Planet's public API.

Installation

Via pip:

$ pip install planet

The --user flag is highly recommended for those new to pip.

A PEX executable (Windows not supported) and source releases are here.

Documentation

Online documentation: https://planetlabs.github.io/planet-client-python/index.html

Documentation is also provided for download here.

Development

To develop with or use the library in your own projects, see the wiki.

API Key

The API requires an account for use. Signup here.

This can be provided via the environment variable PL_API_KEY or the flag -k or --api-key.

Using planet init your account credentials (login/password) can be used to obtain the api key.

Example CLI Usage

Hint: autocompletion can be enabled in some shells using:

eval "$(_PLANET_COMPLETE=source planet)"

Basics and help:

planet

The CLI provides access to the data API

planet data

OR specific command help:

planet data download --help