Skip to content

Commit

Permalink
Add pgstac page
Browse files Browse the repository at this point in the history
  • Loading branch information
kylebarron committed Jun 24, 2024
1 parent 15b1e31 commit c181a07
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 16 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ For analytic questions like "find the items in the Sentinel-2 collection in June

See the [STAC-GeoParquet specification](./spec/stac-geoparquet-spec.md) for details on the exact schema of the written Parquet files.

## Documentation

<!--
## pgstac integration
`stac_geoparquet.pgstac_reader` has some helpers for working with items coming from a `pgstac.items` table. It takes care of
- Rehydrating the dehydrated items
- Partitioning by time
- Injecting dynamic links and assets from a STAC API -->
[Documentation website](https://stac-utils.github.io/stac-geoparquet/)
11 changes: 11 additions & 0 deletions docs/api/pgstac.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# pgstac integration

`stac_geoparquet.pgstac_reader` has some helpers for working with items coming from a `pgstac.items` table. It takes care of

- Rehydrating the dehydrated items
- Partitioning by time
- Injecting dynamic links and assets from a STAC API

::: stac_geoparquet.pgstac_reader.CollectionConfig
options:
show_if_no_docstring: true
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ nav:
- API Reference:
- api/arrow.md
- Legacy: api/legacy.md
# - api/pgstac.md
- api/pgstac.md
- drawbacks.md

watch:
Expand Down
13 changes: 6 additions & 7 deletions stac_geoparquet/pgstac_reader.py
Original file line number Diff line number Diff line change
Expand Up @@ -284,13 +284,12 @@ def make_pgstac_items(
"""
Make STAC items out of pgstac records.
Parameters
----------
records: list[tuple]
The dehydrated records from pgstac.items table.
base_item: dict[str, Any]
The base item from the ``collection_base_item`` pgstac function for this
collection. Used for rehydration
Args:
records: list[tuple]
The dehydrated records from pgstac.items table.
base_item: dict[str, Any]
The base item from the ``collection_base_item`` pgstac function for this
collection. Used for rehydration
"""
columns = [
"id",
Expand Down

0 comments on commit c181a07

Please sign in to comment.