Skip to content

Commit c1017fd

Browse files
committed
remove sfeos-tools, update docs
1 parent 616f4fa commit c1017fd

File tree

7 files changed

+12
-430
lines changed

7 files changed

+12
-430
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1111

1212
- Spatial search support for collections via `bbox` parameter on `/collections` endpoint. Collections are now indexed with a `bbox_shape` field (GeoJSON polygon) derived from their spatial extent for efficient geospatial queries when created or updated. [#481](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/481)
1313
- Introduced SFEOS Tools (`sfeos_tools/`) - An installable Click-based CLI package for managing SFEOS deployments. Initial command `add-bbox-shape` adds the `bbox_shape` field to existing collections for spatial search compatibility. Install with `pip install sfeos-tools[elasticsearch]` or `pip install sfeos-tools[opensearch]`. [#481](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/481)
14+
- Moved SFEOS Tools to its own repository at [Healy-Hyperspatial/sfeos-tools](https://github.com/Healy-Hyperspatial/sfeos-tools). The CLI package is now maintained separately. [#PR_NUMBER]
1415
- CloudFerro logo to sponsors and supporters list [#485](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/485)
1516
- Latest news section to README [#485](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/pull/485)
1617

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The following organizations have contributed time and/or funding to support the
3232

3333
<div style="max-height: 200px; overflow-y: auto; padding: 10px; border: 1px solid #eaecef; border-radius: 6px; margin-bottom: 16px;">
3434

35-
- **10/12/2025:** Collections search **bbox** functionality added! The collections search extension now supports bbox queries. Collections will need to be updated via the API or with the new **[SFEOS-tools](#sfeos-tools-cli)** CLI package to support geospatial discoverability. Thanks again to **CloudFerro** for their sponsorship of this work!
35+
- **10/12/2025:** Collections search **bbox** functionality added! The collections search extension now supports bbox queries. Collections will need to be updated via the API or with the new **[SFEOS-tools](https://github.com/Healy-Hyperspatial/sfeos-tools)** CLI package to support geospatial discoverability. Thanks again to **CloudFerro** for their sponsorship of this work!
3636
- **10/04/2025:** The **[CloudFerro](https://cloudferro.com/)** logo has been added to the sponsors and supporters list above. Their sponsorship of the ongoing collections search extension work has been invaluable. This is in addition to the many other important changes and updates their developers have added to the project.
3737

3838
</div>
@@ -170,7 +170,7 @@ These endpoints support advanced collection discovery features including:
170170
- **Implementation Note**: When collections are created or updated, a `bbox_shape` field is automatically generated from the collection's spatial extent and indexed as a GeoJSON polygon for efficient geospatial queries
171171
- **Migrating Legacy Collections**: Collections created before this feature was added will not be discoverable via bbox search until they have the `bbox_shape` field added. You can either:
172172
- Update each collection via the API (PUT `/collections/{collection_id}` with the existing collection data)
173-
- Run the migration tool (see [SFEOS Tools CLI](#sfeos-tools-cli) for installation and connection options):
173+
- Use the [SFEOS Tools CLI](https://github.com/Healy-Hyperspatial/sfeos-tools) (install with `pip install sfeos-tools[elasticsearch]` or `pip install sfeos-tools[opensearch]`):
174174
- `sfeos-tools add-bbox-shape --backend elasticsearch --no-ssl`
175175
- `sfeos-tools add-bbox-shape --backend opensearch --host db.example.com --no-ssl`
176176

@@ -488,7 +488,7 @@ The system uses a precise naming convention:
488488

489489
## SFEOS Tools CLI
490490

491-
- **Overview**: SFEOS Tools is an installable CLI package for managing and maintaining SFEOS deployments.
491+
- **Overview**: SFEOS Tools is now maintained as a separate project at [Healy-Hyperspatial/sfeos-tools](https://github.com/Healy-Hyperspatial/sfeos-tools). This CLI package provides utilities for managing and maintaining SFEOS deployments.
492492

493493
- **Installation**:
494494
```shell
@@ -498,14 +498,11 @@ The system uses a precise naming convention:
498498
# For OpenSearch (from PyPI)
499499
pip install sfeos-tools[opensearch]
500500

501-
# For local development
502-
pip install -e sfeos_tools[elasticsearch]
503-
# or
504-
pip install -e sfeos_tools[opensearch]
505501
```
506502

507503
- **Available Commands**:
508504
- `add-bbox-shape`: Add bbox_shape field to existing collections for spatial search support
505+
- `reindex`: Reindex all STAC indices (collections and per-collection items) to new versioned indices and update aliases; supports both Elasticsearch and OpenSearch backends
509506

510507
- **Basic Usage**:
511508
```shell
@@ -540,9 +537,15 @@ The system uses a precise naming convention:
540537
# Using --help for more information
541538
sfeos-tools --help
542539
sfeos-tools add-bbox-shape --help
540+
sfeos-tools reindex --help
541+
543542
```
544543

545-
For more details, see the [SFEOS Tools README](./sfeos_tools/README.md).
544+
- **Documentation**:
545+
For complete documentation, examples, and advanced usage, please visit the [SFEOS Tools GitHub repository](https://github.com/Healy-Hyperspatial/sfeos-tools).
546+
547+
- **Contributing**:
548+
Contributions, bug reports, and feature requests are welcome! Please file them on the [SFEOS Tools issue tracker](https://github.com/Healy-Hyperspatial/sfeos-tools/issues).
546549

547550
## Ingesting Sample Data CLI Tool
548551

sfeos_tools/LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

sfeos_tools/README.md

Lines changed: 0 additions & 113 deletions
This file was deleted.

sfeos_tools/setup.py

Lines changed: 0 additions & 56 deletions
This file was deleted.

sfeos_tools/sfeos_tools/__init__.py

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)