sfeos-tools 0.1.0__tar.gz

sfeos_tools-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Healy Hyperspatial, Jonathan Healy and CloudFerro S.A.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sfeos_tools-0.1.0/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: sfeos-tools
+Version: 0.1.0
+Summary: CLI tools for managing stac-fastapi-elasticsearch-opensearch deployments
+Author: CloudFerro S.A.
+Author-email: Jonathan Healy <jon@healy-hypersaptial.dev>
+Maintainer-email: Jonathan Healy <jon@healy-hypersaptial.dev>
+License: MIT License
+        
+        Copyright (c) 2025 Healy Hyperspatial, Jonathan Healy and CloudFerro S.A.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/Healy-Hyperspatial/sfeos-tools
+Project-URL: Documentation, https://github.com/Healy-Hyperspatial/sfeos-tools#readme
+Project-URL: Issues, https://github.com/Healy-Hyperspatial/sfeos-tools/issues
+Project-URL: Source, https://github.com/Healy-Hyperspatial/sfeos-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Provides-Extra: elasticsearch
+Requires-Dist: stac-fastapi-elasticsearch; extra == "elasticsearch"
+Provides-Extra: opensearch
+Requires-Dist: stac-fastapi-opensearch; extra == "opensearch"
+Provides-Extra: dev
+Requires-Dist: stac-fastapi-elasticsearch; extra == "dev"
+Requires-Dist: stac-fastapi-opensearch; extra == "dev"
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# SFEOS Tools
+
+CLI tools for managing [stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) deployments.
+
+## Table of Contents
+
+- [Installation](#installation)
+  - [For Elasticsearch](#for-elasticsearch)
+  - [For OpenSearch](#for-opensearch)
+  - [For Development](#for-development-both-backends)
+- [Usage](#usage)
+- [Commands](#commands)
+  - [add-bbox-shape](#add-bbox-shape)
+  - [reindex](#reindex)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+### For Elasticsearch
+
+```bash
+pip install sfeos-tools[elasticsearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[elasticsearch]
+```
+
+### For OpenSearch
+
+```bash
+pip install sfeos-tools[opensearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[opensearch]
+```
+
+### For Development (both backends)
+
+```bash
+pip install sfeos-tools[dev]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[dev]
+```
+
+## Usage
+
+After installation, the `sfeos-tools` command will be available:
+
+```bash
+# View available commands
+sfeos-tools --help
+
+# View version
+sfeos-tools --version
+```
+
+## Commands
+
+### add-bbox-shape
+
+Adds a `bbox_shape` field to existing collections for spatial search support. This migration is required for collections created before spatial search was added. Collections created or updated after this feature will automatically have the `bbox_shape` field.
+
+```bash
+sfeos-tools add-bbox-shape --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+### reindex
+
+Reindexes all STAC indexes to the next version and updates aliases. This command performs the following actions:
+- Creates/updates index templates
+- Reindexes collections and item indexes to a new version
+- Applies asset migration script for compatibility
+- Switches aliases to the new indexes
+
+```bash
+sfeos-tools reindex --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+- `--yes`: Skip confirmation prompt
+
+Example:
+```bash
+# Reindex Elasticsearch with custom host and no SSL
+sfeos-tools reindex --backend elasticsearch --host localhost --port 9200 --no-ssl
+
+# Reindex OpenSearch with default settings
+sfeos-tools reindex --backend opensearch
+```
+
+# Get help for a specific command
+sfeos-tools add-bbox-shape --help
+```
+
+## Commands
+
+### add-bbox-shape
+
+Add `bbox_shape` field to existing collections for spatial search support.
+
+**Basic usage:**
+
+```bash
+# Elasticsearch
+sfeos-tools add-bbox-shape --backend elasticsearch
+
+# OpenSearch
+sfeos-tools add-bbox-shape --backend opensearch
+```
+
+**Connection options:**
+
+```bash
+# Local Docker Compose (no SSL)
+sfeos-tools add-bbox-shape --backend elasticsearch --no-ssl
+
+# Remote server with SSL
+sfeos-tools add-bbox-shape \
+  --backend elasticsearch \
+  --host db.example.com \
+  --port 9200 \
+  --user admin \
+  --password secret
+
+# Using environment variables
+ES_HOST=my-cluster.cloud.com ES_PORT=9243 ES_USER=elastic ES_PASS=changeme \
+  sfeos-tools add-bbox-shape --backend elasticsearch
+```
+
+**Available options:**
+
+- `--backend`: Database backend (elasticsearch or opensearch) - **required**
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 or ES_PORT env var)
+- `--use-ssl / --no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+## Development
+
+To develop sfeos-tools locally:
+
+```bash
+# Install in editable mode with dev dependencies
+pip install -e ./sfeos_tools[dev]
+
+# Run the CLI
+sfeos-tools --help
+
+# Run tests
+pytest
+
+# Format code
+pre-commit install
+pre-commit run --all-files
+```
+

sfeos_tools-0.1.0/README.md

@@ -0,0 +1,179 @@
+# SFEOS Tools
+
+CLI tools for managing [stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) deployments.
+
+## Table of Contents
+
+- [Installation](#installation)
+  - [For Elasticsearch](#for-elasticsearch)
+  - [For OpenSearch](#for-opensearch)
+  - [For Development](#for-development-both-backends)
+- [Usage](#usage)
+- [Commands](#commands)
+  - [add-bbox-shape](#add-bbox-shape)
+  - [reindex](#reindex)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+### For Elasticsearch
+
+```bash
+pip install sfeos-tools[elasticsearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[elasticsearch]
+```
+
+### For OpenSearch
+
+```bash
+pip install sfeos-tools[opensearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[opensearch]
+```
+
+### For Development (both backends)
+
+```bash
+pip install sfeos-tools[dev]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[dev]
+```
+
+## Usage
+
+After installation, the `sfeos-tools` command will be available:
+
+```bash
+# View available commands
+sfeos-tools --help
+
+# View version
+sfeos-tools --version
+```
+
+## Commands
+
+### add-bbox-shape
+
+Adds a `bbox_shape` field to existing collections for spatial search support. This migration is required for collections created before spatial search was added. Collections created or updated after this feature will automatically have the `bbox_shape` field.
+
+```bash
+sfeos-tools add-bbox-shape --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+### reindex
+
+Reindexes all STAC indexes to the next version and updates aliases. This command performs the following actions:
+- Creates/updates index templates
+- Reindexes collections and item indexes to a new version
+- Applies asset migration script for compatibility
+- Switches aliases to the new indexes
+
+```bash
+sfeos-tools reindex --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+- `--yes`: Skip confirmation prompt
+
+Example:
+```bash
+# Reindex Elasticsearch with custom host and no SSL
+sfeos-tools reindex --backend elasticsearch --host localhost --port 9200 --no-ssl
+
+# Reindex OpenSearch with default settings
+sfeos-tools reindex --backend opensearch
+```
+
+# Get help for a specific command
+sfeos-tools add-bbox-shape --help
+```
+
+## Commands
+
+### add-bbox-shape
+
+Add `bbox_shape` field to existing collections for spatial search support.
+
+**Basic usage:**
+
+```bash
+# Elasticsearch
+sfeos-tools add-bbox-shape --backend elasticsearch
+
+# OpenSearch
+sfeos-tools add-bbox-shape --backend opensearch
+```
+
+**Connection options:**
+
+```bash
+# Local Docker Compose (no SSL)
+sfeos-tools add-bbox-shape --backend elasticsearch --no-ssl
+
+# Remote server with SSL
+sfeos-tools add-bbox-shape \
+  --backend elasticsearch \
+  --host db.example.com \
+  --port 9200 \
+  --user admin \
+  --password secret
+
+# Using environment variables
+ES_HOST=my-cluster.cloud.com ES_PORT=9243 ES_USER=elastic ES_PASS=changeme \
+  sfeos-tools add-bbox-shape --backend elasticsearch
+```
+
+**Available options:**
+
+- `--backend`: Database backend (elasticsearch or opensearch) - **required**
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 or ES_PORT env var)
+- `--use-ssl / --no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+## Development
+
+To develop sfeos-tools locally:
+
+```bash
+# Install in editable mode with dev dependencies
+pip install -e ./sfeos_tools[dev]
+
+# Run the CLI
+sfeos-tools --help
+
+# Run tests
+pytest
+
+# Format code
+pre-commit install
+pre-commit run --all-files
+```
+

sfeos_tools-0.1.0/pyproject.toml

@@ -0,0 +1,92 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sfeos-tools"
+version = "0.1.0"
+description = "CLI tools for managing stac-fastapi-elasticsearch-opensearch deployments"
+readme = "README.md"
+authors = [
+    {name = "Jonathan Healy", email = "jon@healy-hypersaptial.dev"},
+    {name = "CloudFerro S.A."}
+]
+license = {file = "LICENSE"}
+maintainers = [
+    {name = "Jonathan Healy", email = "jon@healy-hypersaptial.dev"}
+]
+requires-python = ">=3.8"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+dependencies = [
+    "click>=8.0.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Healy-Hyperspatial/sfeos-tools"
+Documentation = "https://github.com/Healy-Hyperspatial/sfeos-tools#readme"
+Issues = "https://github.com/Healy-Hyperspatial/sfeos-tools/issues"
+Source = "https://github.com/Healy-Hyperspatial/sfeos-tools"
+
+[project.optional-dependencies]
+elasticsearch = [
+    "stac-fastapi-elasticsearch",
+]
+opensearch = [
+    "stac-fastapi-opensearch",
+]
+dev = [
+    "stac-fastapi-elasticsearch",
+    "stac-fastapi-opensearch",
+    # Development tools
+    "pytest>=6.0",
+    "pytest-cov>=2.0",
+    "black>=21.0",
+    "isort>=5.0",
+    "mypy>=0.900",
+    "flake8>=4.0.0",
+]
+
+[project.scripts]
+sfeos-tools = "sfeos_tools.cli:cli"
+
+[tool.black]
+line-length = 88
+target-version = ["py38"]
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = false
+use_parentheses = true
+ensure_newline_before_comments = true
+line_length = 88
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+addopts = "-v --cov=sfeos_tool --cov-report=term-missing"
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "pass",
+    "raise ImportError",
+]

sfeos_tools-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sfeos_tools-0.1.0/sfeos_tools/__init__.py

@@ -0,0 +1,3 @@
+"""SFEOS Tools - Utilities for managing stac-fastapi-elasticsearch-opensearch deployments."""
+
+__version__ = "0.1.0"

sfeos_tools-0.1.0/sfeos_tools/cli.py

@@ -0,0 +1,336 @@
+"""SFEOS CLI Tools - Utilities for managing stac-fastapi-elasticsearch-opensearch deployments.
+
+This tool provides various utilities for managing and maintaining SFEOS deployments,
+including database migrations, maintenance tasks, and more.
+
+Usage:
+    sfeos-tools add-bbox-shape --backend elasticsearch
+    sfeos-tools add-bbox-shape --backend opensearch
+"""
+
+import asyncio
+import logging
+import sys
+
+import click
+from stac_fastapi.sfeos_helpers.database import add_bbox_shape_to_collection
+from stac_fastapi.sfeos_helpers.mappings import COLLECTIONS_INDEX
+
+from .reindex import run as unified_reindex_run
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
+async def process_collection_bbox_shape(client, collection_doc, backend):
+    """Process a single collection document to add bbox_shape field.
+
+    Args:
+        client: Elasticsearch/OpenSearch client
+        collection_doc: Collection document from database
+        backend: Backend type ('elasticsearch' or 'opensearch')
+
+    Returns:
+        bool: True if collection was updated, False if no update was needed
+    """
+    collection = collection_doc["_source"]
+    collection_id = collection.get("id", collection_doc["_id"])
+
+    # Use the shared function to add bbox_shape
+    was_added = add_bbox_shape_to_collection(collection)
+
+    if not was_added:
+        return False
+
+    # Update the collection in the database
+    if backend == "elasticsearch":
+        await client.index(
+            index=COLLECTIONS_INDEX,
+            id=collection_id,
+            document=collection,
+            refresh=True,
+        )
+    else:  # opensearch
+        await client.index(
+            index=COLLECTIONS_INDEX,
+            id=collection_id,
+            body=collection,
+            refresh=True,
+        )
+
+    logger.info(f"Collection '{collection_id}': Added bbox_shape field")
+    return True
+
+
+async def run_add_bbox_shape(backend):
+    """Add bbox_shape field to all existing collections.
+
+    Args:
+        backend: Backend type ('elasticsearch' or 'opensearch')
+    """
+    import os
+
+    logger.info(
+        f"Starting migration: Adding bbox_shape to existing collections ({backend})"
+    )
+
+    # Log connection info (showing what will be used by the client)
+    es_host = os.getenv("ES_HOST", "localhost")
+    es_port = os.getenv(
+        "ES_PORT", "9200"
+    )  # Both backends default to 9200 in their config
+    es_use_ssl = os.getenv("ES_USE_SSL", "true")
+    logger.info(f"Connecting to {backend} at {es_host}:{es_port} (SSL: {es_use_ssl})")
+
+    # Create client based on backend
+    if backend == "elasticsearch":
+        from stac_fastapi.elasticsearch.config import AsyncElasticsearchSettings
+
+        settings = AsyncElasticsearchSettings()
+    else:  # opensearch
+        from stac_fastapi.opensearch.config import AsyncOpensearchSettings
+
+        settings = AsyncOpensearchSettings()
+
+    client = settings.create_client
+
+    try:
+        # Get all collections
+        response = await client.search(
+            index=COLLECTIONS_INDEX,
+            body={
+                "query": {"match_all": {}},
+                "size": 10000,
+            },  # Adjust size if you have more collections
+        )
+
+        total_collections = response["hits"]["total"]["value"]
+        logger.info(f"Found {total_collections} collections to process")
+
+        updated_count = 0
+        skipped_count = 0
+
+        for hit in response["hits"]["hits"]:
+            was_updated = await process_collection_bbox_shape(client, hit, backend)
+            if was_updated:
+                updated_count += 1
+            else:
+                skipped_count += 1
+
+        logger.info(
+            f"Migration complete: {updated_count} collections updated, {skipped_count} skipped"
+        )
+
+    except Exception as e:
+        logger.error(f"Migration failed with error: {e}")
+        raise
+    finally:
+        await client.close()
+
+
+@click.group()
+@click.version_option(version="0.1.0", prog_name="sfeos-tools")
+def cli():
+    """SFEOS Tools - Utilities for managing stac-fastapi-elasticsearch-opensearch deployments."""
+    pass
+
+
+@cli.command("add-bbox-shape")
+@click.option(
+    "--backend",
+    type=click.Choice(["elasticsearch", "opensearch"], case_sensitive=False),
+    required=True,
+    help="Database backend to use",
+)
+@click.option(
+    "--host",
+    type=str,
+    default=None,
+    help="Database host (default: localhost or ES_HOST env var)",
+)
+@click.option(
+    "--port",
+    type=int,
+    default=None,
+    help="Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)",
+)
+@click.option(
+    "--use-ssl/--no-ssl",
+    default=None,
+    help="Use SSL connection (default: true or ES_USE_SSL env var)",
+)
+@click.option(
+    "--user",
+    type=str,
+    default=None,
+    help="Database username (default: ES_USER env var)",
+)
+@click.option(
+    "--password",
+    type=str,
+    default=None,
+    help="Database password (default: ES_PASS env var)",
+)
+def add_bbox_shape(backend, host, port, use_ssl, user, password):
+    """Add bbox_shape field to existing collections for spatial search support.
+
+    This migration is required for collections created before spatial search
+    was added. Collections created or updated after this feature will
+    automatically have the bbox_shape field.
+
+    Examples:
+        sfeos_tools.py add-bbox-shape --backend elasticsearch
+        sfeos_tools.py add-bbox-shape --backend opensearch --host db.example.com --port 9200
+        sfeos_tools.py add-bbox-shape --backend elasticsearch --no-ssl --host localhost
+    """
+    import os
+
+    # Set environment variables from CLI options if provided
+    if host:
+        os.environ["ES_HOST"] = host
+    if port:
+        os.environ["ES_PORT"] = str(port)
+    if use_ssl is not None:
+        os.environ["ES_USE_SSL"] = "true" if use_ssl else "false"
+    if user:
+        os.environ["ES_USER"] = user
+    if password:
+        os.environ["ES_PASS"] = password
+
+    try:
+        asyncio.run(run_add_bbox_shape(backend.lower()))
+        click.echo(click.style("✓ Migration completed successfully", fg="green"))
+    except KeyboardInterrupt:
+        click.echo(click.style("\n✗ Migration interrupted by user", fg="yellow"))
+        sys.exit(1)
+    except Exception as e:
+        error_msg = str(e)
+        click.echo(click.style(f"✗ Migration failed: {error_msg}", fg="red"))
+
+        # Provide helpful hints for common errors
+        if "TLS" in error_msg or "SSL" in error_msg:
+            click.echo(
+                click.style(
+                    "\n💡 Hint: If you're connecting to a local Docker Compose instance, "
+                    "try adding --no-ssl flag",
+                    fg="yellow",
+                )
+            )
+        elif "Connection refused" in error_msg:
+            click.echo(
+                click.style(
+                    "\n💡 Hint: Make sure your database is running and accessible at the specified host:port",
+                    fg="yellow",
+                )
+            )
+        sys.exit(1)
+
+
+@cli.command("reindex")
+@click.option(
+    "--backend",
+    type=click.Choice(["elasticsearch", "opensearch"], case_sensitive=False),
+    required=True,
+    help="Database backend to use",
+)
+@click.option(
+    "--host",
+    type=str,
+    default=None,
+    help="Database host (default: localhost or ES_HOST env var)",
+)
+@click.option(
+    "--port",
+    type=int,
+    default=None,
+    help="Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)",
+)
+@click.option(
+    "--use-ssl/--no-ssl",
+    default=None,
+    help="Use SSL connection (default: true or ES_USE_SSL env var)",
+)
+@click.option(
+    "--user",
+    type=str,
+    default=None,
+    help="Database username (default: ES_USER env var)",
+)
+@click.option(
+    "--password",
+    type=str,
+    default=None,
+    help="Database password (default: ES_PASS env var)",
+)
+@click.option(
+    "--yes",
+    is_flag=True,
+    help="Skip confirmation prompt",
+)
+def reindex(backend, host, port, use_ssl, user, password, yes):
+    """Reindex all STAC indexes to the next version and update aliases.
+
+    For Elasticsearch, this runs a migration that:
+    - Creates/updates index templates
+    - Reindexes collections and item indexes to a new version
+    - Applies asset migration script for compatibility
+    - Switches aliases to the new indexes
+    """
+    import os
+
+    backend = backend.lower()
+
+    if not yes:
+        proceed = click.confirm(
+            "This will reindex all collections and item indexes and update aliases. Proceed?",
+            default=False,
+        )
+        if not proceed:
+            click.echo(click.style("Aborted", fg="yellow"))
+            return
+
+    # Set environment variables from CLI options if provided
+    if host:
+        os.environ["ES_HOST"] = host
+    if port:
+        os.environ["ES_PORT"] = str(port)
+    if use_ssl is not None:
+        os.environ["ES_USE_SSL"] = "true" if use_ssl else "false"
+    if user:
+        os.environ["ES_USER"] = user
+    if password:
+        os.environ["ES_PASS"] = password
+
+    try:
+        asyncio.run(unified_reindex_run(backend))
+        click.echo(
+            click.style(
+                f"✓ Reindex ({backend.title()}) completed successfully", fg="green"
+            )
+        )
+    except KeyboardInterrupt:
+        click.echo(click.style("\n✗ Reindex interrupted by user", fg="yellow"))
+        sys.exit(1)
+    except Exception as e:
+        error_msg = str(e)
+        click.echo(click.style(f"✗ Reindex failed: {error_msg}", fg="red"))
+        # Provide helpful hints for common errors
+        if "TLS" in error_msg or "SSL" in error_msg:
+            click.echo(
+                click.style(
+                    "\n💡 Hint: If you're connecting to a local Docker Compose instance, try adding --no-ssl flag",
+                    fg="yellow",
+                )
+            )
+        elif "Connection refused" in error_msg:
+            click.echo(
+                click.style(
+                    "\n💡 Hint: Make sure your database is running and accessible at the specified host:port",
+                    fg="yellow",
+                )
+            )
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    cli()

sfeos_tools-0.1.0/sfeos_tools/reindex.py

@@ -0,0 +1,122 @@
+"""Reindex ES/OS database for mapping update."""
+
+import asyncio
+import time
+from typing import Any, Dict
+
+from stac_fastapi.sfeos_helpers.mappings import COLLECTIONS_INDEX, ITEMS_INDEX_PREFIX
+
+
+async def _reindex_single_index(
+    client, index: str, new_index: str, aliases: Dict[str, Any]
+):
+    """Reindex a single index to a new version and switch aliases."""
+    print(f"reindexing {index} to {new_index}")
+
+    await client.options(ignore_status=400).indices.create(index=new_index)
+
+    # Asset migration script for data compatibility
+    script = {
+        "source": (
+            "if (ctx._source.containsKey('assets')){List l = new ArrayList();"
+            "for (key in ctx._source.assets.keySet()) {def item = ctx._source.assets[key];"
+            " item['es_key'] = key; l.add(item)}ctx._source.assets=l} "
+            "if (ctx._source.containsKey('item_assets')){ List a = new ArrayList();"
+            " for (key in ctx._source.item_assets.keySet()) {def item = ctx._source.item_assets[key];"
+            " item['es_key'] = key; a.add(item)}ctx._source.item_assets=a}"
+        ),
+        "lang": "painless",
+    }
+
+    reindex_resp = await client.reindex(
+        dest={"index": new_index},
+        source={"index": [index]},
+        wait_for_completion=False,
+        script=script,
+    )
+
+    task_id = reindex_resp["task"]
+
+    reindex_complete = False
+    while not reindex_complete:
+        task_resp = await client.tasks.get(task_id=task_id)
+
+        if "completed" in task_resp and task_resp["completed"]:
+            reindex_complete = True
+        elif "error" in task_resp:
+            reindex_complete = True
+            print(f"Reindex failed for {index} with error: {task_resp['error']}")
+        else:
+            time.sleep(60)
+
+    actions = []
+    for alias in aliases["aliases"]:
+        actions.extend(
+            [
+                {"add": {"index": new_index, "alias": alias}},
+                {"remove": {"index": index, "alias": alias}},
+            ]
+        )
+
+    if actions:
+        await client.indices.update_aliases(actions=actions)
+
+
+async def run(backend: str = "elasticsearch"):
+    """Reindex all STAC indexes for mapping update for the given backend.
+
+    backend: 'elasticsearch' or 'opensearch'
+    """
+    backend = backend.lower()
+
+    # Lazy imports so the package dependencies remain optional per backend
+    if backend == "elasticsearch":
+        from stac_fastapi.elasticsearch.config import AsyncElasticsearchSettings
+        from stac_fastapi.elasticsearch.database_logic import create_index_templates
+
+        settings = AsyncElasticsearchSettings()
+    elif backend == "opensearch":
+        from stac_fastapi.opensearch.config import AsyncOpensearchSettings
+        from stac_fastapi.opensearch.database_logic import create_index_templates
+
+        settings = AsyncOpensearchSettings()
+    else:
+        raise ValueError(f"Unsupported backend: {backend}")
+
+    client = settings.create_client
+
+    try:
+        # Ensure latest templates are applied
+        await create_index_templates()
+
+        # Collections index
+        collection_response = await client.indices.get_alias(name=COLLECTIONS_INDEX)
+        collections = await client.search(index=COLLECTIONS_INDEX)
+
+        collection_index, collection_aliases = next(iter(collection_response.items()))
+        collection_index_name, version = collection_index.rsplit("-", 1)
+        new_collection_index = (
+            f"{collection_index_name}-{str(int(version) + 1).zfill(6)}"
+        )
+
+        await _reindex_single_index(
+            client, collection_index, new_collection_index, collection_aliases
+        )
+
+        # Items per collection
+        for collection in collections["hits"]["hits"]:
+            item_indexes = await client.indices.get_alias(
+                name=f"{ITEMS_INDEX_PREFIX}{collection['_id']}*"
+            )
+
+            for item_index, aliases in item_indexes.items():
+                item_index_name, version = item_index.rsplit("-", 1)
+                new_item_index = f"{item_index_name}-{str(int(version) + 1).zfill(6)}"
+
+                await _reindex_single_index(client, item_index, new_item_index, aliases)
+    finally:
+        await client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(run("elasticsearch"))

sfeos_tools-0.1.0/sfeos_tools.egg-info/PKG-INFO

@@ -0,0 +1,243 @@
+Metadata-Version: 2.4
+Name: sfeos-tools
+Version: 0.1.0
+Summary: CLI tools for managing stac-fastapi-elasticsearch-opensearch deployments
+Author: CloudFerro S.A.
+Author-email: Jonathan Healy <jon@healy-hypersaptial.dev>
+Maintainer-email: Jonathan Healy <jon@healy-hypersaptial.dev>
+License: MIT License
+        
+        Copyright (c) 2025 Healy Hyperspatial, Jonathan Healy and CloudFerro S.A.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/Healy-Hyperspatial/sfeos-tools
+Project-URL: Documentation, https://github.com/Healy-Hyperspatial/sfeos-tools#readme
+Project-URL: Issues, https://github.com/Healy-Hyperspatial/sfeos-tools/issues
+Project-URL: Source, https://github.com/Healy-Hyperspatial/sfeos-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Provides-Extra: elasticsearch
+Requires-Dist: stac-fastapi-elasticsearch; extra == "elasticsearch"
+Provides-Extra: opensearch
+Requires-Dist: stac-fastapi-opensearch; extra == "opensearch"
+Provides-Extra: dev
+Requires-Dist: stac-fastapi-elasticsearch; extra == "dev"
+Requires-Dist: stac-fastapi-opensearch; extra == "dev"
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: isort>=5.0; extra == "dev"
+Requires-Dist: mypy>=0.900; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: license-file
+
+# SFEOS Tools
+
+CLI tools for managing [stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch) deployments.
+
+## Table of Contents
+
+- [Installation](#installation)
+  - [For Elasticsearch](#for-elasticsearch)
+  - [For OpenSearch](#for-opensearch)
+  - [For Development](#for-development-both-backends)
+- [Usage](#usage)
+- [Commands](#commands)
+  - [add-bbox-shape](#add-bbox-shape)
+  - [reindex](#reindex)
+- [Development](#development)
+- [License](#license)
+
+## Installation
+
+### For Elasticsearch
+
+```bash
+pip install sfeos-tools[elasticsearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[elasticsearch]
+```
+
+### For OpenSearch
+
+```bash
+pip install sfeos-tools[opensearch]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[opensearch]
+```
+
+### For Development (both backends)
+
+```bash
+pip install sfeos-tools[dev]
+```
+
+Or for local development:
+```bash
+pip install -e sfeos_tools[dev]
+```
+
+## Usage
+
+After installation, the `sfeos-tools` command will be available:
+
+```bash
+# View available commands
+sfeos-tools --help
+
+# View version
+sfeos-tools --version
+```
+
+## Commands
+
+### add-bbox-shape
+
+Adds a `bbox_shape` field to existing collections for spatial search support. This migration is required for collections created before spatial search was added. Collections created or updated after this feature will automatically have the `bbox_shape` field.
+
+```bash
+sfeos-tools add-bbox-shape --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+### reindex
+
+Reindexes all STAC indexes to the next version and updates aliases. This command performs the following actions:
+- Creates/updates index templates
+- Reindexes collections and item indexes to a new version
+- Applies asset migration script for compatibility
+- Switches aliases to the new indexes
+
+```bash
+sfeos-tools reindex --backend [elasticsearch|opensearch] [options]
+```
+
+Options:
+- `--backend`: Database backend to use (required, choices: elasticsearch, opensearch)
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 for ES, 9202 for OS, or ES_PORT env var)
+- `--use-ssl/--no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+- `--yes`: Skip confirmation prompt
+
+Example:
+```bash
+# Reindex Elasticsearch with custom host and no SSL
+sfeos-tools reindex --backend elasticsearch --host localhost --port 9200 --no-ssl
+
+# Reindex OpenSearch with default settings
+sfeos-tools reindex --backend opensearch
+```
+
+# Get help for a specific command
+sfeos-tools add-bbox-shape --help
+```
+
+## Commands
+
+### add-bbox-shape
+
+Add `bbox_shape` field to existing collections for spatial search support.
+
+**Basic usage:**
+
+```bash
+# Elasticsearch
+sfeos-tools add-bbox-shape --backend elasticsearch
+
+# OpenSearch
+sfeos-tools add-bbox-shape --backend opensearch
+```
+
+**Connection options:**
+
+```bash
+# Local Docker Compose (no SSL)
+sfeos-tools add-bbox-shape --backend elasticsearch --no-ssl
+
+# Remote server with SSL
+sfeos-tools add-bbox-shape \
+  --backend elasticsearch \
+  --host db.example.com \
+  --port 9200 \
+  --user admin \
+  --password secret
+
+# Using environment variables
+ES_HOST=my-cluster.cloud.com ES_PORT=9243 ES_USER=elastic ES_PASS=changeme \
+  sfeos-tools add-bbox-shape --backend elasticsearch
+```
+
+**Available options:**
+
+- `--backend`: Database backend (elasticsearch or opensearch) - **required**
+- `--host`: Database host (default: localhost or ES_HOST env var)
+- `--port`: Database port (default: 9200 or ES_PORT env var)
+- `--use-ssl / --no-ssl`: Use SSL connection (default: true or ES_USE_SSL env var)
+- `--user`: Database username (default: ES_USER env var)
+- `--password`: Database password (default: ES_PASS env var)
+
+## Development
+
+To develop sfeos-tools locally:
+
+```bash
+# Install in editable mode with dev dependencies
+pip install -e ./sfeos_tools[dev]
+
+# Run the CLI
+sfeos-tools --help
+
+# Run tests
+pytest
+
+# Format code
+pre-commit install
+pre-commit run --all-files
+```
+

sfeos_tools-0.1.0/sfeos_tools.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+sfeos_tools/__init__.py
+sfeos_tools/cli.py
+sfeos_tools/reindex.py
+sfeos_tools.egg-info/PKG-INFO
+sfeos_tools.egg-info/SOURCES.txt
+sfeos_tools.egg-info/dependency_links.txt
+sfeos_tools.egg-info/entry_points.txt
+sfeos_tools.egg-info/requires.txt
+sfeos_tools.egg-info/top_level.txt

sfeos_tools-0.1.0/sfeos_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sfeos_tools-0.1.0/sfeos_tools.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sfeos-tools = sfeos_tools.cli:cli

sfeos_tools-0.1.0/sfeos_tools.egg-info/requires.txt

@@ -0,0 +1,17 @@
+click>=8.0.0
+
+[dev]
+stac-fastapi-elasticsearch
+stac-fastapi-opensearch
+pytest>=6.0
+pytest-cov>=2.0
+black>=21.0
+isort>=5.0
+mypy>=0.900
+flake8>=4.0.0
+
+[elasticsearch]
+stac-fastapi-elasticsearch
+
+[opensearch]
+stac-fastapi-opensearch

sfeos_tools-0.1.0/sfeos_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+sfeos_tools