stac-valid 4.2.2__tar.gz → 4.3.0__tar.gz

{stac_valid-4.2.2/stac_valid.egg-info → stac_valid-4.3.0}/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: stac_valid
-Version: 4.2.2
+Version: 4.3.0
 Summary: A package to validate STAC files
 Author: James Banting
 Author-email: Jonathan Healy <jon@healy-hyperspatial.dev>
+Maintainer: Healy Hyperspatial
+Maintainer-email: Jonathan Healy <jon@healy-hyperspatial.dev>
 License: Apache-2.0
 Project-URL: Homepage, https://github.com/stac-utils/stac-validator
 Project-URL: Repository, https://github.com/stac-utils/stac-validator
@@ -38,6 +40,9 @@ Requires-Dist: types-jsonschema; extra == "dev"
 Requires-Dist: types-tqdm; extra == "dev"
 Provides-Extra: pydantic
 Requires-Dist: stac-pydantic>=3.3.0; extra == "pydantic"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.111.0; extra == "server"
+Requires-Dist: uvicorn>=0.30.0; extra == "server"
 Dynamic: license-file
 
 # SpatioTemporal Asset Catalog Validator
@@ -52,7 +57,7 @@ Dynamic: license-file
   [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-validator?color=blue)](https://github.com/stac-utils/stac-validator/graphs/contributors)
   [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/stargazers)
   [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/network/members)
-   [![PyPI version](https://img.shields.io/pypi/v/stac-validator.svg?color=blue)](https://pypi.org/project/stac-validator/)
+   [![PyPI version](https://img.shields.io/pypi/v/stac-valid.svg?color=blue)](https://pypi.org/project/stac-valid/)
   [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
 
 
@@ -88,6 +93,7 @@ Dynamic: license-file
     - [Legacy Validation](#legacy-validation)
   - [Batch Validation](#batch-validation)
   - [Fast Validation](#fast-validation)
+  - [API Server (FastAPI)](#api-server-fastapi)
   - [Python](#python)
 - [Schema Cache Settings](#schema-cache-settings)
 - [Performance Benchmarking](#performance-benchmarking)
@@ -710,6 +716,50 @@ else:
 | Development/testing | `fast` | Instant feedback, detailed metrics, minimal overhead |
 | Complex validation rules | `validate` | Full control over validation options, recursive validation |
 
+#### API Server (FastAPI)
+
+The `fast` validation engine can be deployed as a high-performance REST API, ideal for validating STAC objects during ingestion or as part of a microservices architecture.
+
+**Running the Server (Local):**
+```bash
+# Requires fastapi and uvicorn
+pip install "stac-valid[server]" 
+python server/server.py
+```
+
+**Running the Server (Docker):**
+```bash
+# Pull and run the official GitHub container image
+docker run -p 8000:8000 ghcr.io/stac-utils/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/test_api.py sample_data/item.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/item.json
+```
+
+**Response Format:**
+The API returns a detailed JSON summary including performance metrics and error breakdowns:
+```json
+{
+  "path": "request_body",
+  "valid_stac": true,
+  "total_objects": 100,
+  "valid_objects": 100,
+  "invalid_objects": 0,
+  "setup_time_ms": 0.25,
+  "execution_time_ms": 25.4,
+  "errors": []
+}
+```
+
 ### Python
 
 **Single File Validation**

{stac_valid-4.2.2 → stac_valid-4.3.0}/README.md

@@ -10,7 +10,7 @@
   [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-validator?color=blue)](https://github.com/stac-utils/stac-validator/graphs/contributors)
   [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/stargazers)
   [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/network/members)
-   [![PyPI version](https://img.shields.io/pypi/v/stac-validator.svg?color=blue)](https://pypi.org/project/stac-validator/)
+   [![PyPI version](https://img.shields.io/pypi/v/stac-valid.svg?color=blue)](https://pypi.org/project/stac-valid/)
   [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
 
 
@@ -46,6 +46,7 @@
     - [Legacy Validation](#legacy-validation)
   - [Batch Validation](#batch-validation)
   - [Fast Validation](#fast-validation)
+  - [API Server (FastAPI)](#api-server-fastapi)
   - [Python](#python)
 - [Schema Cache Settings](#schema-cache-settings)
 - [Performance Benchmarking](#performance-benchmarking)
@@ -668,6 +669,50 @@ else:
 | Development/testing | `fast` | Instant feedback, detailed metrics, minimal overhead |
 | Complex validation rules | `validate` | Full control over validation options, recursive validation |
 
+#### API Server (FastAPI)
+
+The `fast` validation engine can be deployed as a high-performance REST API, ideal for validating STAC objects during ingestion or as part of a microservices architecture.
+
+**Running the Server (Local):**
+```bash
+# Requires fastapi and uvicorn
+pip install "stac-valid[server]" 
+python server/server.py
+```
+
+**Running the Server (Docker):**
+```bash
+# Pull and run the official GitHub container image
+docker run -p 8000:8000 ghcr.io/stac-utils/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/test_api.py sample_data/item.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/item.json
+```
+
+**Response Format:**
+The API returns a detailed JSON summary including performance metrics and error breakdowns:
+```json
+{
+  "path": "request_body",
+  "valid_stac": true,
+  "total_objects": 100,
+  "valid_objects": 100,
+  "invalid_objects": 0,
+  "setup_time_ms": 0.25,
+  "execution_time_ms": 25.4,
+  "errors": []
+}
+```
+
 ### Python
 
 **Single File Validation**

{stac_valid-4.2.2 → stac_valid-4.3.0}/pyproject.toml

@@ -4,12 +4,16 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "stac_valid"
-version = "4.2.2"
+version = "4.3.0"
 description = "A package to validate STAC files"
 authors = [
     {name = "James Banting"},
     {name = "Jonathan Healy", email = "jon@healy-hyperspatial.dev"}
 ]
+maintainers = [
+    {name = "Jonathan Healy", email = "jon@healy-hyperspatial.dev"},
+    {name = "Healy Hyperspatial"}
+]
 license = {text = "Apache-2.0"}
 classifiers = [
     "Intended Audience :: Information Technology",
@@ -48,6 +52,10 @@ dev = [
 pydantic = [
     "stac-pydantic>=3.3.0"
 ]
+server = [
+    "fastapi>=0.111.0",
+    "uvicorn>=0.30.0"
+]
 
 [project.urls]
 Homepage = "https://github.com/stac-utils/stac-validator"

{stac_valid-4.2.2 → stac_valid-4.3.0/stac_valid.egg-info}/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: stac_valid
-Version: 4.2.2
+Version: 4.3.0
 Summary: A package to validate STAC files
 Author: James Banting
 Author-email: Jonathan Healy <jon@healy-hyperspatial.dev>
+Maintainer: Healy Hyperspatial
+Maintainer-email: Jonathan Healy <jon@healy-hyperspatial.dev>
 License: Apache-2.0
 Project-URL: Homepage, https://github.com/stac-utils/stac-validator
 Project-URL: Repository, https://github.com/stac-utils/stac-validator
@@ -38,6 +40,9 @@ Requires-Dist: types-jsonschema; extra == "dev"
 Requires-Dist: types-tqdm; extra == "dev"
 Provides-Extra: pydantic
 Requires-Dist: stac-pydantic>=3.3.0; extra == "pydantic"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.111.0; extra == "server"
+Requires-Dist: uvicorn>=0.30.0; extra == "server"
 Dynamic: license-file
 
 # SpatioTemporal Asset Catalog Validator
@@ -52,7 +57,7 @@ Dynamic: license-file
   [![GitHub contributors](https://img.shields.io/github/contributors/stac-utils/stac-validator?color=blue)](https://github.com/stac-utils/stac-validator/graphs/contributors)
   [![GitHub stars](https://img.shields.io/github/stars/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/stargazers)
   [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-validator.svg?color=blue)](https://github.com/stac-utils/stac-validator/network/members)
-   [![PyPI version](https://img.shields.io/pypi/v/stac-validator.svg?color=blue)](https://pypi.org/project/stac-validator/)
+   [![PyPI version](https://img.shields.io/pypi/v/stac-valid.svg?color=blue)](https://pypi.org/project/stac-valid/)
   [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
 
 
@@ -88,6 +93,7 @@ Dynamic: license-file
     - [Legacy Validation](#legacy-validation)
   - [Batch Validation](#batch-validation)
   - [Fast Validation](#fast-validation)
+  - [API Server (FastAPI)](#api-server-fastapi)
   - [Python](#python)
 - [Schema Cache Settings](#schema-cache-settings)
 - [Performance Benchmarking](#performance-benchmarking)
@@ -710,6 +716,50 @@ else:
 | Development/testing | `fast` | Instant feedback, detailed metrics, minimal overhead |
 | Complex validation rules | `validate` | Full control over validation options, recursive validation |
 
+#### API Server (FastAPI)
+
+The `fast` validation engine can be deployed as a high-performance REST API, ideal for validating STAC objects during ingestion or as part of a microservices architecture.
+
+**Running the Server (Local):**
+```bash
+# Requires fastapi and uvicorn
+pip install "stac-valid[server]" 
+python server/server.py
+```
+
+**Running the Server (Docker):**
+```bash
+# Pull and run the official GitHub container image
+docker run -p 8000:8000 ghcr.io/stac-utils/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/test_api.py sample_data/item.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/item.json
+```
+
+**Response Format:**
+The API returns a detailed JSON summary including performance metrics and error breakdowns:
+```json
+{
+  "path": "request_body",
+  "valid_stac": true,
+  "total_objects": 100,
+  "valid_objects": 100,
+  "invalid_objects": 0,
+  "setup_time_ms": 0.25,
+  "execution_time_ms": 25.4,
+  "errors": []
+}
+```
+
 ### Python
 
 **Single File Validation**

{stac_valid-4.2.2 → stac_valid-4.3.0}/stac_valid.egg-info/requires.txt

@@ -22,3 +22,7 @@ types-tqdm
 
 [pydantic]
 stac-pydantic>=3.3.0
+
+[server]
+fastapi>=0.111.0
+uvicorn>=0.30.0

{stac_valid-4.2.2 → stac_valid-4.3.0}/stac_validator/fast_validator.py

@@ -3,7 +3,7 @@ import os
 import time
 import urllib.error
 import urllib.request
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Set
 
 import click
 import fastjsonschema  # type: ignore
@@ -110,7 +110,7 @@ def get_validator(stac_type: str, stac_version: str, extensions: List[str]):
         import jsonschema
 
         # Create a validator using the same custom logic
-        def fallback_validator(data):
+        def fallback_validator(data: Dict[str, Any]) -> None:
             # We need a resolver to handle the remote $refs
             resolver = jsonschema.RefResolver(
                 base_uri="",
@@ -200,8 +200,8 @@ class FastValidator:
         valid_count = 0
         invalid_count = 0
         error_registry: Dict[str, List[str]] = {}
-        stac_versions_found: set = set()
-        schemas_checked: set = set()
+        stac_versions_found: Set[str] = set()
+        schemas_checked: Set[str] = set()
 
         for index, item in enumerate(items_to_validate):
             # Determine specific STAC attributes for this object

{stac_valid-4.2.2 → stac_valid-4.3.0}/stac_validator/utilities.py

@@ -3,7 +3,7 @@ import json
 import logging
 import os
 import ssl
-from typing import Dict, Optional, Tuple
+from typing import Dict, Optional, Set, Tuple
 from urllib.parse import urlparse
 from urllib.request import Request, urlopen
 
@@ -233,7 +233,7 @@ def _fetch_and_parse_schema_cache_clear() -> None:
     _schema_cache.cache_clear()
 
 
-_cached_schemas = set()
+_cached_schemas: Set[str] = set()
 
 
 def _map_extension_url_to_local(url: str) -> str: