Skip to content

Read

stacrs.read async

read(
    href: str,
    *,
    format: str | None = None,
    options: list[tuple[str, str]] | None = None,
    set_self_link: bool = True,
) -> dict[str, Any]

Reads STAC from a href.

Parameters:

  • href (str) –

    The href to write to

  • format (str | None, default: None ) –

    The input format. If not provided, will be inferred from the href's extension.

  • options (list[tuple[str, str]] | None, default: None ) –

    Options for configuring an object store, e.g. your AWS credentials.

  • set_self_link (bool, default: True ) –

    If True, set the self link to the value of href.

Returns:

  • dict[str, Any]

    The STAC value

Examples:

>>> item = await stacrs.read("item.json")