v2: add cli for orders api #284
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ation is provided
…eate orders returns order json, clean up tests
This was
linked to
issues
Jun 15, 2021
sarasafavi
reviewed
Jul 14, 2021
There was a problem hiding this comment.
very minor fix request re: planet.geojson -- otherwise this LGTM! And it works on my box, too :-D
Really great work @jreiberkyle I am SO EXCITED to see this happening!
planet/geojson.py
Outdated
| raise GeoJSONException('Invalid GeoJSON: {data}') | ||
|
|
||
| if len(features) > 1: | ||
| LOGGER.warning( |
There was a problem hiding this comment.
Do you mean to raise DataLossWarning here?
There was a problem hiding this comment.
thank you for bringing this up and for our offline discussion. I'll raise an exception when multiple features are given.
|
|
||
| class DataLossWarning(UserWarning): | ||
| """Warn that data will be lost.""" | ||
|
|
There was a problem hiding this comment.
for consistency add the pass no-op here too
| geom_geojson['coordinates'] = [] | ||
| _ = geojson.validate_geom(geom_geojson) | ||
|
|
||
|
|
There was a problem hiding this comment.
let's test_validate_geom_multiple_features (or whatever) here too :)
…multiple features
|
thank you so much @sarasafavi for the in-depth review. changes made, merging now. YASSS!! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a CLI as a thin wrapper around the python api orders client. Functionality was added to the orders client and other modules to support back-compatible CLI functionality while keeping the CLI thin.
One addition to the API is implemented:
Simple management of geojson, via the new
planet/geojson.pymoduleTwo changes to the python API are implemented:
OrdersClient.create_order()now returns the entire order description (as returned by the API) instead of just the id.This aligns with the rule of "make the client as similar to the REST API as possible" and allows the cli to easily report the details as a json blob that can be processed or viewed via the command line.
Delivery.from_dict()tries to create a subclass if possible.For example, if the dict describes an
AmazonS3Delivery, it makes an instance of that class. This is necessary because aDeliveryonly holds the minimum delivery information while a subclass holds more information about the specific cloud. This change allows the cli to just callDelivery.from_dict()while parsing a file and have the proper information passed intoOrdersClient.create_order().Other than that, the API changes are improved error handling.
Wish list: The cli.py module got huge quick. I would like to break it up into different modules based on api (e.g.
authandorders). Ticket #288Closes #244
Closes #252