Metadata-Version: 2.1
Name: planet
Version: 1.5.1
Summary: Planet API Client
Home-page: https://github.com/planetlabs/planet-client-python
Author: Ian Schneider
Maintainer: Planet Dev Rel Team
Maintainer-email: developers@planet.com
License: Apache 2.0
Keywords: planet api client
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
License-File: LICENSE
Requires-Dist: click
Requires-Dist: requests
Requires-Dist: requests-futures
Requires-Dist: pywin32 (>=1.0) ; platform_system == "Windows"
Provides-Extra: dev
Requires-Dist: mock ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytz ; extra == 'dev'
Requires-Dist: requests-mock ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: setuptools ; extra == 'dev'
Requires-Dist: pex ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: jinja2 (<3.1) ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: test
Requires-Dist: mock ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytz ; extra == 'test'
Requires-Dist: requests-mock ; extra == 'test'
Requires-Dist: tox ; extra == 'test'

=================
Planet API Client
=================

.. attention:: Work on version 1 has ended. Version 2 is in development.
   See CHANGES.txt for more information.

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

.. image:: https://github.com/planetlabs/planet-client-python/actions/workflows/tests.yaml/badge.svg?branch=master
   :target: https://github.com/planetlabs/planet-client-python/actions
   :alt: CI for v1


Installation
------------

Via pip:

.. code-block:: console

    $ pip install planet

The `--user <https://pip.pypa.io/en/stable/user_guide/#user-installs>`__
flag is highly recommended for those new to `pip <https://pip.pypa.io>`__.

A PEX executable (Windows not supported) and source releases are
`here <https://github.com/planetlabs/planet-client-python/releases/latest>`__.


Documentation
-------------

Online documentation: `https://planetlabs.github.io/planet-client-python/index.html <https://planetlabs.github.io/planet-client-python/index.html>`__

Documentation is also provided for download `here <https://github.com/planetlabs/planet-client-python/releases/latest>`__.


Development
-----------

To develop with or use the library in your own projects, see the `wiki <https://github.com/planetlabs/planet-client-python/wiki>`__.


API Key
-------

The API requires an account for use. `Signup here <https://www.planet.com/explorer/?signup>`__.

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 <https://developers.planet.com/docs/apis/data/>`__ ::

    planet data

OR specific command help::

    planet data download --help
