diff --git a/tests/snippets/subscriptions_api.py b/tests/snippets/subscriptions_api.py new file mode 100644 index 00000000..a331692e --- /dev/null +++ b/tests/snippets/subscriptions_api.py @@ -0,0 +1,116 @@ +# Copyright 2023 Planet Labs PBC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. You may obtain a copy of +# the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +"""Example of creating and downloading multiple orders. + +This is an example of submitting two orders, waiting for them to complete, and +downloading them. The orders each clip a set of images to a specific area of +interest (AOI), so they cannot be combined into one order. + +[Planet Explorer](https://www.planet.com/explorer/) was used to define +the AOIs and get the image ids. +""" +import planet +from datetime import datetime +from planet.subscription_request import (build_request, + catalog_source, + amazon_s3, + harmonize_tool) + + +def create_request(): + '''Create a subscription request.''' + + # Area of interest for the subscription + geom = { + "coordinates": + [[[139.5648193359375, + 35.42374884923695], [140.1031494140625, 35.42374884923695], + [140.1031494140625, + 35.77102915686019], [139.5648193359375, 35.77102915686019], + [139.5648193359375, 35.42374884923695]]], + "type": + "Polygon" + } + source = catalog_source(item_types=["PSScene"], + asset_types=["ortho_analytic_4b"], + geometry=geom, + start_time=datetime(2021, 3, 1)) + delivery = amazon_s3(aws_access_key_id="ACCESS-KEY-ID", + aws_secret_access_key="SECRET_ACCESS_KEY", + bucket="test_bucket", + aws_region="us-east-1") + tools = harmonize_tool(target_sensor="Sentinel-2") + + # Build your subscriptions request + subscription_request = build_request(name='test_subscription', + source=source, + delivery=delivery, + tools=tools) + return subscription_request + + +# list_subscriptions +async def list_subscriptions(status, limit): + '''Code snippet for list_subscriptions.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + async for sub in client.list_subscriptions(status=status, limit=limit): + return sub + + +# create_subscription +async def create_subscription(request): + '''Code snippet for create_subscription.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + sub = await client.create_subscription(request=request) + return sub + + +# cancel_subscription +async def cancel_subscription(subscription_id): + '''Code snippet for cancel_subscription.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + _ = await client.cancel_subscription(subscription_id=subscription_id) + + +# update_subscription +async def update_subscription(subscription_id, request): + '''Code snippet for update_subscription.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + sub = await client.update_subscription(subscription_id=subscription_id, + request=request) + return sub + + +# get_subscription +async def get_subscription(subscription_id): + '''Code snippet for get_subscription.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + sub = await client.get_subscription(subscription_id=subscription_id) + return sub + + +# get_results +async def get_results(subscription_id, status, limit): + '''Code snippet for get_results.''' + async with planet.Session() as sess: + client = sess.client('subscriptions') + async for result in client.get_results(subscription_id=subscription_id, + status=status, + limit=limit): + return result diff --git a/tests/snippets/test_data_api_snippets.py b/tests/snippets/test_data_api_snippets.py new file mode 100644 index 00000000..5012888d --- /dev/null +++ b/tests/snippets/test_data_api_snippets.py @@ -0,0 +1,284 @@ +# Copyright 2023 Planet Labs PBC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. You may obtain a copy of +# the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +"""Example of creating and downloading multiple orders. + +This is an example of submitting two orders, waiting for them to complete, and +downloading them. The orders each clip a set of images to a specific area of +interest (AOI), so they cannot be combined into one order. + +[Planet Explorer](https://www.planet.com/explorer/) was used to define +the AOIs and get the image ids. +""" +import planet +from planet import data_filter +import json +from datetime import datetime +import pytest +import os + + +@pytest.fixture +def search_filter(get_test_file_json): + filename = 'data_search_filter_2022-01.json' + return get_test_file_json(filename) + + +@pytest.mark.anyio +async def test_snippet_data_search(search_filter): + '''Code snippet for search.''' + # --8<-- [start:search] + async with planet.Session() as sess: + client = sess.client('data') + items_list = [ + item async for item in client.search(['PSScene'], + search_filter=search_filter, + name="My Search", + sort="acquired asc", + limit=2) + ] + # --8<-- [end:search] + assert len(items_list) == 2 + + +@pytest.mark.anyio +async def test_snippet_data_create_search(search_filter): + '''Code snippet for create_search.''' + # --8<-- [start:create_search] + async with planet.Session() as sess: + client = sess.client('data') + response = await client.create_search(item_types=['PSScene'], + search_filter=search_filter, + name="My Search") + # --8<-- [end:create_search] + assert 'PSScene' in response['item_types'] + return response + + +@pytest.mark.anyio +async def test_snippet_data_update_search(search_filter): + '''Code snippet for update_search.''' + # --8<-- [start:update_search] + async with planet.Session() as sess: + client = sess.client('data') + response = await client.update_search( + search_id='66722b2c8d184d4f9fb8b8fcf9d1a08c', + item_types=['PSScene'], + search_filter=search_filter, + name="My Search") + # --8<-- [end:update_search] + assert ['PSScene'] not in response['item_types'] + assert '66722b2c8d184d4f9fb8b8fcf9d1a08c' in response['id'] + # TO DO: use a mocked search_id + + +@pytest.mark.anyio +async def test_snippet_data_list_searches(): + '''Code snippet for list_searches.''' + # --8<-- [start:list_searches] + async with planet.Session() as sess: + client = sess.client('data') + search_list = [ + item async for item in client.list_searches( + sort='created asc', search_type="saved", limit=2) + ] + # --8<-- [end:list_searches] + assert len(search_list) == 2 + # Verifying sort='created asc' + parsed_search_list = [ + datetime.strptime(search['created'], '%Y-%m-%dT%H:%M:%S.%fZ') + for search in search_list + ] + assert sorted(parsed_search_list) == parsed_search_list + + +@pytest.mark.anyio +async def test_snippet_data_delete_search(search_filter): + '''Code snippet for delete_search.''' + new_search = await test_snippet_data_create_search(search_filter) + search_id = new_search['id'] + # --8<-- [start:delete_search] + async with planet.Session() as sess: + client = sess.client('data') + await client.delete_search(search_id=search_id) + # --8<-- [end:delete_search] + search_list = [ + item async for item in client.list_searches( + sort='created asc', search_type="saved", limit=2) + ] + assert search_id not in [search['id'] for search in search_list] + + +@pytest.mark.anyio +async def test_snippet_data_get_search(search_filter): + '''Code snippet for get_search.''' + new_search = await test_snippet_data_create_search(search_filter) + search_id = new_search['id'] + # --8<-- [start:get_search] + async with planet.Session() as sess: + client = sess.client('data') + search = await client.get_search(search_id=search_id) + # --8<-- [start:get_search] + assert len(search) == 10 + assert search['id'] == search_id + + +@pytest.mark.anyio +async def test_snippet_data_run_search(search_filter): + '''Code snippet for run_search.''' + new_search = await test_snippet_data_create_search(search_filter) + search_id = new_search['id'] + # --8<-- [start:run_search] + async with planet.Session() as sess: + client = sess.client('data') + items_list = [ + i async for i in client.run_search(search_id=search_id, limit=2) + ] + # --8<-- [end:run_search] + assert len(items_list) == 2 + + +@pytest.mark.anyio +async def test_snippet_data_get_stats(search_filter): + '''Code snippet for get_stats.''' + # --8<-- [start:get_stats] + async with planet.Session() as sess: + client = sess.client('data') + stats = await client.get_stats(item_types=['PSScene'], + search_filter=search_filter, + interval="month") + # --8<-- [end:get_stats] + assert stats['interval'] == 'month' + assert len(stats['buckets']) != 0 + + +@pytest.mark.anyio +async def test_snippet_data_list_item_assets(): + '''Code snippet for list_item_assets.''' + # --8<-- [start:list_item_assets] + async with planet.Session() as sess: + client = sess.client('data') + assets = await client.list_item_assets( + item_type_id='PSScene', item_id='20221003_002705_38_2461') + # --8<-- [end:list_item_assets] + assert len(assets) == 14 + + +@pytest.mark.anyio +async def test_snippet_data_get_asset(): + '''Code snippet for get_asset.''' + # --8<-- [start:get_asset] + async with planet.Session() as sess: + client = sess.client('data') + asset = await client.get_asset(item_type_id='PSScene', + item_id='20221003_002705_38_2461', + asset_type_id='basic_udm2') + # --8<-- [end:get_asset] + assert asset['type'] == 'basic_udm2' + + +@pytest.mark.anyio +async def test_snippet_data_activate_asset(): + '''Code snippet for activate_asset.''' + # --8<-- [start:activate_asset] + async with planet.Session() as sess: + client = sess.client('data') + asset = await client.get_asset(item_type_id='PSScene', + item_id='20221003_002705_38_2461', + asset_type_id='basic_udm2') + await client.activate_asset(asset) + # --8<-- [end:activate_asset] + assert asset['status'] == 'active' + + +@pytest.mark.anyio +async def test_snippet_data_wait_asset(): + '''Code snippet for wait_asset.''' + # --8<-- [start:wait_asset] + async with planet.Session() as sess: + client = sess.client('data') + asset = await client.get_asset(item_type_id='PSScene', + item_id='20221003_002705_38_2461', + asset_type_id='basic_udm2') + _ = await client.wait_asset(asset, callback=print) + # --8<-- [end:wait_asset] + assert asset['status'] == 'active' + + +@pytest.mark.anyio +async def test_snippet_data_download_asset_without_checksum(): + '''Code snippet for download_asset without a checksum.''' + # --8<-- [start:download_asset_without_checksum] + async with planet.Session() as sess: + client = sess.client('data') + asset = await client.get_asset(item_type_id='PSScene', + item_id='20221003_002705_38_2461', + asset_type_id='basic_udm2') + path = await client.download_asset(asset=asset) + # --8<-- [end:download_asset_without_checksum] + assert path.exists() + os.remove(path) + + +@pytest.mark.anyio +async def test_snippet_data_download_asset_with_checksum(): + '''Code snippet for download_asset with a checksum.''' + # --8<-- [start:download_asset_with_checksum] + async with planet.Session() as sess: + client = sess.client('data') + asset = await client.get_asset(item_type_id='PSScene', + item_id='20221003_002705_38_2461', + asset_type_id='basic_udm2') + path = await client.download_asset(asset=asset) + client.validate_checksum(asset, path) + # --8<-- [end:download_asset_with_checksum] + assert path.exists() + os.remove(path) + + +# Create search filters +def create_search_filter(): + '''Create a search filter.''' + + # Geometry you wish to clip to + with open("aoi.geojson") as f: + geom = json.loads(f.read()) + + # Build your filters with all types of requirements + date_range_filter = data_filter.date_range_filter("acquired", + gte=datetime(month=1, + day=1, + year=2017), + lte=datetime(month=1, + day=1, + year=2018)) + clear_percent_filter = data_filter.range_filter('clear_percent', 90) + cloud_cover_filter = data_filter.range_filter('cloud_cover', None, 0.1) + geom_filter = data_filter.geometry_filter(geom) + asset_filter = data_filter.asset_filter( + ["basic_analytic_4b", "basic_udm2", "ortho_visual"]) + permission_filter = data_filter.permission_filter() + std_quality_filter = data_filter.std_quality_filter() + + # Search filter containing all filters listed above + search_filter = data_filter.and_filter([ + date_range_filter, + clear_percent_filter, + cloud_cover_filter, + geom_filter, + asset_filter, + permission_filter, + std_quality_filter + ]) + + return search_filter diff --git a/tests/snippets/test_orders_api_snippets.py b/tests/snippets/test_orders_api_snippets.py new file mode 100644 index 00000000..4e6553ed --- /dev/null +++ b/tests/snippets/test_orders_api_snippets.py @@ -0,0 +1,299 @@ +# Copyright 2023 Planet Labs PBC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. You may obtain a copy of +# the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. +"""Example of creating and downloading multiple orders. + +This is an example of submitting two orders, waiting for them to complete, and +downloading them. The orders each clip a set of images to a specific area of +interest (AOI), so they cannot be combined into one order. + +[Planet Explorer](https://www.planet.com/explorer/) was used to define +the AOIs and get the image ids. +""" +import shutil +import os +from pathlib import Path +import planet +import pytest + + +@pytest.fixture +def create_request(): + '''Create an order request.''' + + # The Orders API will be asked to mask, or clip, results to + # this area of interest. + aoi = { + "type": + "Polygon", + "coordinates": [[[-91.198465, 42.893071], [-91.121931, 42.893071], + [-91.121931, 42.946205], [-91.198465, 42.946205], + [-91.198465, 42.893071]]] + } + + # In practice, you will use a Data API search to find items, but + # for this example take them as given. + items = ['20200925_161029_69_2223', '20200925_161027_48_2223'] + + order = planet.order_request.build_request( + name='iowa_order', + products=[ + planet.order_request.product(item_ids=items, + product_bundle='analytic_udm2', + item_type='PSScene') + ], + tools=[planet.order_request.clip_tool(aoi=aoi)]) + + return order + + +@pytest.mark.anyio +def create_succesful_order(): + '''Code snippet for create_order.''' + order_details = { + "_links": { + "_self": + "https://api.planet.com/compute/ops/orders/v2/785185e1-8d02-469d-840e-475ec9888a17", + "results": + [{ + "delivery": "success", + "expires_at": "2023-07-12T22:58:47.877Z", + "location": + "https://api.planet.com/compute/ops/download/?token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODkyMDI3MjcsInN1YiI6IkdIWSszZHZhQ2VnUWYza2grVzZjbDllQmkzOG85VWdQMjhXL2lNY0tTYUxjblk1ZGR5d2phS05Jb0V1SFpUL2dOd1ErMFBDUlRtVWpRNTRCcWo2Wld3PT0iLCJ0b2tlbl90eXBlIjoiZG93bmxvYWQtYXNzZXQtc3RhY2siLCJhb2kiOiIiLCJhc3NldHMiOlt7Iml0ZW1fdHlwZSI6IiIsImFzc2V0X3R5cGUiOiIiLCJpdGVtX2lkIjoiIn1dLCJ1cmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vY29tcHV0ZS1vcmRlcnMtbGl2ZS83ODUxODVlMS04ZDAyLTQ2OWQtODQwZS00NzVlYzk4ODhhMTcvY29tcG9zaXRlLnRpZj9YLUdvb2ctQWxnb3JpdGhtPUdPT0c0LVJTQS1TSEEyNTZcdTAwMjZYLUdvb2ctQ3JlZGVudGlhbD1jb21wdXRlLWdjcy1zdmNhY2MlNDBwbGFuZXQtY29tcHV0ZS1wcm9kLmlhbS5nc2VydmljZWFjY291bnQuY29tJTJGMjAyMzA3MTElMkZhdXRvJTJGc3RvcmFnZSUyRmdvb2c0X3JlcXVlc3RcdTAwMjZYLUdvb2ctRGF0ZT0yMDIzMDcxMVQyMjU4NDdaXHUwMDI2WC1Hb29nLUV4cGlyZXM9ODYzOTlcdTAwMjZYLUdvb2ctU2lnbmF0dXJlPTA1NmI0MzAxYWI3MzUxNjU3MDU2NDQ0NTllYmU4OTJjZjRkNWM3YzE1ODAzNWQ0NmQwYzM0ODIyNjk0NjIyNDE3NmUwYTI2NWI3MGM1NTFkNzI1ZGM3MDI4NTk2MmI1NDY2MzljZGFjYzFiZWFlNDU5NTdlNzBmNzgwZmI5ODM4NGYyODE1NWQ2ZjhlMjQyZmNjZTNhOWRjMTA5MTQ2NmI0YmI3MDJmMGUyMjM5NzdiMmYxMDI0MDEzMzI2MDJlY2FkZTM5OThmMzZhYjZiYWNkYmI0ZmMyMTkxZjBkYmNhMTJkNmEyYmFiMTE2ZGQwMmI1YzdkYjQ3YWRjY2YwOWU3Y2FhNmI2MzNmY2M4MDExZDg1ZTI5YzA1NzI5OWI3MjA4YzdhZjQ5YjU0YThkYjkzMTk2MDA0MDkzMzM2NGUzZTRhOGUyODIwMGMxODVhNzlkZjU4NjQ2NGMxMTJjYWZmYmZmMDk5MThiY2E0ZTgxNTllYjk2Y2Y1MTQ2M2YyOTdmM2FhMjQ4NGY3ZDIyNjE0YzBmMjU5MWI5OTM4YjAwNzRjNmI3NWRmZDg2MDVlODliNjM2Njg5YmVlYWE0ZjBiYTcwOGI5OTdhYmU1MWI2NGYzM2QzMTRhMzlmM2E2ZjlhZjNlMzgwZGU4YmVjYzRiMzIwZTNiOTI5YTVlYzgzXHUwMDI2WC1Hb29nLVNpZ25lZEhlYWRlcnM9aG9zdCIsInNvdXJjZSI6Ik9yZGVycyBTZXJ2aWNlIn0.YJ2N1KwRg8YmiW2E3HRlSEyVlVMRK8LIsbdQfCeXWP32e9sYQKOshGCGNRMblmyYqARAq5YWfWyk99h7igT38w", + "name": "785185e1-8d02-469d-840e-475ec9888a17/composite.tif" + }, + { + "delivery": + "success", + "expires_at": + "2023-07-12T22:58:47.880Z", + "location": + "https://api.planet.com/compute/ops/download/?token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODkyMDI3MjcsInN1YiI6InNwdmpvY3NTd3Fsd2dMYTZUSndHdWlaM2NFNS9lbThta3pDNzdHRmNQamZkdDhSZHdOdEJFUU9YcjdUcDFMQWZKOFBvUTdQL2NkZVF4bXZpOW81TE1RPT0iLCJ0b2tlbl90eXBlIjoiZG93bmxvYWQtYXNzZXQtc3RhY2siLCJhb2kiOiIiLCJhc3NldHMiOlt7Iml0ZW1fdHlwZSI6IiIsImFzc2V0X3R5cGUiOiIiLCJpdGVtX2lkIjoiIn1dLCJ1cmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vY29tcHV0ZS1vcmRlcnMtbGl2ZS83ODUxODVlMS04ZDAyLTQ2OWQtODQwZS00NzVlYzk4ODhhMTcvY29tcG9zaXRlX21ldGFkYXRhLmpzb24_WC1Hb29nLUFsZ29yaXRobT1HT09HNC1SU0EtU0hBMjU2XHUwMDI2WC1Hb29nLUNyZWRlbnRpYWw9Y29tcHV0ZS1nY3Mtc3ZjYWNjJTQwcGxhbmV0LWNvbXB1dGUtcHJvZC5pYW0uZ3NlcnZpY2VhY2NvdW50LmNvbSUyRjIwMjMwNzExJTJGYXV0byUyRnN0b3JhZ2UlMkZnb29nNF9yZXF1ZXN0XHUwMDI2WC1Hb29nLURhdGU9MjAyMzA3MTFUMjI1ODQ3Wlx1MDAyNlgtR29vZy1FeHBpcmVzPTg2Mzk5XHUwMDI2WC1Hb29nLVNpZ25hdHVyZT00YmFiMGZiZjlmMTFjYzlhMjZiNDc4MDJkMzE2NzI2YTcyMjEwYWNhYzQ5OGY5NTE2YjU2NmY0MjMxZTllNTMxN2NjODY0OWY1Mzc3ODhkMzQwMThjMDlhNDc3MWUzMjczYTQyM2NlMGUwYzE2MTAxNTU0Zjg2ZDJiMTE0ZWNlMGQ3Nzk4YzVlZjA3YjY5ZjQ0ZGIxZjY5NTU5ZGEzMmJjM2Q4MDg3MDFlZjRkNmY0ZTVmYTE2M2UyNmJiODMxYjgwMGJiMTE4ZDI1ZjYzZTVmNTQxM2ZkZTBkMjU1ZDFhMGNhMjI4YzI1N2MwZmU3MDEzMTdkNTNlZjdmYWE5NmU0ZGIwZjkwMjQyNjc5M2ZkOWFmNzMyYjNkM2Q1ZWU1YzMzYWUwYjAyM2U0NDhlNDE4ZDhmZjA1YTdmNmFiZGE0Mjc3YzE0OWFjMmY3ZmNkYzZkMzZhMDNjNTJkNmU5NWE4MTA5MjlmYjFiYzBkMmNmYmIyMjc4OTM2YTQ3MWRkMmEyM2U4YjczZmE2ZmVkNTc3ZWUyNDE5OGE5YWUwNTMxZGY4MmE0ZDMzMjU0YWI5NDRmNjcxMTNjMmZkMzNlYzE4MzNlNjRmZTRhMmJjZTc1N2RiMzVhOTE5NTU2NWIzMGQ4MjYxZGYyN2VmMWVmZTVjYTYzYzlhYzU1ODRiY2QzYVx1MDAyNlgtR29vZy1TaWduZWRIZWFkZXJzPWhvc3QiLCJzb3VyY2UiOiJPcmRlcnMgU2VydmljZSJ9.66549P4DkJOlQ1SjTljrZMQQyeANoPNdVQRF4OMOiq0atiU9RX7iL7p-Ji2m6AWy7EKfZQm4Hn5F-Mn4-gL19Q", + "name": + "785185e1-8d02-469d-840e-475ec9888a17/composite_metadata.json" + }, + { + "delivery": + "success", + "expires_at": + "2023-07-12T22:58:47.883Z", + "location": + "https://api.planet.com/compute/ops/download/?token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODkyMDI3MjcsInN1YiI6IkhvejBKZTZDWm5jd1FFcVFpMWpadzdGREV3UzNoeE94Q1AyT0syUGxsZUV1cGZ3RXNmMFZwWjNobHV2R3ZWdkdsOXc1T2RpR25jRWNRN1NnZ29jWDZBPT0iLCJ0b2tlbl90eXBlIjoiZG93bmxvYWQtYXNzZXQtc3RhY2siLCJhb2kiOiIiLCJhc3NldHMiOlt7Iml0ZW1fdHlwZSI6IiIsImFzc2V0X3R5cGUiOiIiLCJpdGVtX2lkIjoiIn1dLCJ1cmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vY29tcHV0ZS1vcmRlcnMtbGl2ZS83ODUxODVlMS04ZDAyLTQ2OWQtODQwZS00NzVlYzk4ODhhMTcvMjAyMzA2MDNfMTgwMzI2XzU4XzI0YzVfbWV0YWRhdGEuanNvbj9YLUdvb2ctQWxnb3JpdGhtPUdPT0c0LVJTQS1TSEEyNTZcdTAwMjZYLUdvb2ctQ3JlZGVudGlhbD1jb21wdXRlLWdjcy1zdmNhY2MlNDBwbGFuZXQtY29tcHV0ZS1wcm9kLmlhbS5nc2VydmljZWFjY291bnQuY29tJTJGMjAyMzA3MTElMkZhdXRvJTJGc3RvcmFnZSUyRmdvb2c0X3JlcXVlc3RcdTAwMjZYLUdvb2ctRGF0ZT0yMDIzMDcxMVQyMjU4NDdaXHUwMDI2WC1Hb29nLUV4cGlyZXM9ODYzOTlcdTAwMjZYLUdvb2ctU2lnbmF0dXJlPTg0M2Q0NzlmNjc4OGMyYTJhZjM4ODYyZDc3MzE2NDhhNGIzODliNjI3YWQzZWU0ZGQxM2I5YzlmZjhmMzI0N2UwYmIyNmEzMDYwMzdkNzk0MDBjNzdlOGYxZGVmMzgzOTkzYjQ1ZGQwNzU0OTU0ZmYxMTg3ZTdkOWFhOTRhYzczY2YyZjZlZTk4YTZiMzc1YTk0MDU4NGE3YzdmNDY2YzE3MDhmMmQ5ZGY1YjgyY2ZiNmYyYzQ5N2ZhNDUyNzVmYmFlYmE0OWU0NjNhNWQ0ODRhZjYyYzZhMjJjNjE1YTQ4OTA3YTI4NjliMDdiYjE4NWY5NzUxODZhZThiMzBkMDg4ZjNmMjkxODViNjI0YzFiYzFiNDBhZWQxZDE0NmMwYmVlYWZiY2MyYWZjMzNlZDE3ZGRlNTJiNWVhYzMyZGRlYzcxNmIwY2IyYWY3OGRjZDRhYjNjZDM4YWIzYjU5ODM2MTcyYTVkZTcxNTExYjVlMGJkYTBiNjA4MTU3OTgzYmRjNGU1M2E1ODM4ODg0ZDM1MTZlYThlZWVjZWY4NDUzNjkzMWVmODZhMWU4NjYzZDU2NmM3OWYzZGNkN2FlYTQ5NmQ0OGY4YjFmZGZhNjFkNGViZGJmYTQ0NDU3NWRkZDlmOTQ1YmIyMzNlZjk1NDkxMDhiZTA3MWZkZmRjMDI1XHUwMDI2WC1Hb29nLVNpZ25lZEhlYWRlcnM9aG9zdCIsInNvdXJjZSI6Ik9yZGVycyBTZXJ2aWNlIn0.xhUXOMazIqybHKfI-Fyx6PshfwpzZGGheVuwyc38NmM8yKMVIOwF0vQ1_iCH920sBYuhWmF-_wlsfL5AnqJ-dA", + "name": + "785185e1-8d02-469d-840e-475ec9888a17/20230603_180326_58_24c5_metadata.json" + }, + { + "delivery": + "success", + "expires_at": + "2023-07-12T22:58:47.871Z", + "location": + "https://api.planet.com/compute/ops/download/?token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODkyMDI3MjcsInN1YiI6IkJTNTZOcCt4Z3JHek12U2FoU0N0Q0QrWnQ1Q2VySUVTVnY2YXFoQm1PNmRucFpPRlcrNWVvMEFZZldVQmlHVzI1OUdBV3U3SEp5Znhtb05yRWVVUW9nPT0iLCJ0b2tlbl90eXBlIjoiZG93bmxvYWQtYXNzZXQtc3RhY2siLCJhb2kiOiIiLCJhc3NldHMiOlt7Iml0ZW1fdHlwZSI6IiIsImFzc2V0X3R5cGUiOiIiLCJpdGVtX2lkIjoiIn1dLCJ1cmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vY29tcHV0ZS1vcmRlcnMtbGl2ZS83ODUxODVlMS04ZDAyLTQ2OWQtODQwZS00NzVlYzk4ODhhMTcvMjAyMzA2MDNfMTgwMzI4XzkxXzI0YzVfbWV0YWRhdGEuanNvbj9YLUdvb2ctQWxnb3JpdGhtPUdPT0c0LVJTQS1TSEEyNTZcdTAwMjZYLUdvb2ctQ3JlZGVudGlhbD1jb21wdXRlLWdjcy1zdmNhY2MlNDBwbGFuZXQtY29tcHV0ZS1wcm9kLmlhbS5nc2VydmljZWFjY291bnQuY29tJTJGMjAyMzA3MTElMkZhdXRvJTJGc3RvcmFnZSUyRmdvb2c0X3JlcXVlc3RcdTAwMjZYLUdvb2ctRGF0ZT0yMDIzMDcxMVQyMjU4NDdaXHUwMDI2WC1Hb29nLUV4cGlyZXM9ODYzOTlcdTAwMjZYLUdvb2ctU2lnbmF0dXJlPTJiYzI2ODZkYjVmY2ZkZTUxNzRkNzVlY2M2N2RhOTExMmRmMzkzNDI5NmVjNTM4ODg3YTUwZDRjZWNmNGQ5NDJkMWE2MTIxMzllNGU1ZWZmMTRjYzk4NWNmZDk0MzczZjhiY2YyYTRmM2RhMzdkYzBmNzdkY2M5MjQ2MTZlZmIyMDc2ZGUxNjVlM2JhZDE1MTUxMDNkNjM1OGRhZDY4M2M5MDBiMmM4NzRjYmNhYTAyN2Y2MmMzOWQ0Y2Y0ZTBlOTZjNTdhOGY4M2RhN2JmMjhiZTNmNzc2ZWNhMzcxZWYwYjQyMTYyOGJhNDIxMGExZTg5Zjk2YTI3ZTUxNWNkNzJiMmYxM2MyMGU3NWE5MWRjZjlkNDVhMjM0NjhjNzAzY2Q1NzdjZjJiZTc3ZTNmOWVlMDkyY2RiY2FjOTMxYzRmZjlhODFmMDczOWYwNDQ2YzMyMWNjMDBiYzY2NDc4MzE5Zjg5YWJhNTg0ZDI2NjMwZWVlMGFjYTA4YmY2NzA1MmQ0MDFhYzdlMzA5Njc3ZjE0YWYzYzk3YTA1NjMzMDdlYjhjOGIxZGM3Njc3NTFjMWQ5M2MwOGQ5NzFmNWFlZjFkMDZiNjNkZjIxOTc3MmQ3NWQ2ZGZkNmRiNjJlYTMxZjA5MjQ4YzEwNWRlNWVhODhiNzExYThmM2U4NWRkMGM0XHUwMDI2WC1Hb29nLVNpZ25lZEhlYWRlcnM9aG9zdCIsInNvdXJjZSI6Ik9yZGVycyBTZXJ2aWNlIn0.rAjq4q87lEfqp0qzMdW668yYRqrqI8bNRLkKMsDr851-c9xWdcB0BQ89M8ythVIpxJKAlhjnseRo_C1bK6tfnA", + "name": + "785185e1-8d02-469d-840e-475ec9888a17/20230603_180328_91_24c5_metadata.json" + }, + { + "delivery": "success", + "expires_at": "2023-07-12T22:58:47.874Z", + "location": + "https://api.planet.com/compute/ops/download/?token=eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODkyMDI3MjcsInN1YiI6IisvMktSQXBuM0tiWjY4dDh1cEx5c2hvTzB1VlhPZ2UwamNNZFA0Mnc4V3JEaUN0azZjaDBXakIrTkVwdUZGdzAxWFpKZnNqQ1BjcUtudGF2YnFZc0R3PT0iLCJ0b2tlbl90eXBlIjoiZG93bmxvYWQtYXNzZXQtc3RhY2siLCJhb2kiOiIiLCJhc3NldHMiOlt7Iml0ZW1fdHlwZSI6IiIsImFzc2V0X3R5cGUiOiIiLCJpdGVtX2lkIjoiIn1dLCJ1cmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vY29tcHV0ZS1vcmRlcnMtbGl2ZS83ODUxODVlMS04ZDAyLTQ2OWQtODQwZS00NzVlYzk4ODhhMTcvbWFuaWZlc3QuanNvbj9YLUdvb2ctQWxnb3JpdGhtPUdPT0c0LVJTQS1TSEEyNTZcdTAwMjZYLUdvb2ctQ3JlZGVudGlhbD1jb21wdXRlLWdjcy1zdmNhY2MlNDBwbGFuZXQtY29tcHV0ZS1wcm9kLmlhbS5nc2VydmljZWFjY291bnQuY29tJTJGMjAyMzA3MTElMkZhdXRvJTJGc3RvcmFnZSUyRmdvb2c0X3JlcXVlc3RcdTAwMjZYLUdvb2ctRGF0ZT0yMDIzMDcxMVQyMjU4NDdaXHUwMDI2WC1Hb29nLUV4cGlyZXM9ODYzOTlcdTAwMjZYLUdvb2ctU2lnbmF0dXJlPTc3NDUzYjFlYzAxMTVhMWQyODEzNWM0ZGRjZGVjOWE3ZmJjMDM0N2YwZTAzMDFkMWM4ZTgyNmVlMzA1YzUxMmRkNjBiMTMyMmZiOTE2ZmI2MzM3ZWJjZjFiYTBiNzkzNzY5MTRkNjI1ODEyYjE3YmYwNzljOTM4NTcxOTQ1YmRkNmVkMzZiMDVkOGMzMzk1NDgxZTliNDY1MDg3NmJjMzQwM2Y0Y2EwZDgxYTkxYjQwYjQxZDI1ODBmYmRjZDgyNmEyZTU2Y2ZiNWQ0ZGU4NDg0MmE3N2FjMzI4MThkYzA5MjQ3ZDc3YjU4MDg5ZjU2Y2MxNmNjMDQxOTc5NzYzZjQ5ZDU0YTY5MDgwZTEzZTM3ZWY5ZWU5NmU5NTIzMThmMDI2YjIwOWY2YTI5M2UyOGIxNDAyYTk4YmJmMzZiZDQxZmM1NjI0OWI1ODFjZjVkM2ZlZjJlMzYxOGMxYjY0NTVhOTJlZmJlODMyOWYyMGI4OGFmNmU3Y2YyYmM5NTRhNmQyZmNiNzg1NDY3ZGFlM2QwNDM4ZjQ0YTQzYzg3MmRiOWU0NWIzM2ZhMWUzZGZjMWVlNWNmZTE5ODk0ODJiYjNmNzQxMDhkNzlhZmFlMGZiNDIyNDVkYWM0MjJjNWRhZDg1MGVmODkxYmFiNGNjZTk3YTEzOTZkNDM3M2RiZDY0XHUwMDI2WC1Hb29nLVNpZ25lZEhlYWRlcnM9aG9zdCIsInNvdXJjZSI6Ik9yZGVycyBTZXJ2aWNlIn0.yc1ZrJeMuaqmsCJiSOhe14h1DJi5eB6SKPnMcN_kFTEPVg2lJCaMZE0cX9I8aL9LrWAcPgO_1Ui6aEAROPUl3A", + "name": "785185e1-8d02-469d-840e-475ec9888a17/manifest.json" + }] + }, + "created_on": + "2023-06-15T19:32:42.945Z", + "error_hints": [], + "id": + "785185e1-8d02-469d-840e-475ec9888a17", + "last_message": + "Manifest delivery completed", + "last_modified": + "2023-06-15T19:38:13.677Z", + "name": + "Composite CA Strip Visual Short", + "products": [{ + "item_ids": ["20230603_180326_58_24c5", "20230603_180328_91_24c5"], + "item_type": + "PSScene", + "product_bundle": + "visual" + }], + "state": + "success", + "tools": [{ + "composite": {} + }] + } + return order_details + + +@pytest.mark.anyio +async def test_snippet_orders_create_order(): + '''Code snippet for create_order.''' + order_request = { + "name": + "test", + "products": [{ + "item_ids": ['20230508_155304_44_2480'], + "item_type": "PSScene", + "product_bundle": "analytic_udm2" + }], + } + # --8<-- [start:create_order] + async with planet.Session() as sess: + client = sess.client('orders') + order = await client.create_order(request=order_request) + # --8<-- [end:create_order] + assert len(order['id']) > 0 + return order + + +@pytest.mark.anyio +async def test_snippet_orders_get_order(): + '''Code snippet for get_order.''' + order = await test_snippet_orders_create_order() + order_id = order['id'] + # --8<-- [start:get_order] + async with planet.Session() as sess: + client = sess.client('orders') + order = await client.get_order(order_id=order_id) + # --8<-- [end:get_order] + assert len(order['id']) > 0 + # TO DO: get order ID some other way + + +@pytest.mark.anyio +async def test_snippet_orders_cancel_order(): + '''Code snippet for cancel_order.''' + order = await test_snippet_orders_create_order() + order_id = order['id'] + # --8<-- [start:cancel_order] + async with planet.Session() as sess: + client = sess.client('orders') + order = await client.cancel_order(order_id=order_id) + # --8<-- [end:cancel_order] + # TO DO: get order ID some other way + assert order['state'] == 'cancelled' + + +@pytest.mark.anyio +async def test_snippets_cancel_multiple_orders(): + '''Code snippet for cancel_order.''' + order1 = await test_snippet_orders_create_order() + order2 = await test_snippet_orders_create_order() + order_id1 = order1['id'] + order_id2 = order2['id'] + # --8<-- [start:cancel_orders] + async with planet.Session() as sess: + client = sess.client('orders') + orders = await client.cancel_orders(order_ids=[order_id1, order_id2]) + # --8<-- [end:cancel_orders] + assert orders['result']['succeeded']['count'] == 2 + + +@pytest.mark.anyio +async def test_snippet_orders_aggregated_order_stats(): + '''Code snippet for aggregated_order_stats.''' + # --8<-- [start:aggregated_order_stats] + async with planet.Session() as sess: + client = sess.client('orders') + json_resp = await client.aggregated_order_stats() + # --8<-- [start:aggregated_order_stats] + assert 'organization' and 'user' in [key for key in json_resp.keys()] + + +@pytest.mark.anyio +async def test_snippet_orders_download_asset(): + '''Code snippet for download_asset.''' + order = create_succesful_order() + order_id = order['id'] + # --8<-- [start:download_asset] + async with planet.Session() as sess: + client = sess.client('orders') + order = await client.get_order(order_id=order_id) + info = order['_links']['results'] + # Find and download the data + for i in info: + # This works to download spesifically a composite.tif + if 'composite.tif' in i['name']: + location = i['location'] + filename = await client.download_asset(location=location) + # --8<-- [end:download_asset] + assert filename.exists() + os.remove(filename) + else: + pass + + +@pytest.mark.anyio +async def test_snippet_orders_download_order_without_checksum(): + '''Code snippet for download_order without checksum.''' + order = create_succesful_order() + order_id = order['id'] + # --8<-- [start:download_order_without_checksum] + async with planet.Session() as sess: + client = sess.client('orders') + filenames = await client.download_order(order_id=order_id) + # --8<-- [end:download_order_without_checksum] + assert all([filename.exists() for filename in filenames]) + shutil.rmtree(filenames[0].parent) + + +@pytest.mark.anyio +async def test_snippet_orders_download_order_with_checksum(): + '''Code snippet for download_order with checksum.''' + order = create_succesful_order() + order_id = order['id'] + # --8<-- [start:download_order_without_checksum] + async with planet.Session() as sess: + client = sess.client('orders') + filenames = await client.download_order(order_id=order_id) + client.validate_checksum(directory=Path(order_id), checksum="MD5") + # --8<-- [end:download_order_without_checksum] + assert all([filename.exists() for filename in filenames]) + shutil.rmtree(filenames[0].parent) + + +@pytest.mark.anyio +async def test_snippet_orders_wait(): + '''Code snippet for wait.''' + order = create_succesful_order() + order_id = order['id'] + # --8<-- [start:wait] + async with planet.Session() as sess: + client = sess.client('orders') + state = await client.wait(order_id=order_id) + + # --8<-- [end:wait] + assert state == 'success' + + +@pytest.mark.anyio +async def test_snippet_orders_list_orders(): + '''Code snippet for list_orders.''' + # --8<-- [start:list_orders] + async with planet.Session() as sess: + client = sess.client('orders') + order_descriptions = [order async for order in client.list_orders()] + # --8<-- [start:list_orders] + assert order_descriptions[0].keys() == { + '_links', + 'created_on', + 'error_hints', + 'id', + 'last_message', + 'last_modified', + 'name', + 'products', + 'state' + }