pystac-ext-mgrs 1.0.0__tar.gz

pystac_ext_mgrs-1.0.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_mgrs-1.0.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: pystac-ext-mgrs
+Version: 1.0.0
+Summary: MGRS 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,imagery,mgrs,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-mgrs
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [MGRS Extension](https://github.com/stac-extensions/mgrs).
+This extension provides fields for describing data using the Military Grid Reference System (MGRS), including UTM zone, latitude band, and grid square identifiers.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/mgrs/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.0.0.post1`.

pystac_ext_mgrs-1.0.0/README.md

@@ -0,0 +1,13 @@
+# pystac-ext-mgrs
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [MGRS Extension](https://github.com/stac-extensions/mgrs).
+This extension provides fields for describing data using the Military Grid Reference System (MGRS), including UTM zone, latitude band, and grid square identifiers.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/mgrs/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.0.0.post1`.

pystac_ext_mgrs-1.0.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "pystac-ext-mgrs"
+description = "MGRS extension for PySTAC"
+readme = "README.md"
+version = "1.0.0"
+authors = []
+maintainers = []
+keywords = ["pystac", "imagery", "raster", "catalog", "STAC", "mgrs"]
+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_mgrs-1.0.0/pystac/extensions/mgrs.py

@@ -0,0 +1,252 @@
+"""Implements the :stac-ext:`MGRS Extension <mgrs>`."""
+
+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/mgrs/v1.0.0/schema.json"
+SCHEMA_STARTSWITH: str = "https://stac-extensions.github.io/mgrs/"
+PREFIX: str = "mgrs:"
+
+# Field names
+LATITUDE_BAND_PROP: str = PREFIX + "latitude_band"  # required
+GRID_SQUARE_PROP: str = PREFIX + "grid_square"  # required
+UTM_ZONE_PROP: str = PREFIX + "utm_zone"
+
+LATITUDE_BANDS: frozenset[str] = frozenset(
+    {
+        "C",
+        "D",
+        "E",
+        "F",
+        "G",
+        "H",
+        "J",
+        "K",
+        "L",
+        "M",
+        "N",
+        "P",
+        "Q",
+        "R",
+        "S",
+        "T",
+        "U",
+        "V",
+        "W",
+        "X",
+    }
+)
+
+UTM_ZONES: frozenset[int] = frozenset(
+    {
+        1,
+        2,
+        3,
+        4,
+        5,
+        6,
+        7,
+        8,
+        9,
+        10,
+        11,
+        12,
+        13,
+        14,
+        15,
+        16,
+        17,
+        18,
+        19,
+        20,
+        21,
+        22,
+        23,
+        24,
+        25,
+        26,
+        27,
+        28,
+        29,
+        30,
+        31,
+        32,
+        33,
+        34,
+        35,
+        36,
+        37,
+        38,
+        39,
+        40,
+        41,
+        42,
+        43,
+        44,
+        45,
+        46,
+        47,
+        48,
+        49,
+        50,
+        51,
+        52,
+        53,
+        54,
+        55,
+        56,
+        57,
+        58,
+        59,
+        60,
+    }
+)
+
+GRID_SQUARE_REGEX: str = (
+    r"[ABCDEFGHJKLMNPQRSTUVWXYZ][ABCDEFGHJKLMNPQRSTUV](\d{2}|\d{4}|\d{6}|\d{8}|\d{10})?"
+)
+GRID_SQUARE_PATTERN: Pattern[str] = re.compile(GRID_SQUARE_REGEX)
+
+
+def validated_latitude_band(v: str) -> str:
+    if not isinstance(v, str):
+        raise ValueError("Invalid MGRS latitude band: must be str")
+    if v not in LATITUDE_BANDS:
+        raise ValueError(f"Invalid MGRS latitude band: {v} is not in {LATITUDE_BANDS}")
+    return v
+
+
+def validated_grid_square(v: str) -> str:
+    if not isinstance(v, str):
+        raise ValueError("Invalid MGRS grid square identifier: must be str")
+    if not GRID_SQUARE_PATTERN.fullmatch(v):
+        raise ValueError(
+            f"Invalid MGRS grid square identifier: {v}"
+            f" does not match the regex {GRID_SQUARE_REGEX}"
+        )
+    return v
+
+
+def validated_utm_zone(v: int | None) -> int | None:
+    if v is not None and not isinstance(v, int):
+        raise ValueError("Invalid MGRS utm zone: must be None or int")
+    if v is not None and v not in UTM_ZONES:
+        raise ValueError(f"Invalid MGRS UTM zone: {v} is not in {UTM_ZONES}")
+    return v
+
+
+class MgrsExtension(
+    PropertiesExtension,
+    ExtensionManagementMixin[pystac.Item | pystac.Collection],
+):
+    """A concrete implementation of :class:`~pystac.extensions.mgrs.MgrsExtension`
+    on an :class:`~pystac.Item`
+    that extends the properties of the Item to include properties defined in the
+    :stac-ext:`MGRS Extension <mgrs>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`~pystac.extensions.mgrs.MgrsExtension.ext` on an :class:`~pystac.Item`
+    to extend it.
+
+    .. code-block:: python
+
+       >>> item: pystac.Item = ...
+       >>> proj_ext = MgrsExtension.ext(item)
+    """
+
+    name: Literal["mgrs"] = "mgrs"
+    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"<ItemMgrsExtension Item id={self.item.id}>"
+
+    def apply(
+        self,
+        latitude_band: str,
+        grid_square: str,
+        utm_zone: int | None = None,
+    ) -> None:
+        """Applies MGRS extension properties to the extended Item.
+
+        Args:
+            latitude_band : REQUIRED. The latitude band of the Item's centroid.
+            grid_square : REQUIRED. MGRS grid square of the Item's centroid.
+            utm_zone : The UTM Zone of the Item centroid.
+        """
+        self.latitude_band = validated_latitude_band(latitude_band)
+        self.grid_square = validated_grid_square(grid_square)
+        self.utm_zone = validated_utm_zone(utm_zone)
+
+    @property
+    def latitude_band(self) -> str | None:
+        """Get or sets the latitude band of the datasource."""
+        return self._get_property(LATITUDE_BAND_PROP, str)
+
+    @latitude_band.setter
+    def latitude_band(self, v: str) -> None:
+        self._set_property(
+            LATITUDE_BAND_PROP, validated_latitude_band(v), pop_if_none=False
+        )
+
+    @property
+    def grid_square(self) -> str | None:
+        """Get or sets the latitude band of the datasource."""
+        return self._get_property(GRID_SQUARE_PROP, str)
+
+    @grid_square.setter
+    def grid_square(self, v: str) -> None:
+        self._set_property(
+            GRID_SQUARE_PROP, validated_grid_square(v), pop_if_none=False
+        )
+
+    @property
+    def utm_zone(self) -> int | None:
+        """Get or sets the latitude band of the datasource."""
+        return self._get_property(UTM_ZONE_PROP, int)
+
+    @utm_zone.setter
+    def utm_zone(self, v: int | None) -> None:
+        self._set_property(UTM_ZONE_PROP, validated_utm_zone(v), pop_if_none=True)
+
+    @classmethod
+    def get_schema_uri(cls) -> str:
+        return SCHEMA_URI
+
+    @classmethod
+    def ext(cls, obj: pystac.Item, add_if_missing: bool = False) -> "MgrsExtension":
+        """Extends the given STAC Object with properties from the :stac-ext:`MGRS
+        Extension <mgrs>`.
+
+        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 MgrsExtension(obj)
+        else:
+            raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
+
+
+class MgrsExtensionHooks(ExtensionHooks):
+    schema_uri: str = SCHEMA_URI
+    prev_extension_ids: set[str] = set()
+    stac_object_types = {pystac.STACObjectType.ITEM}
+
+
+MGRS_EXTENSION_HOOKS: ExtensionHooks = MgrsExtensionHooks()

pystac_ext_mgrs-1.0.0/tests/cassettes/test_mgrs/test_set_field[grid_square-ZA].yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/mgrs/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/mgrs/v1.0.0/schema.json#\",\n  \"title\":
+        \"MGRS Extension\",\n  \"description\": \"STAC MGRS Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items.\",\n
+        \     \"allOf\": [\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                  \"$comment\": \"Require fields here
+        for item properties.\",\n                  \"required\": [\n                    \"mgrs:latitude_band\",\n
+        \                   \"mgrs:grid_square\"\n                  ]\n                },\n
+        \               {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\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/mgrs/v1.0.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"fields\": {\n      \"$comment\":
+        \"Add your new fields here. Don't require them here, do that above in the
+        item schema.\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"mgrs:latitude_band\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:grid_square\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:utm_zone\":
+        {\n          \"type\": \"integer\"\n        }\n      },\n      \"patternProperties\":
+        {\n        \"^(?!mgrs:)\": {\n          \"$comment\": \"Do not allow other
+        fields with this prefix\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_mgrs-1.0.0/tests/cassettes/test_mgrs/test_set_field[latitude_band-C].yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/mgrs/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/mgrs/v1.0.0/schema.json#\",\n  \"title\":
+        \"MGRS Extension\",\n  \"description\": \"STAC MGRS Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items.\",\n
+        \     \"allOf\": [\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                  \"$comment\": \"Require fields here
+        for item properties.\",\n                  \"required\": [\n                    \"mgrs:latitude_band\",\n
+        \                   \"mgrs:grid_square\"\n                  ]\n                },\n
+        \               {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\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/mgrs/v1.0.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"fields\": {\n      \"$comment\":
+        \"Add your new fields here. Don't require them here, do that above in the
+        item schema.\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"mgrs:latitude_band\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:grid_square\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:utm_zone\":
+        {\n          \"type\": \"integer\"\n        }\n      },\n      \"patternProperties\":
+        {\n        \"^(?!mgrs:)\": {\n          \"$comment\": \"Do not allow other
+        fields with this prefix\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_mgrs-1.0.0/tests/cassettes/test_mgrs/test_set_field[utm_zone-59].yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/mgrs/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/mgrs/v1.0.0/schema.json#\",\n  \"title\":
+        \"MGRS Extension\",\n  \"description\": \"STAC MGRS Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items.\",\n
+        \     \"allOf\": [\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                  \"$comment\": \"Require fields here
+        for item properties.\",\n                  \"required\": [\n                    \"mgrs:latitude_band\",\n
+        \                   \"mgrs:grid_square\"\n                  ]\n                },\n
+        \               {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\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/mgrs/v1.0.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"fields\": {\n      \"$comment\":
+        \"Add your new fields here. Don't require them here, do that above in the
+        item schema.\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"mgrs:latitude_band\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:grid_square\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:utm_zone\":
+        {\n          \"type\": \"integer\"\n        }\n      },\n      \"patternProperties\":
+        {\n        \"^(?!mgrs:)\": {\n          \"$comment\": \"Do not allow other
+        fields with this prefix\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_mgrs-1.0.0/tests/cassettes/test_mgrs/test_validate.yaml

@@ -0,0 +1,52 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/mgrs/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/mgrs/v1.0.0/schema.json#\",\n  \"title\":
+        \"MGRS Extension\",\n  \"description\": \"STAC MGRS Extension for STAC Items.\",\n
+        \ \"oneOf\": [\n    {\n      \"$comment\": \"This is the schema for STAC Items.\",\n
+        \     \"allOf\": [\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                  \"$comment\": \"Require fields here
+        for item properties.\",\n                  \"required\": [\n                    \"mgrs:latitude_band\",\n
+        \                   \"mgrs:grid_square\"\n                  ]\n                },\n
+        \               {\n                  \"$ref\": \"#/definitions/fields\"\n
+        \               }\n              ]\n            },\n            \"assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\n
+        \       }\n      ]\n    },\n    {\n      \"$comment\": \"This is the schema
+        for STAC Collections.\",\n      \"allOf\": [\n        {\n          \"type\":
+        \"object\",\n          \"required\": [\n            \"type\"\n          ],\n
+        \         \"properties\": {\n            \"type\": {\n              \"const\":
+        \"Collection\"\n            },\n            \"assets\": {\n              \"type\":
+        \"object\",\n              \"additionalProperties\": {\n                \"$ref\":
+        \"#/definitions/fields\"\n              }\n            },\n            \"item_assets\":
+        {\n              \"type\": \"object\",\n              \"additionalProperties\":
+        {\n                \"$ref\": \"#/definitions/fields\"\n              }\n            }\n
+        \         }\n        },\n        {\n          \"$ref\": \"#/definitions/stac_extensions\"\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/mgrs/v1.0.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"fields\": {\n      \"$comment\":
+        \"Add your new fields here. Don't require them here, do that above in the
+        item schema.\",\n      \"type\": \"object\",\n      \"properties\": {\n        \"mgrs:latitude_band\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:grid_square\":
+        {\n          \"type\": \"string\"\n        },\n        \"mgrs:utm_zone\":
+        {\n          \"type\": \"integer\"\n        }\n      },\n      \"patternProperties\":
+        {\n        \"^(?!mgrs:)\": {\n          \"$comment\": \"Do not allow other
+        fields with this prefix\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1

pystac_ext_mgrs-1.0.0/tests/data-files/item.json

@@ -0,0 +1,53 @@
+{
+  "stac_version": "1.1.0",
+  "stac_extensions": [
+    "https://stac-extensions.github.io/mgrs/v1.0.0/schema.json"
+  ],
+  "type": "Feature",
+  "id": "item",
+  "bbox": [
+    172.9,
+    1.3,
+    173,
+    1.4
+  ],
+  "geometry": {
+    "type": "Polygon",
+    "coordinates": [
+      [
+        [
+          172.9,
+          1.3
+        ],
+        [
+          173,
+          1.3
+        ],
+        [
+          173,
+          1.4
+        ],
+        [
+          172.9,
+          1.4
+        ],
+        [
+          172.9,
+          1.3
+        ]
+      ]
+    ]
+  },
+  "properties": {
+    "datetime": "2020-12-11T22:38:32Z",
+    "mgrs:utm_zone": 13,
+    "mgrs:latitude_band": "X",
+    "mgrs:grid_square": "DH"
+  },
+  "links": [],
+  "assets": {
+    "data": {
+      "href": "https://example.com/examples/file.xyz"
+    }
+  }
+}

pystac_ext_mgrs-1.0.0/tests/test_mgrs.py

@@ -0,0 +1,140 @@
+"""Tests for pystac.tests.extensions.mgrs"""
+
+import json
+from pathlib import Path
+
+import pytest
+
+import pystac
+from pystac.extensions.mgrs import MgrsExtension
+
+DATA_FILES = Path(__file__).resolve().parent / "data-files"
+
+
+@pytest.fixture
+def ext_item_uri() -> str:
+    return str(DATA_FILES / "item.json")
+
+
+@pytest.fixture
+def ext_item(ext_item_uri: str) -> pystac.Item:
+    return pystac.Item.from_file(ext_item_uri)
+
+
+def test_stac_extensions(ext_item: pystac.Item) -> None:
+    assert MgrsExtension.has_extension(ext_item)
+
+
+def test_get_schema_uri(ext_item: pystac.Item) -> None:
+    assert MgrsExtension.get_schema_uri() in ext_item.stac_extensions
+
+
+def test_ext_raises_if_item_does_not_conform(item: pystac.Item) -> None:
+    with pytest.raises(pystac.errors.ExtensionNotImplemented):
+        MgrsExtension.ext(item)
+
+
+def test_ext_raises_on_collection(collection: pystac.Collection) -> None:
+    with pytest.raises(
+        pystac.errors.ExtensionTypeError,
+        match="MgrsExtension does not apply to type 'Collection'",
+    ) as e:
+        MgrsExtension.ext(collection)  # type: ignore
+    assert "Hint" not in str(e.value)
+
+
+def test_to_from_dict(ext_item_uri: str, ext_item: pystac.Item) -> None:
+    with open(ext_item_uri) as f:
+        d = json.load(f)
+    actual = ext_item.to_dict(include_self_link=False)
+    assert actual == d
+
+
+def test_add_to(item: pystac.Item) -> None:
+    assert not MgrsExtension.has_extension(item)
+    MgrsExtension.add_to(item)
+
+    assert MgrsExtension.has_extension(item)
+
+
+def test_apply(item: pystac.Item) -> None:
+    MgrsExtension.add_to(item)
+    MgrsExtension.ext(item).apply(latitude_band="X", grid_square="DH")
+    assert MgrsExtension.ext(item).latitude_band
+    assert MgrsExtension.ext(item).grid_square
+
+
+def test_apply_without_required_fields_raises(item: pystac.Item) -> None:
+    MgrsExtension.add_to(item)
+    with pytest.raises(TypeError, match="missing 2 required positional arguments"):
+        MgrsExtension.ext(item).apply()  # type: ignore
+
+
+@pytest.mark.vcr()
+def test_validate(ext_item: pystac.Item) -> None:
+    assert ext_item.validate()
+
+
+@pytest.mark.parametrize("field", ["latitude_band", "grid_square", "utm_zone"])
+def test_get_field(ext_item: pystac.Item, field: str) -> None:
+    prop = ext_item.properties[f"mgrs:{field}"]
+    attr = getattr(MgrsExtension.ext(ext_item), field)
+
+    assert attr is not None
+    assert attr == prop
+
+
+@pytest.mark.vcr()
+@pytest.mark.parametrize(
+    "field,value",
+    [
+        ("latitude_band", "C"),
+        ("grid_square", "ZA"),
+        ("utm_zone", 59),
+    ],
+)
+def test_set_field(ext_item: pystac.Item, field: str, value) -> None:  # type: ignore
+    original = ext_item.properties[f"mgrs:{field}"]
+    setattr(MgrsExtension.ext(ext_item), field, value)
+    new = ext_item.properties[f"mgrs:{field}"]
+
+    assert new != original
+    assert new == value
+    assert ext_item.validate()
+
+
+def test_utm_zone_set_to_none_pops_from_dict(ext_item: pystac.Item) -> None:
+    assert "mgrs:utm_zone" in ext_item.properties
+
+    MgrsExtension.ext(ext_item).utm_zone = None
+    assert "mgrs:utm_zone" not in ext_item.properties
+
+
+def test_invalid_latitude_band_raises_informative_error(ext_item: pystac.Item) -> None:
+    with pytest.raises(ValueError, match="must be str"):
+        MgrsExtension.ext(ext_item).latitude_band = 2  # type: ignore
+
+    with pytest.raises(ValueError, match="must be str"):
+        MgrsExtension.ext(ext_item).latitude_band = None  # type: ignore
+
+    with pytest.raises(ValueError, match="a is not in "):
+        MgrsExtension.ext(ext_item).latitude_band = "a"
+
+
+def test_invalid_grid_square_raises_informative_error(ext_item: pystac.Item) -> None:
+    with pytest.raises(ValueError, match="must be str"):
+        MgrsExtension.ext(ext_item).grid_square = 2  # type: ignore
+
+    with pytest.raises(ValueError, match="must be str"):
+        MgrsExtension.ext(ext_item).grid_square = None  # type: ignore
+
+    with pytest.raises(ValueError, match="nv does not match the regex "):
+        MgrsExtension.ext(ext_item).grid_square = "nv"
+
+
+def test_invalid_utm_zone_raises_informative_error(ext_item: pystac.Item) -> None:
+    with pytest.raises(ValueError, match="must be None or int"):
+        MgrsExtension.ext(ext_item).utm_zone = "foo"  # type: ignore
+
+    with pytest.raises(ValueError, match="61 is not in "):
+        MgrsExtension.ext(ext_item).utm_zone = 61