Merge branch 'main' into readme-test-badge-main-branch

Author: wiki0831

RELEASE.md

@@ -14,23 +14,20 @@ The SDK follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and t
 
 ## Release Workflow
 
-1. Create a release branch off of `main` that bumps the SDK version number and updates the changelog:
-   * Update `CHANGES.txt`, adhering to [keep a changelog](https://keepachangelog.com/)
-2. Create a PR for the release branch and merge into `main`
-3. Create a new GitHub release:
+1. Create a new GitHub release:
    * From the GitHub UI:
      * Navigate to the releases UI
      * Set tag to release version
      * Set target to `main`
      * Set title to tag release version
-     * Copy description from the new entry in the changelog
+     * Describe the change(s) that are shipping with this version in the release description
    * Alternatively, create a release from the GitHub CLI:
      * Make sure the pre-requisite [gh](https://cli.github.com/manual/gh) CLI is installed, and optionally review the docs for CLI command [gh release create](https://cli.github.com/manual/gh_release_create)
      * By default, `gh release create` will automatically tag releases from the latest state of the default branch
-     * Run CLI command `gh release create {VERSION} --notes "{RELEASE NOTES}"` where `VERSION` is the release version and `RELEASE NOTES` is the description copied from the new entry in the changelog
-4. Verify the successful run of the Github Action `Autopublish to TestPyPI` and validate the test release on [test.pypi.org](https://test.pypi.org/project/planet/)
-5. Run the Github Action `Publish on PyPI`
-6. Verify the successful run of the Github Action `Publish on PyPI` and validate the release on [pypi.org](https://pypi.org/project/planet/)
+     * Run CLI command `gh release create {VERSION} --notes "{RELEASE NOTES}"` where `VERSION` is the release version and `RELEASE NOTES` is the description of changes
+2. Verify the successful run of the Github Action `Autopublish to TestPyPI` and validate the test release on [test.pypi.org](https://test.pypi.org/project/planet/)
+3. Run the Github Action `Publish on PyPI`
+4. Verify the successful run of the Github Action `Publish on PyPI` and validate the release on [pypi.org](https://pypi.org/project/planet/)
 
 
 ## Local publishing

design-docs/CLI-Data.md

@@ -588,7 +588,7 @@ A series of GeoJSON descriptions for each of the returned items.
 ### Interface
 
 ```
-planet data item-get [OPTIONS] ID ITEM_TYPE
+planet data item-get [OPTIONS] ITEM_TYPE ITEM_ID
 
 Get an item.
 
@@ -609,23 +609,165 @@ A full GeoJSON description of the returned item.
 User Story: As a CLI user I would like to get the details of an item
 
 ```
-$ planet data item-get 20210819_162141_68_2276 PSScene
+$ planet data item-get PSScene 20210819_162141_68_2276
 
 {"_links": {...}, ..., "type": "Feature"}
 ```
 
+## item-coverage
+
+### Interface
+
+```
+planet data item-coverage [OPTIONS] ITEM_TYPE ITEM_ID
+
+Get item clear coverage within a custom area of interest.
+
+Arguments:
+ITEM_TYPE - The type of item (e.g., PSScene)
+ITEM_ID - The ID of the item
+
+Options:
+--geom TEXT - A GeoJSON geometry or feature reference. [required]
+--mode TEXT - Method used for coverage calculation (e.g., UDM2, estimate)
+--band TEXT - Specific band to extract from UDM2 (e.g., cloud, snow)
+
+Output:
+A JSON description of the clear coverage for the provided AOI within the scene.
+```
+
+### Usage Examples
+
+User Story: As a CLI user I want to get clear coverage information for a specific area within an item.
+
+```console
+$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
+  --geom '{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}'
+```
+response
+```
+{
+  "clear_percent": 95,
+  "status": "complete"
+}
+```
+
+User Story: As a CLI user I want to get snow coverage over my Feature Ref.
+
+```console
+$ planet data item-coverage PSScene 20250304_162555_90_24f2 \
+  --geom 'pl:features/my/[collection-id]/[feature-id]' \
+  --band snow
+```
+response
+```
+{
+  "snow_percent": 0.0,
+  "status": "complete"
+}
+```
+
+## asset-get
+
+### Interface
+
+planet data asset-get [OPTIONS] ITEM_TYPE ITEM_ID ASSET_TYPE_ID
+
+Get an item asset.
+
+Arguments:
+ITEM_TYPE - The type of item (e.g., PSScene, SkySatScene)
+ITEM_ID - The ID of the item
+ASSET_TYPE_ID - The type of asset to get (e.g., basic_udm2)
+
+Output:
+A JSON description of the asset, including its status, permissions, and download location if available.
+
+### Usage Examples
+
+User Story: As a CLI user I want to get information about a specific asset for an item.
+
+```console
+$ planet data asset-get PSScene 20221003_002705_38_2461 basic_udm2
+```
+response
+```
+{
+  "_links": {
+    "_self": "SELFURL",
+    "activate": "ACTIVATEURL",
+    "type": "https://api.planet.com/data/v1/asset-types/basic_udm2"
+  },
+  "_permissions": ["download"],
+  "md5_digest": null,
+  "status": "inactive",
+  "type": "basic_udm2"
+}
+```
+
+## asset-list
+
+### Interface
+
+planet data asset-list [OPTIONS] ITEM_TYPE ITEM_ID
+
+List all assets available for an item.
+
+Arguments:
+- ITEM_TYPE - The type of item (e.g., PSScene, SkySatScene)
+- ITEM_ID - The ID of the item
+
+Output:
+A JSON dictionary with asset_type_id as keys and asset descriptions as values.
+
+### Usage Examples
+
+User Story: As a CLI user I want to see all available assets for an item.
+
+```console
+$ planet data asset-list PSScene 20221003_002705_38_2461
+```
+response
+```
+{
+  "basic_analytic_4b": {
+    "_links": {
+      "_self": "SELFURL",
+      "activate": "ACTIVATEURL",
+      "type": "https://api.planet.com/data/v1/asset-types/basic_analytic_4b"
+    },
+    "_permissions": ["download"],
+    "md5_digest": null,
+    "status": "inactive",
+    "type": "basic_analytic_4b"
+  },
+  "basic_udm2": {
+    "_links": {
+      "_self": "SELFURL",
+      "activate": "ACTIVATEURL",
+      "type": "https://api.planet.com/data/v1/asset-types/basic_udm2"
+    },
+    "_permissions": ["download"],
+    "md5_digest": null,
+    "status": "active",
+    "location": "https://api.planet.com/data/v1/1?token=IAmAToken",
+    "type": "basic_udm2"
+  }
+}
+```
+
 ## asset-activate
 
 ### Interface
 
 ```
-planet data asset-activate ID ITEM_TYPE ASSET_TYPE
+planet data asset-activate ITEM_TYPE ITEM_ID ASSET_TYPE
 
 Activate an asset.
 
 Arguments:
-ID - string. Item identifier.
 ITEM_TYPE - string. Item type identifier.
+ITEM_ID - string. Item identifier.
 ASSET_TYPE - string. Asset type identifier.
 
 Output:
@@ -637,20 +779,20 @@ None.
 User Story: As a CLI user I would like to activate an asset for download.
 
 ```
-$ planet data asset-activate 20210819_162141_68_2276 PSScene analytic
+$ planet data asset-activate PSScene 20210819_162141_68_2276 basic_analytic_4b
 ```
 
 User Story: As a CLI user I would like to activate, wait, and then download an
 asset.
 
 ```
-$ ID=20210819_162141_68_2276 && \
-ITEM_TYPE=PSScene && \
-ASSET_TYPE=analytic && \
-planet data asset-activate $ID $ITEM_TYPE $ASSET_TYPE && \
-planet data asset-wait $ID $ITEM_TYPE $ASSET_TYPE && \
+$ ITEM_TYPE=PSScene && \
+ITEM_ID=20210819_162141_68_2276 && \
+ASSET_TYPE=basic_analytic_4b && \
+planet data asset-activate $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
+planet data asset-wait $ITEM_TYPE $ITEM_ID $ASSET_TYPE && \
 planet data asset-download --directory data \
-$ID $ITEM_TYPE $ASSET_TYPE
+$ITEM_TYPE $ITEM_ID $ASSET_TYPE
 
 data/<psscene_naming 20210819_162141_68_2276>.tif
 ```
@@ -660,15 +802,15 @@ data/<psscene_naming 20210819_162141_68_2276>.tif
 ### Interface
 
 ```
-planet data asset-wait ID ITEM_TYPE ASSET_TYPE
+planet data asset-wait ITEM_TYPE ITEM_ID ASSET_TYPE
 
 Wait for an asset to be activated.
 
-Returns when the asset state has reached ‘activated’ and the asset is available.
+Returns when the asset state has reached 'activated' and the asset is available.
 
 Arguments:
-ID - string. Item identifier.
 ITEM_TYPE - string. Item type identifier.
+ITEM_ID - string. Item identifier.
 ASSET_TYPE - string. Asset type identifier.
 
 Output:
@@ -680,15 +822,15 @@ None.
 ### Interface
 
 ```
-planet data asset-download [OPTIONS] ID ITEM_TYPE ASSET_TYPE
+planet data asset-download [OPTIONS] ITEM_TYPE ITEM_ID ASSET_TYPE
 
 Download an activated asset.
 
 Will fail if the asset state is not activated. Consider calling `asset-wait` before this command to ensure the asset is activated.
 
 Arguments:
-ID - string. Item identifier.
 ITEM_TYPE - string. Item type identifier.
+ITEM_ID - string. Item identifier.
 ASSET_TYPE - string. Asset type identifier.
 
 Options:
@@ -708,7 +850,7 @@ directory, overwriting if the file already exists, and silencing reporting.
 $ planet --quiet data asset-download \
 --directory data \
 --overwrite \
-20210819_162141_68_2276 PSScene analytic
+PSScene 20210819_162141_68_2276 basic_analytic_4b
 data/<psscene_naming 20210819_162141_68_2276>.tif
 ```
 

docs/cli/cli-data.md

@@ -424,6 +424,66 @@ curl -s https://raw.githubusercontent.com/ropensci/geojsonio/main/inst/examples/
 
 Just pipe the results to `jq '.buckets | map(.count) | add'` and it’ll give you the total of all the values.
 
+## Get Item Details and Assess Item Clear Coverage
+
+Once you've found items of interest through search, you may want to examine a specific item in detail. The CLI provides a command to retrieve and display detailed information about a single item.
+
+### Get Item
+
+The `item-get` command allows you to retrieve detailed information about a specific item by its Type and ID:
+
+```sh
+planet data item-get PSScene 20230310_083933_71_2431
+```
+
+### Get Item Coverage
+
+The `item-coverage` command estimates the clear coverage of an item within a specified area of interest (AOI). This is useful for determining how much of your area of interest is covered by clouds or other obstructions:
+
+```sh
+planet data item-coverage PSScene 20250304_162555_90_24f2 --geom='{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}'
+```
+
+You can also specify additional parameters:
+
+* `--mode`: The mode for coverage calculation
+    * `UDM2`: calculate clear coverage using a UDM2 asset [default]
+    * `estimate`: estimate clear coverage based on preview imagery
+
+* `--band`: The band to use for coverage calculation
+
+See [Data API documentation](https://docs.planet.com/develop/apis/data/items/#estimate-clear-coverage-over-an-individual-item-with-a-custom-aoi) for an overview of coverage options. 
+
+For example:
+
+```sh
+planet data item-coverage PSScene 20250304_162555_90_24f2 --geom='{"type":"Polygon","coordinates":[[[-81.45,30.31],[-81.45,30.23],[-81.38,30.23],[-81.45,30.31]]]}' --band='snow'
+```
+
+## Item Asset Management
+
+The CLI provides several commands for managing and working with item assets.
+
+### List Available Assets
+
+To see all available assets for a specific item:
+
+```sh
+planet data asset-list PSScene 20230310_083933_71_2431
+```
+
+This will show you all asset available for the item, including their status and activation requirements.
+
+### Get Asset Details
+
+To get detailed information about a specific asset:
+
+```sh
+planet data asset-get PSScene 20230310_083933_71_2431 ortho_analytic_8b
+```
+
+This command provides information about the asset's status download availability.
+
 ## Asset Activation and Download
 
 While we recommend using the Orders or Subscriptions API’s to deliver Planet data, the Data API has the capability