Skip to content

Read

stacrs.read builtin

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

Reads STAC from a href.

Parameters:

Name Type Description Default
href str

The href to write to

required
format str | None

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

None
options list[tuple[str, str]] | None

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

None

Returns:

Type Description
dict[str, Any]

dict[str, Any]: The STAC value

Examples:

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