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:
After the initial 2.0 release there will be additional work to support the remaining Planet APIs: basemaps, tasking and analytics.
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.
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.
To contribute or develop with this library, see CONTRIBUTING.md.
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.
Planet's APIs require an account for use. To get started you need to Get a Planet Account.
FAQs
Planet SDK for Python
We found that planet demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.