Let user set asset key, roles on stac create-item (#442)

Co-authored-by: Pete Gadomski <pete.gadomski@gmail.com>

Author: jsignell

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - For raster footprints users can set destination CRS rather than it being hardcoded to EPSG:4326 ([#440](https://github.com/stac-utils/stactools/pull/440))
 - Raster footprint calculation for multi-asset items can elect to use the union or intersection of the asset footprints ([#445](https://github.com/stac-utils/stactools/pull/445))
+- On `stac create-item` asset key name and roles are settable ([#442](https://github.com/stac-utils/stactools/pull/442))
 
 ### Changed
 

src/stactools/cli/commands/create.py

@@ -1,5 +1,6 @@
 import json
 import sys
+from typing import List
 
 import click
 from stactools.core import create
@@ -8,15 +9,24 @@
 def create_create_item_command(cli: click.Group) -> click.Command:
     @cli.command("create-item", short_help="Creates an item from an asset")
     @click.argument("href")
-    def create_item_command(href: str) -> None:
+    @click.argument("asset_key", default="data")
+    @click.option(
+        "-r",
+        "--role",
+        "roles",
+        help="Optional, semantic roles of the asset",
+        multiple=True,
+        default=["data"],
+    )
+    def create_item_command(href: str, asset_key: str, roles: List[str]) -> None:
         """Creates an Item from a href.
 
         The href must be a `rasterio` readable asset. The item's dictionary will
         be printed to stdout. This item is intentinonally _extremely_ minimal.
         If you need additional capabilities, we recommend using [rio
         stac](https://github.com/developmentseed/rio-stac/).
         """
-        item = create.item(href)
+        item = create.item(href, asset_key=asset_key, roles=roles)
         json.dump(item.to_dict(), sys.stdout)
 
     return create_item_command

src/stactools/core/create.py

@@ -1,6 +1,6 @@
 import datetime
 import os.path
-from typing import Optional
+from typing import List, Optional
 
 import rasterio
 import shapely.geometry
@@ -11,7 +11,13 @@
 from .io import ReadHrefModifier
 
 
-def item(href: str, read_href_modifier: Optional[ReadHrefModifier] = None) -> Item:
+def item(
+    href: str,
+    *,
+    asset_key: str = "data",
+    roles: List[str] = ["data"],
+    read_href_modifier: Optional[ReadHrefModifier] = None,
+) -> Item:
     """Creates a STAC Item from the asset at the provided href.
 
     The ``read_href_modifer`` argument can be used to modify the href for the
@@ -22,6 +28,8 @@ def item(href: str, read_href_modifier: Optional[ReadHrefModifier] = None) -> It
 
     Args:
         href (str): The href of the asset that will be used to create the item.
+        asset_key (str): The unique key of the asset
+        roles (List[str]): The semantic roles of the asset
         read_href_modifier (Optional[ReadHrefModifier]):
             An optional callable that will be used to modify the href before reading.
 
@@ -60,6 +68,6 @@ def item(href: str, read_href_modifier: Optional[ReadHrefModifier] = None) -> It
     projection.transform = proj_transform
     projection.shape = proj_shape
 
-    item.add_asset("data", Asset(href=href, roles=["data"]))
+    item.add_asset(asset_key, Asset(href=href, roles=roles))
 
     return item

tests/cli/commands/test_create.py

@@ -0,0 +1,33 @@
+import json
+
+from click.testing import CliRunner
+from stactools.cli.cli import cli
+
+from tests import test_data
+
+
+def test_create_item():
+    path = test_data.get_path("data-files/core/byte.tif")
+    runner = CliRunner()
+    result = runner.invoke(cli, ["create-item", path])
+    assert result.exit_code == 0
+    d = json.loads(result.output)
+    assert list(d["assets"].keys()) == ["data"]
+
+
+def test_create_item_with_asset_key():
+    path = test_data.get_path("data-files/core/byte.tif")
+    runner = CliRunner()
+    result = runner.invoke(cli, ["create-item", path, "foo"])
+    assert result.exit_code == 0
+    d = json.loads(result.output)
+    assert list(d["assets"].keys()) == ["foo"]
+
+
+def test_create_item_with_asset_roles():
+    path = test_data.get_path("data-files/core/byte.tif")
+    runner = CliRunner()
+    result = runner.invoke(cli, ["create-item", path, "-r", "reference"])
+    assert result.exit_code == 0
+    d = json.loads(result.output)
+    assert d["assets"]["data"]["roles"] == ["reference"]