pystac-ext-sat 1.0.0__tar.gz

pystac_ext_sat-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_sat-1.0.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: pystac-ext-sat
+Version: 1.0.0
+Summary: Satellite 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,pystac,raster,sat
+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-sat
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Satellite Extension](https://github.com/stac-extensions/sat).
+This extension provides fields for describing satellite-specific metadata, including orbit state vectors, relative orbit numbers, and platform-specific identifiers.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/sat/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_sat-1.0.0/README.md

@@ -0,0 +1,13 @@
+# pystac-ext-sat
+
+[PySTAC](https://pypi.org/project/pystac/) extension package for the [Satellite Extension](https://github.com/stac-extensions/sat).
+This extension provides fields for describing satellite-specific metadata, including orbit state vectors, relative orbit numbers, and platform-specific identifiers.
+
+## Supported versions
+
+- [v1.0.0](https://stac-extensions.github.io/sat/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_sat-1.0.0/pyproject.toml

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

@@ -0,0 +1,319 @@
+"""Implements the :stac-ext:`Satellite Extension <sat>`."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from datetime import datetime
+from typing import (
+    Any,
+    Generic,
+    Literal,
+    TypeVar,
+    cast,
+)
+
+import pystac
+from pystac.extensions.base import (
+    ExtensionManagementMixin,
+    PropertiesExtension,
+    SummariesExtension,
+)
+from pystac.extensions.hooks import ExtensionHooks
+from pystac.summaries import RangeSummary
+from pystac.utils import StringEnum, datetime_to_str, map_opt, str_to_datetime
+
+#: Generalized version of :class:`~pystac.Item`, :class:`~pystac.Asset` or
+#: :class:`~pystac.ItemAssetDefinition`
+T = TypeVar("T", pystac.Item, pystac.Asset, pystac.ItemAssetDefinition)
+
+SCHEMA_URI = "https://stac-extensions.github.io/sat/v1.0.0/schema.json"
+
+PREFIX: str = "sat:"
+PLATFORM_INTERNATIONAL_DESIGNATOR_PROP: str = (
+    PREFIX + "platform_international_designator"
+)
+ABSOLUTE_ORBIT_PROP: str = PREFIX + "absolute_orbit"
+ORBIT_STATE_PROP: str = PREFIX + "orbit_state"
+RELATIVE_ORBIT_PROP: str = PREFIX + "relative_orbit"
+ANX_DATETIME_PROP: str = PREFIX + "anx_datetime"
+
+
+class OrbitState(StringEnum):
+    ASCENDING = "ascending"
+    DESCENDING = "descending"
+    GEOSTATIONARY = "geostationary"
+
+
+class SatExtension(
+    Generic[T],
+    PropertiesExtension,
+    ExtensionManagementMixin[pystac.Item | pystac.Collection],
+):
+    """An abstract class that can be used to extend the properties of an
+    :class:`~pystac.Item` or :class:`~pystac.Asset` with properties from the
+    :stac-ext:`Satellite Extension <sat>`. This class is generic over the type of
+    STAC Object to be extended (e.g. :class:`~pystac.Item`,
+    :class:`~pystac.Collection`).
+
+    To create a concrete instance of :class:`SatExtension`, use the
+    :meth:`SatExtension.ext` method. For example:
+
+    .. code-block:: python
+
+       >>> item: pystac.Item = ...
+       >>> sat_ext = SatExtension.ext(item)
+    """
+
+    name: Literal["sat"] = "sat"
+
+    def apply(
+        self,
+        orbit_state: OrbitState | None = None,
+        relative_orbit: int | None = None,
+        absolute_orbit: int | None = None,
+        platform_international_designator: str | None = None,
+        anx_datetime: datetime | None = None,
+    ) -> None:
+        """Applies ext extension properties to the extended :class:`~pystac.Item` or
+        class:`~pystac.Asset`.
+
+        Must specify at least one of orbit_state or relative_orbit in order
+        for the sat extension to properties to be valid.
+
+        Args:
+            orbit_state : Optional state of the orbit. Either ascending or
+                descending for polar orbiting satellites, or geostationary for
+                geosynchronous satellites.
+            relative_orbit : Optional non-negative integer of the orbit number at
+                the time of acquisition.
+        """
+
+        self.platform_international_designator = platform_international_designator
+        self.orbit_state = orbit_state
+        self.absolute_orbit = absolute_orbit
+        self.relative_orbit = relative_orbit
+        self.anx_datetime = anx_datetime
+
+    @property
+    def platform_international_designator(self) -> str | None:
+        """Gets or sets the International Designator, also known as COSPAR ID, and
+        NSSDCA ID."""
+        return self._get_property(PLATFORM_INTERNATIONAL_DESIGNATOR_PROP, str)
+
+    @platform_international_designator.setter
+    def platform_international_designator(self, v: str | None) -> None:
+        self._set_property(PLATFORM_INTERNATIONAL_DESIGNATOR_PROP, v)
+
+    @property
+    def orbit_state(self) -> OrbitState | None:
+        """Get or sets an orbit state of the object."""
+        return map_opt(
+            lambda x: OrbitState(x), self._get_property(ORBIT_STATE_PROP, str)
+        )
+
+    @orbit_state.setter
+    def orbit_state(self, v: OrbitState | None) -> None:
+        self._set_property(ORBIT_STATE_PROP, map_opt(lambda x: x.value, v))
+
+    @property
+    def absolute_orbit(self) -> int | None:
+        """Get or sets an absolute orbit number of the item."""
+        return self._get_property(ABSOLUTE_ORBIT_PROP, int)
+
+    @absolute_orbit.setter
+    def absolute_orbit(self, v: int | None) -> None:
+        self._set_property(ABSOLUTE_ORBIT_PROP, v)
+
+    @property
+    def relative_orbit(self) -> int | None:
+        """Get or sets a relative orbit number of the item."""
+        return self._get_property(RELATIVE_ORBIT_PROP, int)
+
+    @relative_orbit.setter
+    def relative_orbit(self, v: int | None) -> None:
+        self._set_property(RELATIVE_ORBIT_PROP, v)
+
+    @property
+    def anx_datetime(self) -> datetime | None:
+        return map_opt(str_to_datetime, self._get_property(ANX_DATETIME_PROP, str))
+
+    @anx_datetime.setter
+    def anx_datetime(self, v: datetime | None) -> None:
+        self._set_property(ANX_DATETIME_PROP, map_opt(datetime_to_str, v))
+
+    @classmethod
+    def get_schema_uri(cls) -> str:
+        return SCHEMA_URI
+
+    @classmethod
+    def ext(cls, obj: T, add_if_missing: bool = False) -> SatExtension[T]:
+        """Extends the given STAC Object with properties from the :stac-ext:`Satellite
+        Extension <sat>`.
+
+        This extension can be applied to instances of :class:`~pystac.Item` or
+        :class:`~pystac.Asset`.
+
+        Raises:
+
+            pystac.ExtensionTypeError : If an invalid object type is passed.
+        """
+        if isinstance(obj, pystac.Item):
+            cls.ensure_has_extension(obj, add_if_missing)
+            return cast(SatExtension[T], ItemSatExtension(obj))
+        elif isinstance(obj, pystac.Asset):
+            cls.ensure_owner_has_extension(obj, add_if_missing)
+            return cast(SatExtension[T], AssetSatExtension(obj))
+        elif isinstance(obj, pystac.ItemAssetDefinition):
+            cls.ensure_owner_has_extension(obj, add_if_missing)
+            return cast(SatExtension[T], ItemAssetsSatExtension(obj))
+        else:
+            raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
+
+    @classmethod
+    def summaries(
+        cls, obj: pystac.Collection, add_if_missing: bool = False
+    ) -> SummariesSatExtension:
+        """Returns the extended summaries object for the given collection."""
+        cls.ensure_has_extension(obj, add_if_missing)
+        return SummariesSatExtension(obj)
+
+
+class ItemSatExtension(SatExtension[pystac.Item]):
+    """A concrete implementation of :class:`SatExtension` on an :class:`~pystac.Item`
+    that extends the properties of the Item to include properties defined in the
+    :stac-ext:`Satellite Extension <sat>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`SatExtension.ext` on an :class:`~pystac.Item` to
+    extend it.
+    """
+
+    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"<ItemSatExtension Item id={self.item.id}>"
+
+
+class AssetSatExtension(SatExtension[pystac.Asset]):
+    """A concrete implementation of :class:`SatExtension` on an :class:`~pystac.Asset`
+    that extends the properties of the Asset to include properties defined in the
+    :stac-ext:`Satellite Extension <sat>`.
+
+    This class should generally not be instantiated directly. Instead, call
+    :meth:`SatExtension.ext` on an :class:`~pystac.Asset` to
+    extend it.
+    """
+
+    asset_href: str
+    """The ``href`` value of the :class:`~pystac.Asset` being extended."""
+
+    properties: dict[str, Any]
+    """The :class:`~pystac.Asset` fields, including extension properties."""
+
+    additional_read_properties: Iterable[dict[str, Any]] | None = None
+    """If present, this will be a list containing 1 dictionary representing the
+    properties of the owning :class:`~pystac.Item`."""
+
+    def __init__(self, asset: pystac.Asset):
+        self.asset_href = asset.href
+        self.properties = asset.extra_fields
+        if asset.owner and isinstance(asset.owner, pystac.Item):
+            self.additional_read_properties = [asset.owner.properties]
+
+    def __repr__(self) -> str:
+        return f"<AssetSatExtension Asset href={self.asset_href}>"
+
+
+class ItemAssetsSatExtension(SatExtension[pystac.ItemAssetDefinition]):
+    properties: dict[str, Any]
+    asset_defn: pystac.ItemAssetDefinition
+
+    def __init__(self, item_asset: pystac.ItemAssetDefinition):
+        self.asset_defn = item_asset
+        self.properties = item_asset.properties
+
+
+class SummariesSatExtension(SummariesExtension):
+    """A concrete implementation of :class:`~pystac.extensions.base.SummariesExtension`
+    that extends the ``summaries`` field of a :class:`~pystac.Collection` to include
+    properties defined in the :stac-ext:`Satellite Extension <sat>`.
+    """
+
+    @property
+    def platform_international_designator(self) -> list[str] | None:
+        """Get or sets the summary of
+        :attr:`SatExtension.platform_international_designator` values for this
+        Collection.
+        """
+
+        return self.summaries.get_list(PLATFORM_INTERNATIONAL_DESIGNATOR_PROP)
+
+    @platform_international_designator.setter
+    def platform_international_designator(self, v: list[str] | None) -> None:
+        self._set_summary(PLATFORM_INTERNATIONAL_DESIGNATOR_PROP, v)
+
+    @property
+    def orbit_state(self) -> list[OrbitState] | None:
+        """Get or sets the summary of :attr:`SatExtension.orbit_state` values
+        for this Collection.
+        """
+
+        return self.summaries.get_list(ORBIT_STATE_PROP)
+
+    @orbit_state.setter
+    def orbit_state(self, v: list[OrbitState] | None) -> None:
+        self._set_summary(ORBIT_STATE_PROP, v)
+
+    @property
+    def absolute_orbit(self) -> RangeSummary[int] | None:
+        return self.summaries.get_range(ABSOLUTE_ORBIT_PROP)
+
+    @absolute_orbit.setter
+    def absolute_orbit(self, v: RangeSummary[int] | None) -> None:
+        self._set_summary(ABSOLUTE_ORBIT_PROP, v)
+
+    @property
+    def relative_orbit(self) -> RangeSummary[int] | None:
+        return self.summaries.get_range(RELATIVE_ORBIT_PROP)
+
+    @relative_orbit.setter
+    def relative_orbit(self, v: RangeSummary[int] | None) -> None:
+        self._set_summary(RELATIVE_ORBIT_PROP, v)
+
+    @property
+    def anx_datetime(self) -> RangeSummary[datetime] | None:
+        return map_opt(
+            lambda s: RangeSummary(
+                str_to_datetime(s.minimum), str_to_datetime(s.maximum)
+            ),
+            self.summaries.get_range(ANX_DATETIME_PROP),
+        )
+
+    @anx_datetime.setter
+    def anx_datetime(self, v: RangeSummary[datetime] | None) -> None:
+        self._set_summary(
+            ANX_DATETIME_PROP,
+            map_opt(
+                lambda s: RangeSummary(
+                    datetime_to_str(s.minimum), datetime_to_str(s.maximum)
+                ),
+                v,
+            ),
+        )
+
+
+class SatExtensionHooks(ExtensionHooks):
+    schema_uri: str = SCHEMA_URI
+    prev_extension_ids = {"sat"}
+    stac_object_types = {pystac.STACObjectType.ITEM}
+
+
+SAT_EXTENSION_HOOKS: ExtensionHooks = SatExtensionHooks()

pystac_ext_sat-1.0.0/tests/cassettes/test_sat/test_absolute_orbit.yaml

@@ -0,0 +1,62 @@
+interactions:
+- request:
+    body: null
+    headers: {}
+    method: GET
+    uri: https://stac-extensions.github.io/sat/v1.0.0/schema.json
+  response:
+    body:
+      string: "{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"$id\":
+        \"https://stac-extensions.github.io/sat/v1.0.0/schema.json\",\n  \"title\":
+        \"Satellite Extension\",\n  \"description\": \"STAC Sat Extension to a STAC
+        Item.\",\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                  \"anyOf\":
+        [\n                    {\n                      \"required\": [\n                        \"sat:platform_international_designator\"\n
+        \                     ]\n                    },\n                    {\n                      \"required\":
+        [\n                        \"sat:orbit_state\"\n                      ]\n
+        \                   },\n                    {\n                      \"required\":
+        [\n                        \"sat:absolute_orbit\"\n                      ]\n
+        \                   },\n                    {\n                      \"required\":
+        [\n                        \"sat:relative_orbit\"\n                      ]\n
+        \                   },\n                    {\n                      \"required\":
+        [\n                        \"sat:anx_datetime\"\n                      ]\n
+        \                   }\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    }\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/sat/v1.0.0/schema.json\"\n
+        \         }\n        }\n      }\n    },\n    \"fields\": {\n      \"type\":
+        \"object\",\n      \"properties\": {\n        \"sat:platform_international_designator\":
+        {\n          \"type\": \"string\"\n        },\n        \"sat:orbit_state\":
+        {\n          \"title\": \"Orbit State\",\n          \"type\": \"string\",\n
+        \         \"enum\": [\n            \"ascending\",\n            \"descending\",\n
+        \           \"geostationary\"\n          ]\n        },\n        \"sat:absolute_orbit\":
+        {\n          \"type\": \"integer\",\n          \"minimum\": 1\n        },\n
+        \       \"sat:relative_orbit\": {\n          \"type\": \"integer\",\n          \"minimum\":
+        1\n        },\n        \"sat:anx_datetime\": {\n          \"type\": \"string\",\n
+        \         \"format\": \"date-time\"\n        }\n      },\n      \"patternProperties\":
+        {\n        \"^(?!sat:)\": {\n          \"$comment\": \"Do not allow unspecified
+        fields prefixed with sat:\"\n        }\n      },\n      \"additionalProperties\":
+        false\n    }\n  }\n}"
+    headers: {}
+    status:
+      code: 200
+      message: OK
+version: 1