Skip to content

Commit c294192

Browse files
committed
feat: add some readme notes
1 parent ce005b8 commit c294192

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ A small no-dependency Python package for [STAC](https://stacspec.org/), using Ru
1111

1212
## Why?
1313

14-
Why make a new STAC Python library, when we already have [PySTAC](https://github.com/stac-utils/pystac)?
15-
Well, we've built some things in [stac-rs](https://github.com/stac-utils/stac-rs) (a collection of STAC Rust libraries) that we want to provide to the Python ecosystem, such as:
14+
Q: We already have [PySTAC](https://github.com/stac-utils/pystac), so why did we make a new STAC Python library?
15+
16+
A: We want to provide a couple of things in [stac-rs](https://github.com/stac-utils/stac-rs) (a collection of STAC Rust libraries) to the Python ecosystem:
1617

1718
- Read, write, and search [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet)
1819
- `async` functions
@@ -24,7 +25,11 @@ If you don't need those things, **stacrs** probably isn't for you — use **pyst
2425
Install via **pip**:
2526

2627
```shell
28+
# basic
2729
python -m pip install stacrs
30+
31+
# add methods to return arrow tables
32+
python -m pip install 'stacrs[arrow]'
2833
```
2934

3035
Or via **conda**:
@@ -47,6 +52,11 @@ items = await stacrs.search(
4752
max_items=100,
4853
)
4954

55+
# If you installed with `pystac[arrow]`:
56+
from geopandas import GeoDataFrame
57+
table = await stacrs.search_to_arrow(...)
58+
data_frame = GeoDataFrame.from_arrow(table)
59+
5060
# Write items to a stac-geoparquet file
5161
await stacrs.write("items.parquet", items)
5262

0 commit comments

Comments
 (0)