pystac-ext-grid 1.1.0__tar.gz

pystac_ext_grid-1.1.0/.gitignore

@@ -0,0 +1,163 @@
+*.pyc
+*.egg-info
+*.eggs
+.DS_Store
+data
+config.json
+stdout*
+/integration*
+.idea
+.vscode
+.actrc
+
+
+# Sphinx documentation
+.ipynb_checkpoints/
+
+docs/tutorials/pystac-example*
+docs/tutorials/spacenet-stac/
+docs/tutorials/spacenet-cog-stac/
+docs/tutorials/data/
+docs/quickstart_stac/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# asv environments
+.asv

pystac_ext_grid-1.1.0/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: pystac-ext-grid
+Version: 1.1.0
+Summary: Grid extension for PySTAC
+Project-URL: Documentation, https://pystac.readthedocs.io
+Project-URL: Repository, https://github.com/stac-utils/pystac
+Project-URL: Issues, https://github.com/stac-utils/pystac/issues
+Project-URL: Changelog, https://github.com/stac-utils/pystac/blob/main/CHANGELOG.md
+Project-URL: Discussions, https://github.com/radiantearth/stac-spec/discussions/categories/stac-software
+License: Apache-2.0
+Keywords: STAC,catalog,grid,imagery,pystac,raster
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Requires-Dist: pystac-core
+Description-Content-Type: text/markdown
+
+# pystac-ext-grid
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Grid Extension](https://github.com/stac-extensions/grid).
+This extension describes gridded data products by specifying the grid code (e.g. MGRS, MODIS, or other tiling schemes) that the data corresponds to.
+
+## Supported versions
+
+- [v1.1.0](https://stac-extensions.github.io/grid/v1.1.0/schema.json)
+- [v1.0.0](https://stac-extensions.github.io/grid/v1.0.0/schema.json)
+
+## Versioning
+
+This package's version corresponds to the version of the extension specification it targets.
+When we release updates to the package code without changing the target extension version, we use [post releases](https://packaging.python.org/en/latest/discussions/versioning/#post-releases), e.g. `1.1.0.post1`.

pystac_ext_grid-1.1.0/README.md

@@ -0,0 +1,14 @@
+# pystac-ext-grid
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Grid Extension](https://github.com/stac-extensions/grid).
+This extension describes gridded data products by specifying the grid code (e.g. MGRS, MODIS, or other tiling schemes) that the data corresponds to.
+
+## Supported versions
+
+- [v1.1.0](https://stac-extensions.github.io/grid/v1.1.0/schema.json)
+- [v1.0.0](https://stac-extensions.github.io/grid/v1.0.0/schema.json)
+
+## Versioning
+
+This package's version corresponds to the version of the extension specification it targets.
+When we release updates to the package code without changing the target extension version, we use [post releases](https://packaging.python.org/en/latest/discussions/versioning/#post-releases), e.g. `1.1.0.post1`.

pystac_ext_grid-1.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "pystac-ext-grid"
+description = "Grid extension for PySTAC"
+readme = "README.md"
+version = "1.1.0"
+authors = []
+maintainers = []
+keywords = ["pystac", "imagery", "raster", "catalog", "STAC", "grid"]
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.10"
+dependencies = ["pystac-core"]
+
+[project.urls]
+Documentation = "https://pystac.readthedocs.io"
+Repository = "https://github.com/stac-utils/pystac"
+Issues = "https://github.com/stac-utils/pystac/issues"
+Changelog = "https://github.com/stac-utils/pystac/blob/main/CHANGELOG.md"
+Discussions = "https://github.com/radiantearth/stac-spec/discussions/categories/stac-software"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["pystac"]

pystac_ext_grid-1.1.0/pystac/extensions/grid.py

@@ -0,0 +1,126 @@
+"""Implements the :stac-ext:`Grid Extension <grid>`."""
+
+from __future__ import annotations
+
+import re
+from re import Pattern
+from typing import Any, Literal
+
+import pystac
+from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
+from pystac.extensions.hooks import ExtensionHooks
+
+SCHEMA_URI: str = "https://stac-extensions.github.io/grid/v1.1.0/schema.json"
+SCHEMA_URIS: list[str] = [
+    "https://stac-extensions.github.io/grid/v1.0.0/schema.json",
+    SCHEMA_URI,
+]
+PREFIX: str = "grid:"
+
+# Field names
+CODE_PROP: str = PREFIX + "code"  # required
+
+CODE_REGEX: str = r"[A-Z0-9]+-[-_.A-Za-z0-9]+"
+CODE_PATTERN: Pattern[str] = re.compile(CODE_REGEX)
+
+
+def validated_code(v: str) -> str:
+    if not isinstance(v, str):
+        raise ValueError("Invalid Grid code: must be str")
+    if not CODE_PATTERN.fullmatch(v):
+        raise ValueError(
+            f"Invalid Grid code: {v} does not match the regex {CODE_REGEX}"
+        )
+    return v
+
+
+class GridExtension(
+    PropertiesExtension,
+    ExtensionManagementMixin[pystac.Item | pystac.Collection],
+):
+    """A concrete implementation of :class:`~pystac.extensions.grid.GridExtension`
+    on an :class:`~pystac.Item`
+    that extends the properties of the Item to include properties defined in the
+    :stac-ext:`Grid Extension <grid>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`~pystac.extensions.grid.GridExtension.ext` on an :class:`~pystac.Item`
+    to extend it.
+
+    .. code-block:: python
+
+       >>> item: pystac.Item = ...
+       >>> proj_ext = GridExtension.ext(item)
+    """
+
+    name: Literal["grid"] = "grid"
+
+    item: pystac.Item
+    """The :class:`~pystac.Item` being extended."""
+
+    properties: dict[str, Any]
+    """The :class:`~pystac.Item` properties, including extension properties."""
+
+    def __init__(self, item: pystac.Item):
+        self.item = item
+        self.properties = item.properties
+
+    def __repr__(self) -> str:
+        return f"<ItemGridExtension Item id={self.item.id}>"
+
+    def apply(self, code: str) -> None:
+        """Applies Grid extension properties to the extended Item.
+
+        Args:
+            code : REQUIRED. The code of the Item's grid location.
+        """
+        self.code = validated_code(code)
+
+    @property
+    def code(self) -> str | None:
+        """Get or sets the grid code of the datasource."""
+        return self._get_property(CODE_PROP, str)
+
+    @code.setter
+    def code(self, v: str) -> None:
+        self._set_property(CODE_PROP, validated_code(v), pop_if_none=False)
+
+    @classmethod
+    def get_schema_uri(cls) -> str:
+        return SCHEMA_URI
+
+    @classmethod
+    def get_schema_uris(cls) -> list[str]:
+        import warnings
+
+        warnings.warn(
+            "get_schema_uris is deprecated and will be removed in v2",
+            DeprecationWarning,
+        )
+        return SCHEMA_URIS
+
+    @classmethod
+    def ext(cls, obj: pystac.Item, add_if_missing: bool = False) -> GridExtension:
+        """Extends the given STAC Object with properties from the :stac-ext:`Grid
+        Extension <grid>`.
+
+        This extension can be applied to instances of :class:`~pystac.Item`.
+
+        Raises:
+
+            pystac.ExtensionTypeError : If an invalid object type is passed.
+        """
+        if isinstance(obj, pystac.Item):
+            cls.ensure_has_extension(obj, add_if_missing)
+            return GridExtension(obj)
+        else:
+            raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
+
+
+class GridExtensionHooks(ExtensionHooks):
+    schema_uri: str = SCHEMA_URI
+    prev_extension_ids: set[str] = {*[uri for uri in SCHEMA_URIS if uri != SCHEMA_URI]}
+    stac_object_types = {pystac.STACObjectType.ITEM}
+
+
+GRID_EXTENSION_HOOKS: ExtensionHooks = GridExtensionHooks()

pystac_ext_grid-1.1.0/tests/cassettes/test_grid/test_attributes.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/grid/v1.1.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/grid/v1.1.0/schema.json#\",\n  \"title\":
+        \"Grid Extension\",\n  \"description\": \"STAC Grid Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items\",\n
+        \     \"allOf\": [\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"type\": \"object\",\n          \"required\":
+        [\n            \"type\",\n            \"properties\",\n            \"assets\"\n
+        \         ],\n          \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Feature\"\n            },\n            \"properties\": {\n              \"allOf\":
+        [\n                {\n                  \"required\": [\n                    \"grid:code\"\n
+        \                 ]\n                },\n                {\n                  \"$ref\":
+        \"#/definitions/fields\"\n                }\n              ]\n            }\n
+        \         }\n        }\n      ]\n    }\n  ],\n  \"definitions\": {\n    \"stac_extensions\":
+        {\n      \"type\": \"object\",\n      \"required\": [\n        \"stac_extensions\"\n
+        \     ],\n      \"properties\": {\n        \"stac_extensions\": {\n          \"type\":
+        \"array\",\n          \"contains\": {\n            \"const\": \"https://stac-extensions.github.io/grid/v1.1.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"require_any_field\": {\n      \"anyOf\":
+        [\n        {\"required\": [\"grid:code\"]}\n      ]\n    },\n    \"fields\":
+        {\n      \"type\": \"object\",\n      \"properties\": {\n        \"grid:code\":
+        {\n          \"type\": \"string\",\n          \"pattern\": \"^[A-Z0-9]+-[-_.A-Za-z0-9]+$\"\n
+        \       }\n      },\n      \"patternProperties\": {\n        \"^(?!grid:)\":
+        {\n          \"$comment\": \"Do not allow other fields with this prefix\"\n
+        \       }\n      },\n      \"additionalProperties\": false\n    }\n  }\n}\n"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_grid-1.1.0/tests/cassettes/test_grid/test_modify.yaml

@@ -0,0 +1,36 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/grid/v1.1.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/grid/v1.1.0/schema.json#\",\n  \"title\":
+        \"Grid Extension\",\n  \"description\": \"STAC Grid Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items\",\n
+        \     \"allOf\": [\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       },\n        {\n          \"type\": \"object\",\n          \"required\":
+        [\n            \"type\",\n            \"properties\",\n            \"assets\"\n
+        \         ],\n          \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Feature\"\n            },\n            \"properties\": {\n              \"allOf\":
+        [\n                {\n                  \"required\": [\n                    \"grid:code\"\n
+        \                 ]\n                },\n                {\n                  \"$ref\":
+        \"#/definitions/fields\"\n                }\n              ]\n            }\n
+        \         }\n        }\n      ]\n    }\n  ],\n  \"definitions\": {\n    \"stac_extensions\":
+        {\n      \"type\": \"object\",\n      \"required\": [\n        \"stac_extensions\"\n
+        \     ],\n      \"properties\": {\n        \"stac_extensions\": {\n          \"type\":
+        \"array\",\n          \"contains\": {\n            \"const\": \"https://stac-extensions.github.io/grid/v1.1.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"require_any_field\": {\n      \"anyOf\":
+        [\n        {\"required\": [\"grid:code\"]}\n      ]\n    },\n    \"fields\":
+        {\n      \"type\": \"object\",\n      \"properties\": {\n        \"grid:code\":
+        {\n          \"type\": \"string\",\n          \"pattern\": \"^[A-Z0-9]+-[-_.A-Za-z0-9]+$\"\n
+        \       }\n      },\n      \"patternProperties\": {\n        \"^(?!grid:)\":
+        {\n          \"$comment\": \"Do not allow other fields with this prefix\"\n
+        \       }\n      },\n      \"additionalProperties\": false\n    }\n  }\n}\n"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_grid-1.1.0/tests/data-files/example-landsat.json

@@ -0,0 +1,129 @@
+{
+  "type": "Feature",
+  "stac_version": "1.1.0",
+  "id": "LC09_L2SR_081122_20221130_02_T2",
+  "properties": {
+    "platform": "landsat-9",
+    "instruments": [
+      "oli",
+      "tirs"
+    ],
+    "created": "2022-12-02T07:31:27.565Z",
+    "gsd": 30,
+    "description": "Landsat Collection 2 Level-2",
+    "eo:cloud_cover": 100,
+    "view:off_nadir": 0,
+    "view:sun_elevation": 18.24930158,
+    "view:sun_azimuth": 116.70818279,
+    "proj:epsg": 3031,
+    "proj:shape": [
+      7731,
+      7821
+    ],
+    "proj:transform": [
+      30,
+      0,
+      743385,
+      0,
+      -30,
+      337215
+    ],
+    "grid:code": "WGS2-081122",
+    "landsat:cloud_cover_land": 100,
+    "landsat:wrs_type": "2",
+    "landsat:wrs_path": "081",
+    "landsat:wrs_row": "122",
+    "landsat:collection_category": "T2",
+    "landsat:collection_number": "02",
+    "landsat:correction": "L2SR",
+    "landsat:scene_id": "LC90811222022334LGN00",
+    "sci:doi": "10.5066/P9OGBGM6",
+    "datetime": "2022-11-30T23:10:16.172033Z",
+    "earthsearch:payload_id": "usgs-landsat-c2l2/workflow-landsat-to-stac/LC09_L2SR_081122_20221130_20221202_02_T2_SR",
+    "processing:software": {
+      "landsat-to-stac": "0.1.0"
+    },
+    "updated": "2022-12-02T07:31:27.565Z"
+  },
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [
+      [
+        [
+          70.06845303665641,
+          -80.93500601550424
+        ],
+        [
+          68.81052300366429,
+          -82.64772956732001
+        ],
+        [
+          82.3854019772448,
+          -82.64899815759557
+        ],
+        [
+          81.11511917154068,
+          -80.93577539197138
+        ],
+        [
+          70.06845303665641,
+          -80.93500601550424
+        ]
+      ]
+    ]
+  },
+  "links": [
+    {
+      "rel": "self",
+      "href": "https://earth-search.aws.element84.com/v1/collections/landsat-c2-l2/items/LC09_L2SR_081122_20221130_02_T2"
+    },
+    {
+      "rel": "canonical",
+      "href": "s3://earthsearch-data/landsat-c2-l2/081/122/2022/11/LC09_L2SR_081122_20221130_02_T2/LC09_L2SR_081122_20221130_02_T2.json",
+      "type": "application/json"
+    },
+    {
+      "rel": "cite-as",
+      "href": "https://doi.org/10.5066/P9OGBGM6",
+      "title": "Landsat 8-9 OLI/TIRS Collection 2 Level-2"
+    },
+    {
+      "rel": "via",
+      "href": "https://landsatlook.usgs.gov/stac-server/collections/landsat-c2l2-sr/items/LC09_L2SR_081122_20221130_20221202_02_T2_SR",
+      "type": "application/json",
+      "title": "USGS STAC Item"
+    },
+    {
+      "rel": "parent",
+      "href": "https://earth-search.aws.element84.com/v1/collections/landsat-c2-l2"
+    },
+    {
+      "rel": "collection",
+      "href": "https://earth-search.aws.element84.com/v1/collections/landsat-c2-l2"
+    },
+    {
+      "rel": "root",
+      "href": "https://earth-search.aws.element84.com/v1/"
+    }
+  ],
+  "assets": {},
+  "bbox": [
+    65.60123,
+    -83.097758,
+    83.855046,
+    -80.499732
+  ],
+  "stac_extensions": [
+    "https://stac-extensions.github.io/processing/v1.1.0/schema.json",
+    "https://stac-extensions.github.io/storage/v1.0.0/schema.json",
+    "https://stac-extensions.github.io/scientific/v1.0.0/schema.json",
+    "https://stac-extensions.github.io/raster/v1.1.0/schema.json",
+    "https://stac-extensions.github.io/classification/v1.0.0/schema.json",
+    "https://stac-extensions.github.io/eo/v1.1.0/schema.json",
+    "https://stac-extensions.github.io/projection/v1.0.0/schema.json",
+    "https://stac-extensions.github.io/view/v1.0.0/schema.json",
+    "https://landsat.usgs.gov/stac/landsat-extension/v1.1.1/schema.json",
+    "https://stac-extensions.github.io/grid/v1.1.0/schema.json"
+  ],
+  "collection": "landsat-c2-l2"
+}