Skip to main content

Planet SDK for Python

Project description

Planet SDK for Python

Build Status

The Planet Software Development Kit (SDK) for Python provides both a Python API and a command-line interface (CLI) to make use of the Planet APIs. Everything you need to get started is found in our online documentation.

Version 2.0 includes support for the core workflows of the following APIs:

  • Data - Search for imagery from Planet's data catalog.
  • Orders - Process and download or deliver imagery.
  • Subscriptions - Set up a search to auto-process and deliver imagery.

After the initial 2.0 release there will be additional work to support the remaining Planet APIs: basemaps, tasking and analytics.

Versions and Stability

The SDK follows Semantic Versioning and therefore only major releases should break compatibility. Minor versions may include new functionality and patch versions address bugs or trivial changes (like documentation).

If depending upon official packages from PyPI, a developer should feel comfortable specifying planet == 2.* unless depending on a specific feature introduced at a minor version, in which case planet == 2.x.* (where x is the minor version of the new feature) should suffice.

The default branch is always main and should be considered in-development but with tests and other build steps succeeding.

Installation and Quick Start

The Planet SDK for Python is hosted on PyPI and can simply be installed via:

pip install planet

To install from source, first clone this repository, then navigate to the root directory (where setup.py lives) and run:

pip install .

Note that the above commands will install the Planet SDK into the global system Python unless a virtual environment is enabled. For more information on configuring a virtual environment from system Python, see the official Python venv documentation. For users who are running multiple versions of Python via pyenv, see the pyenv-virtualenv extension documentation.

Detailed installation instructions for the Planet SDK can be found in the Quick Start Guide of the documentation.

Contributing and Development

To contribute or develop with this library, see CONTRIBUTING.md.

Documentation

Documentation is currently hosted online It should be considered 'in progress', with many updates to come. It can also be built and hosted locally (see CONTRIBUTING.md) or can be read from source in the docs directory.

Authentication

Planet's APIs require an account for use. To get started you need to Get a Planet Account.

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

planet-2.11.0.tar.gz (62.7 kB view details)

Uploaded Source

Built Distribution

planet-2.11.0-py3-none-any.whl (83.5 kB view details)

Uploaded Python 3

File details

Details for the file planet-2.11.0.tar.gz.

File metadata

  • Download URL: planet-2.11.0.tar.gz
  • Upload date:
  • Size: 62.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for planet-2.11.0.tar.gz
Algorithm Hash digest
SHA256 5d0813724ec9d61336a5c15d8d97c78b78bd410c785dd14e277b5986c06e6d8c
MD5 a9e5a8dfe3d98e07145b249ae55b01b4
BLAKE2b-256 3ed0c92f4d7988ef725a91191f3ad0a65bfd823259b07ad2c262ada030de63ab

See more details on using hashes here.

Provenance

File details

Details for the file planet-2.11.0-py3-none-any.whl.

File metadata

  • Download URL: planet-2.11.0-py3-none-any.whl
  • Upload date:
  • Size: 83.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.17

File hashes

Hashes for planet-2.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e61a3bf2b1f04ff5e2d4b64e57c7258f9c521760ae837e19fab2e125e8f61ca
MD5 2fc19870af55a0bf86608b8b3f73c1ca
BLAKE2b-256 7faa16dc8022df5044e4ee5634c3abef34b71e0115f1ac69226cf231059a31f4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page