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

{stac_valid-4.2.2 → stac_valid-4.4.0}/PKG-INFO

@@ -1,9 +1,11 @@
 Metadata-Version: 2.4
 Name: stac_valid
-Version: 4.2.2
+Version: 4.4.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)
@@ -352,6 +358,12 @@ Options:
   -q, --quiet    Suppress individual item logs.
   -v, --verbose  Show full validation logs for all items. By default, only
                  invalid items are shown.
+    -r, --recursive  Recursively validate all child catalogs, collections,
+                                     and items.
+    -a, --api        Validate a STAC API catalog recursively (follows data,
+                                     child, item, and items links).
+    --limit INTEGER RANGE  Limit number of STAC objects to validate.
+                                                 [x>=1]
   --help         Show this message and exit.
 ```
 
@@ -554,6 +566,8 @@ The `fast` command provides ultra-high-speed validation using `fastjsonschema` w
 - **Multi-tier caching:** RAM → Disk → Network with automatic fallback
 - **Local schema storage:** Schemas cached locally under `local_schemas/.schemas` directory for instant reuse
 - **Automatic detection:** Detects STAC type (Item, Collection, Catalog, FeatureCollection) automatically
+- **Recursive traversal:** Supports `--recursive` for local catalog/collection graphs
+- **STAC API traversal:** Supports `--api` to follow STAC API data, child, item, and items links
 - **Detailed metrics:** Shows setup time, execution time, and cache hit status for each item
 - **Error grouping:** Groups validation errors by type and shows affected items
 
@@ -582,8 +596,17 @@ $ stac-validator fast item.json --quiet
 # Show detailed output for all items (default shows first 5)
 $ stac-validator fast collection.json --verbose
 
+# Validate only first 25 objects in a large FeatureCollection
+$ stac-validator fast collection.json --limit 25
+
+# Recursively validate a local catalog graph
+$ stac-validator fast catalog.json --recursive
+
+# Recursively validate a STAC API root endpoint
+$ stac-validator fast https://api.example.com --api
+
 # Combine options
-$ stac-validator fast collection.json --verbose --quiet  # Quiet takes precedence
+$ stac-validator fast collection.json --verbose --limit 50
 ```
 
 **Example Output**
@@ -710,6 +733,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/staclabs/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/api_client_example.py sample_data/sentinel-cogs_0_100.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/sentinel-cogs_0_100.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**
@@ -865,6 +932,10 @@ import json
 fv = FastValidator("large_collection.json", quiet=True)
 fv.run()
 
+# Optionally cap validation to the first N objects
+fv_limited = FastValidator("large_collection.json", quiet=True, limit=100)
+fv_limited.run()
+
 # Access validation results via the message attribute
 print(json.dumps(fv.message, indent=2))
 

stac_valid-4.2.2/stac_valid.egg-info/PKG-INFO → stac_valid-4.4.0/README.md

@@ -1,45 +1,3 @@
-Metadata-Version: 2.4
-Name: stac_valid
-Version: 4.2.2
-Summary: A package to validate STAC files
-Author: James Banting
-Author-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
-Keywords: STAC,validation,raster
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Topic :: Scientific/Engineering :: GIS
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.32.3
-Requires-Dist: jsonschema>=4.23.0
-Requires-Dist: fastjsonschema>=2.21.1
-Requires-Dist: click>=8.1.8
-Requires-Dist: referencing>=0.35.1
-Requires-Dist: pyYAML>=6.0.1
-Requires-Dist: tqdm>=4.66.0
-Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: pytest-mypy; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: requests-mock; extra == "dev"
-Requires-Dist: types-setuptools; extra == "dev"
-Requires-Dist: stac-pydantic>=3.3.0; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: types-attrs; extra == "dev"
-Requires-Dist: types-requests; extra == "dev"
-Requires-Dist: types-jsonschema; extra == "dev"
-Requires-Dist: types-tqdm; extra == "dev"
-Provides-Extra: pydantic
-Requires-Dist: stac-pydantic>=3.3.0; extra == "pydantic"
-Dynamic: license-file
-
 # SpatioTemporal Asset Catalog Validator
 
 <!-- markdownlint-disable MD033 MD041 -->
@@ -52,7 +10,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 +46,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)
@@ -352,6 +311,12 @@ Options:
   -q, --quiet    Suppress individual item logs.
   -v, --verbose  Show full validation logs for all items. By default, only
                  invalid items are shown.
+    -r, --recursive  Recursively validate all child catalogs, collections,
+                                     and items.
+    -a, --api        Validate a STAC API catalog recursively (follows data,
+                                     child, item, and items links).
+    --limit INTEGER RANGE  Limit number of STAC objects to validate.
+                                                 [x>=1]
   --help         Show this message and exit.
 ```
 
@@ -554,6 +519,8 @@ The `fast` command provides ultra-high-speed validation using `fastjsonschema` w
 - **Multi-tier caching:** RAM → Disk → Network with automatic fallback
 - **Local schema storage:** Schemas cached locally under `local_schemas/.schemas` directory for instant reuse
 - **Automatic detection:** Detects STAC type (Item, Collection, Catalog, FeatureCollection) automatically
+- **Recursive traversal:** Supports `--recursive` for local catalog/collection graphs
+- **STAC API traversal:** Supports `--api` to follow STAC API data, child, item, and items links
 - **Detailed metrics:** Shows setup time, execution time, and cache hit status for each item
 - **Error grouping:** Groups validation errors by type and shows affected items
 
@@ -582,8 +549,17 @@ $ stac-validator fast item.json --quiet
 # Show detailed output for all items (default shows first 5)
 $ stac-validator fast collection.json --verbose
 
+# Validate only first 25 objects in a large FeatureCollection
+$ stac-validator fast collection.json --limit 25
+
+# Recursively validate a local catalog graph
+$ stac-validator fast catalog.json --recursive
+
+# Recursively validate a STAC API root endpoint
+$ stac-validator fast https://api.example.com --api
+
 # Combine options
-$ stac-validator fast collection.json --verbose --quiet  # Quiet takes precedence
+$ stac-validator fast collection.json --verbose --limit 50
 ```
 
 **Example Output**
