# Changes.txt

1.5.0 (2022-06-29)

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 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 the project discussions at
https://github.com/planetlabs/planet-client-python/discussions. You can have a
say on what 2.0.0 looks like. We're eager to hear from you.

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.

1.4.10 (2022-05-18)

- Fix: restore compatibility with click versions >= 8.1.0.
- Fix: handle FeedSource array in analytics API.

1.4.9 (2021-12-07)

- New: analytic_8b_udm2 asset
- New: basic_analytic_8b_udm2 asset
- New: analytic_8b_sr_udm2 asset
- New: analytic_3b_udm2 asset
- Add support for 8-band asset types
- Add support for 3-band UDM2 asset type

1.4.8 (2021-11-30)

- New: ortho_analytic_3b asset
- Fix: broken links in documentation & readme
- New: requests now use custom `X-Planet-App` client header for tracking

1.4.7 (2021-06-30)

- New: basic_l1_all_frames asset 
- New: PSSCene 8-band assets & item type
- New: ortho_analytic_sr asset
- Fix: Raise NoPermission exception when the user does not have download access
- Fix: force zip of entire order via cli and create test of download
- Fix: fixed orders model object with next key, Fix #226

1.4.6 (2020-05-18)

- New: you can now pass a search string to the Orders CLI via `--ids_from_search`
- New: the Orders CLI now has a shortcut `--clip` for clipping operations
- Fix: you can now download Order locations one by one
- Multiple test fixes: Python 2.7 tests, flake8, & make html-docs warning
- Add support for new 5-band asset types

1.4.5 (2020-02-11)

 - Add support for new skysat video item and asset types
 - Add `strict` keyword argument to searches

1.4.4 (2019-12-17)

- Pin requests-futures version to avoid error message.
- Fix broke jq parsing for regular data search
- Under certain conditions the response body can get printed more than once

1.4.3 (2019-11-14)

- Updating copyright date for modified files
- Removing monkey patch
- Make sure base_url has a trailing /
- Simplified configuration of analytics client to be consistent

1.4.2 (2019-10-04)

- added new asset type

1.4.1 (2019-09-17)

- fix quick search regression: allow multiple item types as options in quick search again

1.4.0 (2019-09-16)

- Add CLI support for Planet Orders API

1.3.2 (2019-08-27)

- add new skysat asset types

1.3.1 (2019-07-19)
-------------------------------------
- report the default value for item limit
- replace hardcoded values with global variables
- add header for data examples in Examples page
- adding before, after options, separating `features list` from `features
- Added default limit of 100 to `analytics collections features list`
- Added separate `analytics collections features list-all` that will keep retrieving results with no limit
- Added before, after options to both `analytics collections features list` and `analytics collections features list-all`

1.3.0 (2019-07-10)
-------------------------------------
- Added support for Analytic Feeds
- Fixing incorrect shorthand CLI arg
- Add comment to explain why the get resource entrypoint won't work in AF next.
- unit tests for analytics commands
- Adding auto-pagination for analytics commands
- Add additional mosaics entrypoints to list mosaics for a series, as well mosaics for AF resources
- Separate out analytics configuration to allow for using analytics alongside mosaics, even in AF next

1.2.4 (2019-06-27)
-------------------------------------
- Add new UDM2 and related asset types

1.2.3 (2019-06-11)
-------------------------------------
- Authenticate item and asset type calls from CLI
- Update tox config to remove obsolete Python 3 versions and allow pytest args
- mimetypes.guess_extension() returns either .tif or .tiff - test accordingly
- Let date_range filter handle dates given with and without timezones
- Update copyright date
- Update Planet address
- Limit arg is required for items_iter()
- Add pywin32 dep for windows platforms
- Flake8 fixes
- Fix improper handling of mixed states when activating multiple assets with Downloader.
- Force TravisCI to upgrade pytest to avoid conflicts
- Add new item types to CLI tool in order to match API's item-types endpoint.
- Don't let final report get swallowed up with ANSI output
- Output the same report for all downloads via CLI

1.2.2 (2019-03-04)
-------------------------------------
- Use requests' urlparse for Py2 & Py3 compatibility
- Prevent empty filenames when attempting to download assets without a Content-Disposition header
- Add more Python 3.7 support by removing keywords
- Rename --rbox to --bbox and leave --bbox as an alias for backwards compatibility
- De-duplicate explicit jq hyperlink (avoids sphinx warning)
- Add examples of mosaic functionality
- Update CLI command help info for mosaic functionality
- Add LICENSE explicitly to setup.py so that pex can find it

1.2.1 (2018-11-08)
-------------------------------------
- Set login headers as content-type:application/json during planet init

1.2.0 (2018-10-10)
-------------------------------------
- Added support for mosaics
- Unpinned setuptools
- Upgraded setuptools and pip
- Built universal wheels
- Implemented filter combining in the CLI
- Fixed flake8 violations, mostly trivial
- Added sentinel1 item type
- Added SR & skysat asset types to defaults
- Added tox config for testing against multiple Python versions
- Regenerated docs

1.1.0 (2017-09-15)
-------------------------------------
- update docs to use cloud_cover as field_name
- move version and update user agent with client name and version
- fix cli reference doc generation, flags have dash
- Support new assets as they become available in the API without changes needed to the client

1.0.1 (2017-08-22)
-------------------------------------
- update the doc strings with defaults
- update allowed item/asset types for skysat
- date_range improvements, handle Z suffix in strp_lenient

1.0.0 (2017-04-01) Code name: no-joke
-------------------------------------
- Remove V0 API support
- Initial V1 Data API support

0.0.6 (2016-02-17)
------------------
- Support for 'aoi_id' (saved geometry) queries in 'search' command
- More robust handling of potential download failures

0.0.5 (2015-12-01)
------------------
- Support RapidEye in CLI
- Fix examples in README
- Fix duplicate example in doc

0.0.4 (2015-09-23)
------------------
- Some API fixes related to trailing slashes
- Documentation refresh
- Area search for mosaic quads
- Use workspace id for search
- Editing workspace filters on CLI
- More products for sync tool
- Fix out of sync issue in sync tool
- Delete discarded temp files in atomic file handling
- Cancellation of async processes

0.0.3 (2015-08-25)
------------------
- Resolve extraneous 'None' appearing in CLI usage
- Documentation reworking
- Check for destination directory existence
- Some AOI validity checking for WKT/GeoJSON
- Paging improvements + support in CLI search results
- Mosaic/quads support
- Atomic file writing
- Pretty print by default when attached to terminal output
- Initial workspace support

0.0.2 (2015-08-05)
------------------
- Add init command for fetching and storing key
- Paging fixes for search/metadata
- Fix bad redirect handling related to API change
- Use published field, not acquired field for syncing

0.0.1 (2015-07-17)
------------------
- Initial release
