From 8972317da8f590f551987b4d550e821d828f48fb Mon Sep 17 00:00:00 2001 From: Ian Schneider Date: Thu, 7 Nov 2024 09:29:39 -0700 Subject: [PATCH] add sync client to get started docs --- docs/get-started/sync-client-quick-start.md | 8 ++++---- mkdocs.yml | 7 ++++--- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/get-started/sync-client-quick-start.md b/docs/get-started/sync-client-quick-start.md index 7c394e08..77d183a0 100644 --- a/docs/get-started/sync-client-quick-start.md +++ b/docs/get-started/sync-client-quick-start.md @@ -11,7 +11,7 @@ Your feedback on this version of our client is appreciated. Please raise an issu ## Dependencies -This package requires [Python 3.7 or greater](https://python.org/downloads/). A virtual environment is strongly recommended. +This package requires [Python 3.8 or greater](https://python.org/downloads/). A virtual environment is strongly recommended. You will need your Planet API credentials. You can find your API key in [Planet Explorer](https://planet.com/explorer) under Account Settings. @@ -109,7 +109,7 @@ for item in pl.data.search(['PSScene'], geometry=geom, limit=5): #### Filters -The Data API allows a wide range of search parameters. Whether using the `.search()` method, or +The Data API allows a wide range of search parameters. Whether using the `.search()` method, or creating or updating a saved search, or requesting stats, a data search filter can be provided to the API as a JSON blob. This JSON blob can be built up manually or by using the `data_filter` module. @@ -180,7 +180,7 @@ def main(): item_type='psscene') ] ) - + order = pl.orders.create_order(request) # wait for the order to be ready @@ -202,7 +202,7 @@ You will need your ACCESS_KEY_ID, SECRET_ACCESS_KEY, bucket and region name. To subscribe to scenes that match a filter, use the `subscription_request` module to build a request, and pass it to the `subscriptions.create_subscription()` method of the client. -Warning: the following code will create a subscription, consuming quota based on your plan. +Warning: the following code will create a subscription, consuming quota based on your plan. ```python from planet.subscription_request import catalog_source, build_request, amazon_s3 diff --git a/mkdocs.yml b/mkdocs.yml index c7b3bdd4..ecdd3aa9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,7 +25,7 @@ theme: - search.suggest - search.highlight - toc.follow - - toc.integrate + - toc.integrate palette: - scheme: default primary: #007f99 @@ -34,7 +34,7 @@ theme: name: Switch to dark mode - scheme: slate primary: #004352 - toggle: + toggle: icon: octicons/sun-24 name: Switch to light mode @@ -46,7 +46,7 @@ extra: extra_css: - stylesheets/extra.css - + plugins: - search - mkdocstrings: @@ -67,6 +67,7 @@ plugins: nav: - "Get Started": - get-started/quick-start-guide.md + - get-started/sync-client-quick-start.md - get-started/get-your-planet-account.md - get-started/venv-tutorial.md - get-started/v2_earlyaccess.md