# Planet SDK for Python
[![Build Status](https://github.com/planetlabs/planet-client-python/actions/workflows/test.yml/badge.svg)](https://github.com/planetlabs/planet-client-python/actions/workflows/test.yml)
The [Planet](https://planet.com) Software Development Kit (SDK) for Python
provides both a Python API and a command-line interface (CLI)
to make use of [the Planet APIs](https://developers.planet.com/docs/apis/).
Everything you need to get started is found in our
[online documentation](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/).
Version 2.0 includes support for the core workflows of the following APIs:
* [Data](https://developers.planet.com/docs/data/) - Search for imagery from Planet's data catalog.
* [Orders](https://developers.planet.com/docs/orders/) - Process and download or deliver imagery.
* [Subscriptions](https://developers.planet.com/docs/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](https://developers.planet.com/docs/basemaps/),
[tasking](https://developers.planet.com/docs/tasking/)) and
[analytics](https://developers.planet.com/docs/analytics/).
## Versions and Stability
The default branch (main) of this repo is for the [Planet SDK for
Python](https://github.com/planetlabs/planet-client-python/projects/2),
a complete rewrite and upgrade from the original [Planet Python
Client](https://developers.planet.com/docs/pythonclient/). If you
are looking for the source code to that library see the
[v1](https://github.com/planetlabs/planet-client-python/tree/v1) branch.
The Planet SDK for Python is in 'pre-release' stages, working towards a solid
beta release in December. Upcoming milestones are tracked in the [Planet SDK
for Python Milestones](https://github.com/planetlabs/planet-client-python/milestones).
## Installation and Quick Start
The main installation path and first steps are found in the
[Quick Start Guide](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/quick-start-guide/)
of the documentation.
### Installing from source
This option enables you to get all the latest changes, but things might also be a bit less stable.
To install you must [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
the [planet-client-python](https://github.com/planetlabs/planet-client-python) repository
to your local computer. After you have the repo local just navigate to the root
directory, where this readme lives.
Then you can install locally with pip:
```console
$ pip install .
```
## Documentation
Documentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/)
It should be considered 'in progress', with many updates to come. It can also
be built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be
read from source in the [docs](/docs) directory.
## Authentication
Planet's APIs require an account for use. To get started you need to
[Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/).
## Development
To contribute or develop with this library, see
[CONTRIBUTING.md](CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/planetlabs/planet-client-python",
"name": "planet",
"maintainer": "Planet Dev Rel Team",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "developers@planet.com",
"keywords": "planet api sdk client",
"author": "Jennifer Reiber Kyle",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/de/07/073bfc48e65e13e32ac999e931bd7a946ba7db7b568a41150867aa78ff8c/planet-2.6.tar.gz",
"platform": null,
"description": "# Planet SDK for Python\n\n[![Build Status](https://github.com/planetlabs/planet-client-python/actions/workflows/test.yml/badge.svg)](https://github.com/planetlabs/planet-client-python/actions/workflows/test.yml)\n\nThe [Planet](https://planet.com) Software Development Kit (SDK) for Python\nprovides both a Python API and a command-line interface (CLI)\nto make use of [the Planet APIs](https://developers.planet.com/docs/apis/).\nEverything you need to get started is found in our \n[online documentation](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/).\n\nVersion 2.0 includes support for the core workflows of the following APIs:\n\n* [Data](https://developers.planet.com/docs/data/) - Search for imagery from Planet's data catalog.\n* [Orders](https://developers.planet.com/docs/orders/) - Process and download or deliver imagery.\n* [Subscriptions](https://developers.planet.com/docs/subscriptions/) - Set up a search to auto-process and deliver imagery.\n\nAfter the initial 2.0 release there will be additional work to support the \nremaining Planet APIs: [basemaps](https://developers.planet.com/docs/basemaps/),\n[tasking](https://developers.planet.com/docs/tasking/)) and \n[analytics](https://developers.planet.com/docs/analytics/).\n\n## Versions and Stability\n\nThe default branch (main) of this repo is for the [Planet SDK for \nPython](https://github.com/planetlabs/planet-client-python/projects/2),\na complete rewrite and upgrade from the original [Planet Python \nClient](https://developers.planet.com/docs/pythonclient/). If you \nare looking for the source code to that library see the \n[v1](https://github.com/planetlabs/planet-client-python/tree/v1) branch.\n\nThe Planet SDK for Python is in 'pre-release' stages, working towards a solid\nbeta release in December. Upcoming milestones are tracked in the [Planet SDK \nfor Python Milestones](https://github.com/planetlabs/planet-client-python/milestones). \n\n## Installation and Quick Start\n\nThe main installation path and first steps are found in the \n[Quick Start Guide](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/quick-start-guide/)\nof the documentation.\n\n### Installing from source\n\nThis option enables you to get all the latest changes, but things might also be a bit less stable.\nTo install you must [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)\nthe [planet-client-python](https://github.com/planetlabs/planet-client-python) repository \nto your local computer. After you have the repo local just navigate to the root\ndirectory, where this readme lives.\n\nThen you can install locally with pip:\n\n```console\n$ pip install . \n```\n\n## Documentation\n\nDocumentation is currently [hosted online](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/)\nIt should be considered 'in progress', with many updates to come. It can also\nbe built and hosted locally (see [CONTRIBUTING.md](CONTRIBUTING.md)) or can be \nread from source in the [docs](/docs) directory.\n\n## Authentication\n\nPlanet's APIs require an account for use. To get started you need to \n[Get a Planet Account](https://planet-sdk-for-python-v2.readthedocs.io/en/latest/get-started/get-your-planet-account/).\n\n## Development\n\nTo contribute or develop with this library, see\n[CONTRIBUTING.md](CONTRIBUTING.md).\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Planet SDK for Python",
"version": "2.6",
"project_urls": {
"Homepage": "https://github.com/planetlabs/planet-client-python"
},
"split_keywords": [
"planet",
"api",
"sdk",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf922a642cc8fa350ae111b390b4afb371c85da8d3f7eded28acb3cf2bca083c",
"md5": "90752e69a1201afc0fe08160b44e1060",
"sha256": "af647145f229f9b6a84288d894e1becf6d1eb8d19f517fc283e5eee571f93971"
},
"downloads": -1,
"filename": "planet-2.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90752e69a1201afc0fe08160b44e1060",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 80873,
"upload_time": "2024-04-24T17:24:25",
"upload_time_iso_8601": "2024-04-24T17:24:25.032532Z",
"url": "https://files.pythonhosted.org/packages/cf/92/2a642cc8fa350ae111b390b4afb371c85da8d3f7eded28acb3cf2bca083c/planet-2.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de07073bfc48e65e13e32ac999e931bd7a946ba7db7b568a41150867aa78ff8c",
"md5": "55b4d680996710d433da473b6cd2d998",
"sha256": "caaaa5ee23c5e5fd7ada2906bcc5997516f418b2cf5a2faa739108a37cd3f49b"
},
"downloads": -1,
"filename": "planet-2.6.tar.gz",
"has_sig": false,
"md5_digest": "55b4d680996710d433da473b6cd2d998",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60865,
"upload_time": "2024-04-24T17:24:26",
"upload_time_iso_8601": "2024-04-24T17:24:26.932411Z",
"url": "https://files.pythonhosted.org/packages/de/07/073bfc48e65e13e32ac999e931bd7a946ba7db7b568a41150867aa78ff8c/planet-2.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 17:24:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "planetlabs",
"github_project": "planet-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "planet"
}