@@ -710,6 +686,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/staclabs/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/api_client_example.py sample_data/sentinel-cogs_0_100.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/sentinel-cogs_0_100.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**
@@ -865,6 +885,10 @@ import json
 fv = FastValidator("large_collection.json", quiet=True)
 fv.run()
 
+# Optionally cap validation to the first N objects
+fv_limited = FastValidator("large_collection.json", quiet=True, limit=100)
+fv_limited.run()
+
 # Access validation results via the message attribute
 print(json.dumps(fv.message, indent=2))
 

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

@@ -4,11 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "stac_valid"
-version = "4.2.2"
+version = "4.4.0"
 description = "A package to validate STAC files"
 authors = [
-    {name = "James Banting"},
-    {name = "Jonathan Healy", email = "jon@healy-hyperspatial.dev"}
+    {name = "Jonathan Healy", email = "jon@healy-hyperspatial.dev"},
+    {name = "James Banting"}
+]
+maintainers = [
+    {name = "Jonathan Healy", email = "jon@healy-hyperspatial.dev"},
+    {name = "Healy Hyperspatial"}
 ]
 license = {text = "Apache-2.0"}
 classifiers = [
@@ -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/README.md → stac_valid-4.4.0/stac_valid.egg-info/PKG-INFO

@@ -1,3 +1,50 @@
+Metadata-Version: 2.4
+Name: stac_valid
+Version: 4.4.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
+Keywords: STAC,validation,raster
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.32.3
+Requires-Dist: jsonschema>=4.23.0
+Requires-Dist: fastjsonschema>=2.21.1
+Requires-Dist: click>=8.1.8
+Requires-Dist: referencing>=0.35.1
+Requires-Dist: pyYAML>=6.0.1
+Requires-Dist: tqdm>=4.66.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: requests-mock; extra == "dev"
+Requires-Dist: types-setuptools; extra == "dev"
+Requires-Dist: stac-pydantic>=3.3.0; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-attrs; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+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
 
 <!-- markdownlint-disable MD033 MD041 -->
@@ -10,7 +57,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 +93,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)
@@ -310,6 +358,12 @@ Options:
   -q, --quiet    Suppress individual item logs.
   -v, --verbose  Show full validation logs for all items. By default, only
                  invalid items are shown.
+    -r, --recursive  Recursively validate all child catalogs, collections,
+                                     and items.
+    -a, --api        Validate a STAC API catalog recursively (follows data,
+                                     child, item, and items links).
+    --limit INTEGER RANGE  Limit number of STAC objects to validate.
+                                                 [x>=1]
   --help         Show this message and exit.
 ```
 
@@ -512,6 +566,8 @@ The `fast` command provides ultra-high-speed validation using `fastjsonschema` w
 - **Multi-tier caching:** RAM → Disk → Network with automatic fallback
 - **Local schema storage:** Schemas cached locally under `local_schemas/.schemas` directory for instant reuse
 - **Automatic detection:** Detects STAC type (Item, Collection, Catalog, FeatureCollection) automatically
+- **Recursive traversal:** Supports `--recursive` for local catalog/collection graphs
+- **STAC API traversal:** Supports `--api` to follow STAC API data, child, item, and items links
 - **Detailed metrics:** Shows setup time, execution time, and cache hit status for each item
 - **Error grouping:** Groups validation errors by type and shows affected items
 
@@ -540,8 +596,17 @@ $ stac-validator fast item.json --quiet
 # Show detailed output for all items (default shows first 5)
 $ stac-validator fast collection.json --verbose
 
+# Validate only first 25 objects in a large FeatureCollection
+$ stac-validator fast collection.json --limit 25
+
+# Recursively validate a local catalog graph
+$ stac-validator fast catalog.json --recursive
+
+# Recursively validate a STAC API root endpoint
+$ stac-validator fast https://api.example.com --api
+
 # Combine options
-$ stac-validator fast collection.json --verbose --quiet  # Quiet takes precedence
+$ stac-validator fast collection.json --verbose --limit 50
 ```
 
 **Example Output**
@@ -668,6 +733,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/staclabs/stac-validator:latest
+```
+
+**Validate via local script:**
+```bash
+python server/api_client_example.py sample_data/sentinel-cogs_0_100.json
+```
+
+**Validate via curl:**
+```bash
+curl -X POST http://localhost:8000/validate \
+  -H "Content-Type: application/json" \
+  -d @sample_data/sentinel-cogs_0_100.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**
@@ -823,6 +932,10 @@ import json
 fv = FastValidator("large_collection.json", quiet=True)
 fv.run()
 
+# Optionally cap validation to the first N objects
+fv_limited = FastValidator("large_collection.json", quiet=True, limit=100)
+fv_limited.run()
+
 # Access validation results via the message attribute
 print(json.dumps(fv.message, indent=2))
 

{stac_valid-4.2.2 → stac_valid-4.4.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