Skip to content

Commit 0d49758

Browse files
committed
add readme files
1 parent 80ae48e commit 0d49758

File tree

4 files changed

+82
-0
lines changed

4 files changed

+82
-0
lines changed

stac_fastapi/core/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# stac-fastapi-core
2+
3+
Core functionality for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
4+
5+
## Package Information
6+
7+
- **Package name**: stac-fastapi-core
8+
- **Description**: Core functionality for STAC API implementations.
9+
- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
10+
- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
11+
12+
## Installation
13+
14+
```bash
15+
pip install stac-fastapi-core
16+
```
17+
18+
## Quick Start
19+
20+
For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# stac-fastapi-elasticsearch
2+
3+
This is the Elasticsearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
4+
5+
## Package Information
6+
7+
- **Package name**: stac-fastapi-elasticsearch
8+
- **Description**: An implementation of STAC API based on the FastAPI framework with Elasticsearch.
9+
- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
10+
- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
11+
12+
## Installation
13+
14+
```bash
15+
pip install stac-fastapi-elasticsearch
16+
```
17+
18+
## Quick Start
19+
20+
For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).

stac_fastapi/opensearch/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# stac-fastapi-opensearch
2+
3+
This is the OpenSearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
4+
5+
## Package Information
6+
7+
- **Package name**: stac-fastapi-opensearch
8+
- **Description**: An implementation of STAC API based on the FastAPI framework with OpenSearch.
9+
- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
10+
- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
11+
12+
## Installation
13+
14+
```bash
15+
pip install stac-fastapi-opensearch
16+
```
17+
18+
## Quick Start
19+
20+
For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# sfeos-helpers
2+
3+
Helper utilities for the stac-fastapi project. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
4+
5+
## Package Information
6+
7+
- **Package name**: sfeos-helpers
8+
- **Description**: Helper utilities for the stac-fastapi project.
9+
- **Documentation**: [https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/)
10+
- **Source**: [GitHub Repository](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/)
11+
12+
## Installation
13+
14+
This package is a dependency of stac-fastapi-elasticsearch and stac-fastapi-opensearch and is typically installed automatically.
15+
16+
```bash
17+
pip install stac-fastapi-elasticsearch # or stac-fastapi-opensearch
18+
```
19+
20+
## Quick Start
21+
22+
For detailed usage and examples, please refer to the [main documentation](https://stac-utils.github.io/stac-fastapi-elasticsearch-opensearch/).

0 commit comments

Comments
 (0)