stac-pydantic-extensions 0.1.0__tar.gz

stac_pydantic_extensions-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Arturo AI
+
+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.

stac_pydantic_extensions-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.3
+Name: stac-pydantic-extensions
+Version: 0.1.0
+Summary: Pydantic data models for STAC extensions
+Keywords: geospatial,gis,pydantic,stac,stac-extensions
+Author: Shadi Boomi
+Author-email: Shadi Boomi <shadi.boomi@universite-paris-saclay.fr>
+License: MIT License
+         
+         Copyright (c) 2020 Arturo AI
+         
+         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.
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Typing :: Typed
+Requires-Dist: geojson-pydantic>=2.1.1
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pyproj>=3.7.2
+Requires-Dist: stac-pydantic>=3.5.1
+Requires-Dist: typer>=0.27.1
+Requires-Python: >=3.13
+Project-URL: Homepage, https://github.com/s-boomi/stac-pydantic-extensions
+Project-URL: Issues, https://github.com/s-boomi/stac-pydantic-extensions/issues
+Project-URL: Repository, https://github.com/s-boomi/stac-pydantic-extensions
+Description-Content-Type: text/markdown
+
+# stac-pydantic-extensions
+
+[![CI](https://github.com/s-boomi/stac-pydantic-extensions/actions/workflows/cicd.yml/badge.svg)](https://github.com/s-boomi/stac-pydantic-extensions/actions/workflows/cicd.yml)
+[![PyPI version](https://img.shields.io/pypi/v/stac-pydantic-extensions.svg)](https://pypi.org/project/stac-pydantic-extensions/)
+[![Python versions](https://img.shields.io/pypi/pyversions/stac-pydantic-extensions.svg)](https://pypi.org/project/stac-pydantic-extensions/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Pydantic data models for [STAC extensions](https://github.com/stac-extensions), built on top of
+[`stac-pydantic`](https://github.com/stac-utils/stac-pydantic).
+
+`stac-pydantic-extensions` lets you attach, read, modify, and migrate STAC extension fields
+(`eo`, `raster`, `proj`, `view`, `sat`, `sci`, `rd`, `ssys`, `wmts`, ...) on Items, Collections,
+Assets and Bands, with validation and version migration handled for you.
+
+## Features
+
+- **Typed access to extension fields** — `item.ext.eo.cloud_cover`, `item.ext.raster.spatial_resolution`, etc.
+- **Add / remove extensions** on the fly, recursively across assets and bands.
+- **Version migration** — upgrade Items written against older extension schemas (e.g. `eo/v1.0.0`,
+  `raster/v1.1.0`) to the current ones, including the `eo:bands` / `raster:bands` → `bands` merge
+  introduced in the `v2.0.0` extensions.
+- **Multiple extensions at once**, without them clobbering each other's fields.
+- Works with plain STAC Items that don't declare any extensions yet.
+
+## Installation
+
+```bash
+pip install stac-pydantic-extensions
+```
+
+or, with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add stac-pydantic-extensions
+```
+
+Requires Python 3.13+.
+
+## Quickstart
+
+```python
+import json
+
+from stac_pydantic_extensions import ExtendedItem, Item
+
+with open("item-sentinel2.json") as f:
+    raw_item = json.load(f)
+
+item = Item.model_validate(raw_item)
+extended_item = ExtendedItem(stac_object=item)
+
+# Read extension fields declared on the item
+print(extended_item.ext.eo.cloud_cover)          # 21.22
+print(extended_item.show_ext_names())            # {'eo', 'view', 'proj', 'raster'}
+
+# Extensions declared on assets/bands are available the same way
+red_band = extended_item.stac_object.assets["B04"]
+extended_band = ExtendedItem(stac_object=red_band)
+print(extended_band.ext.eo.common_name)           # "red"
+print(extended_band.ext.raster.spatial_resolution)  # 10
+
+# Add a new extension to an item that doesn't have it yet
+extended_item.add_extension("raster")
+extended_item.ext.raster.spatial_resolution = 10
+
+# Serialize back out
+updated = extended_item.model_dump()
+```
+
+### Migrating older extension versions
+
+```python
+from stac_pydantic_extensions import ExtendedItem, Item
+
+old_item = Item.model_validate(raw_item_with_v1_extensions)
+
+migrated = ExtendedItem(stac_object=old_item).migrate()
+# stac_extensions now point at the latest schema versions, and any
+# eo:bands / raster:bands entries have been merged into `bands`.
+```
+
+## Supported extensions
+
+| Extension              | Prefix   |
+|-------------------------|----------|
+| Electro-Optical          | `eo`     |
+| Projection                | `proj`   |
+| Raster                    | `raster` |
+| View Geometry              | `view`   |
+| Satellite                  | `sat`    |
+| Scientific Citation         | `sci`    |
+| Remote Data                  | `rd`     |
+| Solar System                    | `ssys`   |
+| Web Map Tile Service              | `wmts`   |
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+git clone https://github.com/s-boomi/stac-pydantic-extensions.git
+cd stac-pydantic-extensions
+uv sync --group dev
+```
+
+Run the test suite:
+
+```bash
+uv run pytest --cov stac_pydantic_extensions --cov-report term-missing
+```
+
+Run linting, formatting and type checks:
+
+```bash
+uv run pre-commit run --all-files
+uv run ty check
+```
+
+> [!WARNING]
+> The `ty` check is still relatively new and can be prone to some errors, especially in test files. To skip type-checking, you can use the following command:
+
+```console
+SKIP=ty uv run pre-commit run --all-files
+```
+
+## Releasing
+
+Releases are published to PyPI via [PyPI trusted publishing](https://docs.pypi.org/trusted-publishers/)
+from the `.github/workflows/release.yml` workflow. To cut a release:
+
+1. Bump `version` in `pyproject.toml`.
+2. Tag the commit with the matching version (e.g. `v0.2.0`) and push the tag, or create a
+   GitHub Release — this triggers the `release` job.
+3. The workflow verifies the tag matches the package version, builds the sdist/wheel with
+   `uv build`, and publishes with `uv publish`.
+
+## License
+
+Distributed under the MIT License. See [`LICENSE`](LICENSE) for details.

stac_pydantic_extensions-0.1.0/README.md

@@ -0,0 +1,139 @@
+# stac-pydantic-extensions
+
+[![CI](https://github.com/s-boomi/stac-pydantic-extensions/actions/workflows/cicd.yml/badge.svg)](https://github.com/s-boomi/stac-pydantic-extensions/actions/workflows/cicd.yml)
+[![PyPI version](https://img.shields.io/pypi/v/stac-pydantic-extensions.svg)](https://pypi.org/project/stac-pydantic-extensions/)
+[![Python versions](https://img.shields.io/pypi/pyversions/stac-pydantic-extensions.svg)](https://pypi.org/project/stac-pydantic-extensions/)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Pydantic data models for [STAC extensions](https://github.com/stac-extensions), built on top of
+[`stac-pydantic`](https://github.com/stac-utils/stac-pydantic).
+
+`stac-pydantic-extensions` lets you attach, read, modify, and migrate STAC extension fields
+(`eo`, `raster`, `proj`, `view`, `sat`, `sci`, `rd`, `ssys`, `wmts`, ...) on Items, Collections,
+Assets and Bands, with validation and version migration handled for you.
+
+## Features
+
+- **Typed access to extension fields** — `item.ext.eo.cloud_cover`, `item.ext.raster.spatial_resolution`, etc.
+- **Add / remove extensions** on the fly, recursively across assets and bands.
+- **Version migration** — upgrade Items written against older extension schemas (e.g. `eo/v1.0.0`,
+  `raster/v1.1.0`) to the current ones, including the `eo:bands` / `raster:bands` → `bands` merge
+  introduced in the `v2.0.0` extensions.
+- **Multiple extensions at once**, without them clobbering each other's fields.
+- Works with plain STAC Items that don't declare any extensions yet.
+
+## Installation
+
+```bash
+pip install stac-pydantic-extensions
+```
+
+or, with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add stac-pydantic-extensions
+```
+
+Requires Python 3.13+.
+
+## Quickstart
+
+```python
+import json
+
+from stac_pydantic_extensions import ExtendedItem, Item
+
+with open("item-sentinel2.json") as f:
+    raw_item = json.load(f)
+
+item = Item.model_validate(raw_item)
+extended_item = ExtendedItem(stac_object=item)
+
+# Read extension fields declared on the item
+print(extended_item.ext.eo.cloud_cover)          # 21.22
+print(extended_item.show_ext_names())            # {'eo', 'view', 'proj', 'raster'}
+
+# Extensions declared on assets/bands are available the same way
+red_band = extended_item.stac_object.assets["B04"]
+extended_band = ExtendedItem(stac_object=red_band)
+print(extended_band.ext.eo.common_name)           # "red"
+print(extended_band.ext.raster.spatial_resolution)  # 10
+
+# Add a new extension to an item that doesn't have it yet
+extended_item.add_extension("raster")
+extended_item.ext.raster.spatial_resolution = 10
+
+# Serialize back out
+updated = extended_item.model_dump()
+```
+
+### Migrating older extension versions
+
+```python
+from stac_pydantic_extensions import ExtendedItem, Item
+
+old_item = Item.model_validate(raw_item_with_v1_extensions)
+
+migrated = ExtendedItem(stac_object=old_item).migrate()
+# stac_extensions now point at the latest schema versions, and any
+# eo:bands / raster:bands entries have been merged into `bands`.
+```
+
+## Supported extensions
+
+| Extension              | Prefix   |
+|-------------------------|----------|
+| Electro-Optical          | `eo`     |
+| Projection                | `proj`   |
+| Raster                    | `raster` |
+| View Geometry              | `view`   |
+| Satellite                  | `sat`    |
+| Scientific Citation         | `sci`    |
+| Remote Data                  | `rd`     |
+| Solar System                    | `ssys`   |
+| Web Map Tile Service              | `wmts`   |
+
+## Development
+
+This project uses [uv](https://docs.astral.sh/uv/) for dependency management.
+
+```bash
+git clone https://github.com/s-boomi/stac-pydantic-extensions.git
+cd stac-pydantic-extensions
+uv sync --group dev
+```
+
+Run the test suite:
+
+```bash
+uv run pytest --cov stac_pydantic_extensions --cov-report term-missing
+```
+
+Run linting, formatting and type checks:
+
+```bash
+uv run pre-commit run --all-files
+uv run ty check
+```
+
+> [!WARNING]
+> The `ty` check is still relatively new and can be prone to some errors, especially in test files. To skip type-checking, you can use the following command:
+
+```console
+SKIP=ty uv run pre-commit run --all-files
+```
+
+## Releasing
+
+Releases are published to PyPI via [PyPI trusted publishing](https://docs.pypi.org/trusted-publishers/)
+from the `.github/workflows/release.yml` workflow. To cut a release:
+
+1. Bump `version` in `pyproject.toml`.
+2. Tag the commit with the matching version (e.g. `v0.2.0`) and push the tag, or create a
+   GitHub Release — this triggers the `release` job.
+3. The workflow verifies the tag matches the package version, builds the sdist/wheel with
+   `uv build`, and publishes with `uv publish`.
+
+## License
+
+Distributed under the MIT License. See [`LICENSE`](LICENSE) for details.

stac_pydantic_extensions-0.1.0/pyproject.toml

@@ -0,0 +1,73 @@
+[project]
+name = "stac-pydantic-extensions"
+version = "0.1.0"
+description = "Pydantic data models for STAC extensions"
+readme = "README.md"
+requires-python = ">=3.13"
+keywords = [
+    "geospatial",
+    "gis",
+    "pydantic",
+    "stac",
+    "stac-extensions",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Scientific/Engineering :: GIS",
+    "Typing :: Typed",
+]
+dependencies = [
+    "geojson-pydantic>=2.1.1",
+    "pydantic>=2.13.4",
+    "pyproj>=3.7.2",
+    "stac-pydantic>=3.5.1",
+    "typer>=0.27.1",
+]
+
+[project.license]
+file = "LICENSE"
+
+[[project.authors]]
+name = "Shadi Boomi"
+email = "shadi.boomi@universite-paris-saclay.fr"
+
+[project.urls]
+Homepage = "https://github.com/s-boomi/stac-pydantic-extensions"
+Issues = "https://github.com/s-boomi/stac-pydantic-extensions/issues"
+Repository = "https://github.com/s-boomi/stac-pydantic-extensions"
+
+[project.scripts]
+stac-pydantic-extensions = "stac_pydantic_extensions.cli:app"
+
+[dependency-groups]
+dev = [
+    "jsonschema>=4.26.0",
+    "pre-commit>=4.6.0",
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "pytest-icdiff>=0.9",
+    "requests>=2.34.2",
+    "ruff>=0.15.13",
+    "tombi>=0.11.5",
+    "ty>=0.0.37",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.9,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.ty.src]
+include = [
+    "src",
+    "tests",
+]
+exclude = [".venv"]
+
+[tool.ty.environment]
+python = ".venv"

stac_pydantic_extensions-0.1.0/pyproject.toml.orig

@@ -0,0 +1,61 @@
+[project]
+name = "stac-pydantic-extensions"
+version = "0.1.0"
+description = "Pydantic data models for STAC extensions"
+readme = "README.md"
+requires-python = ">=3.13"
+license = { file = "LICENSE" }
+authors = [
+  { name = "Shadi Boomi", email = "shadi.boomi@universite-paris-saclay.fr" }
+]
+keywords = ["geospatial", "gis", "pydantic", "stac", "stac-extensions"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Scientific/Engineering :: GIS",
+  "Typing :: Typed",
+]
+dependencies = [
+  "geojson-pydantic>=2.1.1",
+  "pydantic>=2.13.4",
+  "pyproj>=3.7.2",
+  "stac-pydantic>=3.5.1",
+  "typer>=0.27.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/s-boomi/stac-pydantic-extensions"
+Issues = "https://github.com/s-boomi/stac-pydantic-extensions/issues"
+Repository = "https://github.com/s-boomi/stac-pydantic-extensions"
+
+[project.scripts]
+stac-pydantic-extensions = "stac_pydantic_extensions.cli:app"
+
+[dependency-groups]
+dev = [
+  "jsonschema>=4.26.0",
+  "pre-commit>=4.6.0",
+  "pytest>=9.0.3",
+  "pytest-cov>=7.1.0",
+  "pytest-icdiff>=0.9",
+  "requests>=2.34.2",
+  "ruff>=0.15.13",
+  "tombi>=0.11.5",
+  "ty>=0.0.37",
+]
+
+[build-system]
+requires = ["uv_build>=0.11.9,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.ty.src]
+include = ["src", "tests"]
+exclude = [".venv"]
+
+[tool.ty.environment]
+python = ".venv"

stac_pydantic_extensions-0.1.0/src/stac_pydantic_extensions/__init__.py

@@ -0,0 +1,33 @@
+"""STAC Pydantic Extensions."""
+
+from stac_pydantic_extensions.compat.stac_pydantic import (
+    STAC_VERSION,
+    Asset,
+    Band,
+    Collection,
+    DataTypes,
+    Item,
+    ItemAsset,
+    ItemProperties,
+    Link,
+    NoDataTypes,
+    StacCommonMetadata,
+    Statistics,
+)
+from stac_pydantic_extensions.extended import ExtendedItem
+
+__all__: list[str] = [
+    "STAC_VERSION",
+    "NoDataTypes",
+    "DataTypes",
+    "Band",
+    "Statistics",
+    "StacCommonMetadata",
+    "Link",
+    "Asset",
+    "ItemAsset",
+    "Collection",
+    "ItemProperties",
+    "Item",
+    "ExtendedItem",
+]

stac_pydantic_extensions-0.1.0/src/stac_pydantic_extensions/_registry.py

@@ -0,0 +1,83 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Optional, Type
+
+from pydantic import Field
+
+from stac_pydantic_extensions.extensions._base import BaseExtension
+from stac_pydantic_extensions.extensions.eo import ElectroOpticalExtension
+from stac_pydantic_extensions.extensions.processing import ProcessingExtension
+from stac_pydantic_extensions.extensions.proj import ProjectionExtension
+from stac_pydantic_extensions.extensions.raster import RasterExtension
+from stac_pydantic_extensions.extensions.rd import RemoteDataExtension
+from stac_pydantic_extensions.extensions.sat import SatelliteExtension
+from stac_pydantic_extensions.extensions.sci import ScientificCitationExtension
+from stac_pydantic_extensions.extensions.ssys import SolSysExtension
+from stac_pydantic_extensions.extensions.view import ViewGeometryExtension
+from stac_pydantic_extensions.extensions.wmts import WebMapLinksExtension
+
+if TYPE_CHECKING:
+    from stac_pydantic_extensions.extended import ExtendableStacObject
+
+AVAILABLE_EXTENSIONS: list[Type[BaseExtension]] = [
+    ElectroOpticalExtension,
+    SolSysExtension,
+    WebMapLinksExtension,
+    ProjectionExtension,
+    RemoteDataExtension,
+    ScientificCitationExtension,
+    ViewGeometryExtension,
+    RasterExtension,
+    SatelliteExtension,
+    ProcessingExtension,
+]
+
+
+class _ExtensionRegistry:
+    @staticmethod
+    def _set_extensions(
+        extensions: list[type[BaseExtension]],
+    ) -> dict[str, type[BaseExtension]]:
+        return {extension.prefix: extension for extension in extensions}
+
+    def __init__(self, extensions: list[Type[BaseExtension]]):
+        self._ext: dict[str, type[BaseExtension]] = self._set_extensions(extensions)
+
+    @property
+    def ext(self) -> dict[str, Type[BaseExtension]]:
+        return self._ext
+
+    @ext.setter
+    def ext(self, _v: dict[str, Type[BaseExtension]]) -> None:
+        self._ext = _v
+
+    def allowed_extensions_by_stac_item(
+        self, stac_object: ExtendableStacObject
+    ) -> dict[str, Type[BaseExtension]]:
+        return {
+            k: v
+            for k, v in self.ext.items()
+            if stac_object.__class__.__name__ in v.allowed_objects
+        }
+
+    def create_model_fields_by_stac_item(
+        self, stac_object: ExtendableStacObject
+    ) -> dict[str, tuple[Any, Any]]:
+        # First element is a typing expression (Optional[Type]) which isn't a
+        # runtime 'type', so use Any in the return annotation to satisfy
+        # type-checkers.
+        return {
+            k: (Optional[v], Field(default=None))  # ty:ignore[invalid-type-form]
+            for k, v in self.ext.items()
+            if stac_object.__class__.__name__ in v.allowed_objects
+        }
+
+    def __repr__(self) -> str:
+        return f"<{self.__class__.__name__} extensions={[ext_name for ext_name in self.ext.keys()]}>"
+
+    def __str__(self) -> str:
+        return f"Registered extensions: {', '.join([ext_name for ext_name in self.ext.keys()])}"
+
+
+# For export
+extension_registry = _ExtensionRegistry(AVAILABLE_EXTENSIONS)

stac_pydantic_extensions-0.1.0/src/stac_pydantic_extensions/cli.py

@@ -0,0 +1,18 @@
+import typer
+
+app = typer.Typer()
+
+
+@app.callback()
+def callback():
+    """
+    STAC Pydantic Extensions
+    """
+
+
+@app.command()
+def migrate():
+    """
+    Takes an item and migrates it to the latest versions
+    """
+    pass