Skip to content

Commit b8560c4

Browse files
committed
feat: update readme, add license
1 parent b9ec1b4 commit b8560c4

File tree

3 files changed

+59
-1
lines changed

3 files changed

+59
-1
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Development Seed
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# stac-fastapi-geoparquet
22

3-
TODO
3+
A [stac-fastapi](https://github.com/stac-utils/stac-fastapi) with a [stac-geoparquet](https://github.com/stac-utils/stac-geoparquet/blob/main/spec/stac-geoparquet-spec.md) backend.
4+
5+
**stac-fastapi-geoparquet** can serve a full-featured STAC API from a **stac-geoparquet** file located (e.g.) in blob storage — no database required!
6+
7+
> [!WARNING]
8+
> This project is under active development 👷 and may change and break at any time.
9+
10+
## Usage
11+
12+
To start a STAC API server pointing to a single **stac-geoparquet** file:
13+
14+
```shell
15+
$ python -m pip install 'stac-fastapi-geoparquet[serve]'
16+
$ STAC_FASTAPI_GEOPARQUET_HREF=data/naip.parquet uvicorn stac_fastapi.geoparquet.main:app
17+
INFO: Started server process [47920]
18+
INFO: Waiting for application startup.
19+
INFO: Application startup complete.
20+
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
21+
```
22+
23+
To explore the API, you can use [stac browser](https://radiantearth.github.io/stac-browser/#/external/http:/127.0.0.1:8000/?.language=en).
24+
25+
## Development
26+
27+
Get [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
28+
29+
```shell
30+
git clone [email protected]:stac-utils/stac-fastapi-geoparquet.git
31+
cd stac-fastapi-geoparquet
32+
uv sync
33+
```
34+
35+
To run the tests:
36+
37+
```shell
38+
uv run pytest
39+
```

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ dependencies = [
1717

1818
[project.optional-dependencies]
1919
lambda = ["mangum==0.19.0"]
20+
serve = ["uvicorn>=0.34.0"]
2021

2122
[dependency-groups]
2223
dev = [

0 commit comments

Comments
 (0)