Skip to content

Releases: planetlabs/planet-client-python

2.0.0-rc.1

06 Mar 19:16
Compare
Choose a tag to compare
2.0.0-rc.1 Pre-release
Pre-release

2.0.0-rc.1 (2023-03-06)

User Interface Changes:

  • Stdin is no longer the default for CLI arguments/options that read from
    stdin, string, or filename. To specify stdin, use -.
  • planet data filter cli command outputs empty filter by default, helpers must
    be specified with flags.

Changed:

  • Connect retries wait time adjusted from 1sec to just shy of 1sec to
    optimize distribution

Added:

  • Data CLI commands: asset-get, asset-download, asset-activate, asset-wait,
    search-run, search-list, search-update, search-delete
  • Add AssetStatusBar reporter, use in data asset-wait cli command
  • Add subscription request helper methods in python api
  • Add planet subscriptions request CLI command
  • Add support for base_url in subscriptions client
  • Add support for MultiPolygon in orders clip tool

Fixed:

  • Remove null printout from CLI subscriptions cancel command
  • Update session_configuration.py to latest api

2.0.0-beta.1

08 Dec 22:35
Compare
Choose a tag to compare
2.0.0-beta.1 Pre-release
Pre-release

Changed:

  • Auth.write() renamed to Auth.store() to match CLI command
  • CLI now only sources from the configuration file
  • the following functions were changed to generator functions and therefore no
    longer require awaits: OrdersClient.list_orders, DataClient.search,
    DataClient.run_search, SubscriptionsClient.list_results,
    SubscriptionsClient.list_subscriptions
  • CLI command planet orders request arguments have changed so only IDs is positional, all others are flags

Added:

  • support for Sentinel-2 as a target in the harmonization tool in
    orders_request
  • planet auth store CLI command for storing authentication info
    in the configuration file

Fixed:

  • status option for list_subscriptions now works
  • subscriptions list_results now returns more than the first page

2.0a6

10 Nov 20:00
Compare
Choose a tag to compare
2.0a6 Pre-release
Pre-release
  • Add SDK identification headers to communication with servers (#754).
  • Add new example (example subfolder): Downloading multiple assets in
    parallel (#722).

2.0a5

20 Oct 21:14
Compare
Choose a tag to compare
2.0a5 Pre-release
Pre-release
  • Implement python api data client asset download and supporting functions (#707).
  • planet data filter cli command outputs a valid empty filter if all
    subfilters are removed (#654).
  • 'planet orders request' cli command now provides supported bundles for a
    given item type, bundle and item type are case-insensitive, and bundle and
    item type are moved to positional arguments (#680).

2.0a3

07 Sep 16:33
Compare
Choose a tag to compare
2.0a3 Pre-release
Pre-release

This pre-release fixes a major Subscriptions bug and a regression introduced in 2.0a2.

Changes:

  • A change in behavior of httpx affected download of order assets in 2.0a2. We're working around this change in behavior (#685).
  • Subscriptions API methods communicating with particular subscription endpoints (cancel_subscription, update_subscription, get_subscription, and get_results) were broken due to missing 'f' prefixes (#687). The prefixes have been added.
  • STAC metadata can now be added to Orders requests (#676).
  • More help and better error messages around bundles and asset types have been added to the Orders API (#650, #675).
  • Help for planet-subscriptions-describe and update commands has been corrected, resolving the issue reported in #658.

1.5.2

01 Sep 19:09
Compare
Choose a tag to compare

Bug fixes:

  • Require requests-futures<1.0 as in version 1.4.9. Version 1.0.0 of requests-futures breaks order downloads for an unknown reason.

2.0a2

04 Aug 22:55
3c4af25
Compare
Choose a tag to compare
2.0a2 Pre-release
Pre-release
  • Upgrade httpx to 0.23, change how quota exceptions are caught
  • Increase reliability of communication with Planet servers and avoid clobbering them
  • Add CLI data stats
  • CLI search-quick -> search, API quick-search -> search
  • limit option: remove None as a possibility, value of zero means no limit
  • fix sort param field
  • add sort option to planet data search-quick

1.5.1

28 Jul 21:15
Compare
Choose a tag to compare
  • Fix: execution of the v1 CLI now prints a more clear, yellow colored warning message aimed at CLI users. A more detailed version of the same warning is also printed in the planet commands usage message (#652).
  • Fix: the deprecation warning emitted on import of planet.api now uses stacklevel=2 and thus points at the module which imports planet.api (#652).

1.5.0

29 Jun 21:40
Compare
Choose a tag to compare

Work on new features for version 1 of this software has ceased. Version 2 is under development and the final 2.0.0 release is expected at the end of 2022. There will not be a 1.6.0 release. Releases in the 1.5.x series will be made to fix major bugs on a quarterly cadence. There may be one such bug fix release for version 1 after 2.0.0 is released, but probably not more. Packages for planet versions < 2 will remain on the Python Package Index indefinitely.

Version 2 will be packaged as "planet" and its command line programs will also use the name "planet". Thus it will replace version 1. Version 2 will not be backwards compatible with version 1. That is to say that applications which depend on version 1 will not work with version 2. This goes for the command line programs as well. Version 2's "planet orders", for example, has usage changes that will likely have an impact on scripts written for version 1.

Users of version 1 who do not wish to upgrade to version 2 should ensure that their project requirements specify "planet<2", because when 2.0.0 is published to the Python Package Index pip install planet (for example) will download and install 2.0.0.

A 2.0a1 pre-release is available now on PyPI. The Python package installer pip requires that you opt in to pre-releases by executing
pip install --pre planet or be specifying the pre-release version precisely as in pip install planet==2.0a1.

All that said, we want migration to 2.0.0 to be a win for users. Early feedback on the new Python API and CLI are critical to making it so. How can we support your existing workflows and systems while providing new features and more powerful abstractions? Please send the Planet Dev Rel email at developers@planet.com or join one of the project discussions on GitHub. You can have a say on what 2.0.0 looks like. We're eager to hear from you.

Deprecations:

Importing the planet.api module from version 1.5.x will result in a warning about the removal of planet.api in version 2.0.0. Running any command line program from version 1.5.x will show the same warning.

2.0a1

28 Jun 21:56
Compare
Choose a tag to compare
2.0a1 Pre-release
Pre-release

This is the first pre-release of the new features and interfaces coming in version 2.0.0 later this year. A more complete listing of changes in this package is coming soon. The highlights are

  • Requirement of Python version 3.7 or newer.
  • Support for Planet Data, Orders, and Subscription APIs.
  • A Python package (the SDK) with asyncio support.
  • A new and improved command line interface (the CLI).