pystac-core 1.15.0__tar.gz

pystac_core-1.15.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_core-1.15.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: pystac-core
+Version: 1.15.0
+Summary: Core functionality for PySTAC without extensions. Most users will want to use pystac, not this package
+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
+Author-email: Rob Emanuele <rdemanuele@gmail.com>, Jon Duckworth <duckontheweb@gmail.com>
+Maintainer-email: Pete Gadomski <pete.gadomski@gmail.com>
+License: Apache-2.0
+Keywords: STAC,catalog,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: python-dateutil>=2.7.0

pystac_core-1.15.0/pyproject.toml

@@ -0,0 +1,39 @@
+[project]
+name = "pystac-core"
+description = "Core functionality for PySTAC without extensions. Most users will want to use pystac, not this package"
+readme = "README.md"
+version = "1.15.0"
+authors = [
+    { name = "Rob Emanuele", email = "rdemanuele@gmail.com" },
+    { name = "Jon Duckworth", email = "duckontheweb@gmail.com" },
+]
+maintainers = [{ name = "Pete Gadomski", email = "pete.gadomski@gmail.com" }]
+keywords = ["pystac", "imagery", "raster", "catalog", "STAC"]
+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 = ["python-dateutil>=2.7.0"]
+
+[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_core-1.15.0/pystac/__init__.py

@@ -0,0 +1,260 @@
+# isort: skip_file
+"""
+PySTAC is a library for working with SpatioTemporal Asset Catalogs (STACs)
+"""
+
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+
+__all__ = [
+    "__version__",
+    "TemplateError",
+    "STACError",
+    "STACTypeError",
+    "DuplicateObjectKeyError",
+    "ExtensionAlreadyExistsError",
+    "ExtensionNotImplemented",
+    "ExtensionTypeError",
+    "RequiredPropertyMissing",
+    "STACValidationError",
+    "DeprecatedWarning",
+    "MediaType",
+    "RelType",
+    "StacIO",
+    "STACObject",
+    "STACObjectType",
+    "Link",
+    "HIERARCHICAL_LINKS",
+    "Catalog",
+    "CatalogType",
+    "Collection",
+    "Extent",
+    "SpatialExtent",
+    "TemporalExtent",
+    "Summaries",
+    "CommonMetadata",
+    "RangeSummary",
+    "Item",
+    "Asset",
+    "ItemAssetDefinition",
+    "ItemCollection",
+    "Provider",
+    "ProviderRole",
+    "read_file",
+    "read_dict",
+    "write_file",
+    "get_stac_version",
+    "set_stac_version",
+]
+
+import warnings
+from typing import Any
+
+from pystac.errors import (
+    TemplateError,
+    STACError,
+    STACTypeError,
+    DuplicateObjectKeyError,
+    ExtensionAlreadyExistsError,
+    ExtensionNotImplemented,
+    ExtensionTypeError,
+    RequiredPropertyMissing,
+    STACValidationError,
+    DeprecatedWarning,
+)
+
+from pystac.version import (
+    __version__,
+    get_stac_version,
+    set_stac_version,
+)
+from pystac.media_type import MediaType
+from pystac.rel_type import RelType
+from pystac.stac_io import StacIO
+from pystac.stac_object import STACObject, STACObjectType
+from pystac.link import Link, HIERARCHICAL_LINKS
+from pystac.catalog import Catalog, CatalogType
+from pystac.collection import (
+    Collection,
+    Extent,
+    SpatialExtent,
+    TemporalExtent,
+)
+from pystac.common_metadata import CommonMetadata
+from pystac.summaries import RangeSummary, Summaries
+from pystac.asset import Asset
+from pystac.item import Item
+from pystac.item_assets import ItemAssetDefinition
+from pystac.item_collection import ItemCollection
+from pystac.provider import ProviderRole, Provider
+from pystac.utils import HREF
+
+import pystac.extensions.hooks
+import pystac.extensions.classification
+import pystac.extensions.datacube
+import pystac.extensions.eo
+import pystac.extensions.file
+import pystac.extensions.grid
+import pystac.extensions.item_assets
+
+with warnings.catch_warnings():
+    warnings.filterwarnings("ignore", category=DeprecationWarning)
+    import pystac.extensions.label
+import pystac.extensions.mgrs
+import pystac.extensions.mlm
+import pystac.extensions.pointcloud
+import pystac.extensions.projection
+import pystac.extensions.raster
+import pystac.extensions.sar
+import pystac.extensions.sat
+import pystac.extensions.scientific
+import pystac.extensions.storage
+import pystac.extensions.table
+import pystac.extensions.timestamps
+import pystac.extensions.version
+import pystac.extensions.view
+import pystac.extensions.xarray_assets
+
+EXTENSION_HOOKS = pystac.extensions.hooks.RegisteredExtensionHooks(
+    [
+        pystac.extensions.classification.CLASSIFICATION_EXTENSION_HOOKS,
+        pystac.extensions.datacube.DATACUBE_EXTENSION_HOOKS,
+        pystac.extensions.eo.EO_EXTENSION_HOOKS,
+        pystac.extensions.file.FILE_EXTENSION_HOOKS,
+        pystac.extensions.grid.GRID_EXTENSION_HOOKS,
+        pystac.extensions.item_assets.ITEM_ASSETS_EXTENSION_HOOKS,
+        pystac.extensions.label.LABEL_EXTENSION_HOOKS,
+        pystac.extensions.mgrs.MGRS_EXTENSION_HOOKS,
+        pystac.extensions.mlm.MLM_EXTENSION_HOOKS,
+        pystac.extensions.pointcloud.POINTCLOUD_EXTENSION_HOOKS,
+        pystac.extensions.projection.PROJECTION_EXTENSION_HOOKS,
+        pystac.extensions.raster.RASTER_EXTENSION_HOOKS,
+        pystac.extensions.sar.SAR_EXTENSION_HOOKS,
+        pystac.extensions.sat.SAT_EXTENSION_HOOKS,
+        pystac.extensions.scientific.SCIENTIFIC_EXTENSION_HOOKS,
+        pystac.extensions.storage.STORAGE_EXTENSION_HOOKS,
+        pystac.extensions.table.TABLE_EXTENSION_HOOKS,
+        pystac.extensions.timestamps.TIMESTAMPS_EXTENSION_HOOKS,
+        pystac.extensions.version.VERSION_EXTENSION_HOOKS,
+        pystac.extensions.view.VIEW_EXTENSION_HOOKS,
+        pystac.extensions.xarray_assets.XARRAY_ASSETS_EXTENSION_HOOKS,
+    ]
+)
+
+
+def read_file(href: HREF, stac_io: StacIO | None = None) -> STACObject:
+    """Reads a STAC object from a file.
+
+    This method will return either a Catalog, a Collection, or an Item based on what
+    the file contains.
+
+    This is a convenience method for :meth:`StacIO.read_stac_object
+    <pystac.StacIO.read_stac_object>`
+
+    Args:
+        href : The HREF to read the object from.
+        stac_io: Optional :class:`~StacIO` instance to use for I/O operations. If not
+            provided, will use :meth:`StacIO.default` to create an instance.
+
+    Returns:
+        The specific STACObject implementation class that is represented
+        by the JSON read from the file located at HREF.
+
+    Raises:
+        STACTypeError : If the file at ``href`` does not represent a valid
+            :class:`~pystac.STACObject`. Note that an :class:`~pystac.ItemCollection`
+            is not a :class:`~pystac.STACObject` and must be read using
+            :meth:`ItemCollection.from_file <pystac.ItemCollection.from_file>`
+    """
+    if stac_io is None:
+        stac_io = StacIO.default()
+    return stac_io.read_stac_object(href)
+
+
+def write_file(
+    obj: STACObject,
+    include_self_link: bool = True,
+    dest_href: HREF | None = None,
+    stac_io: StacIO | None = None,
+) -> None:
+    """Writes a STACObject to a file.
+
+    This will write only the Catalog, Collection or Item ``obj``. It will not attempt
+    to write any other objects that are linked to ``obj``; if you'd like functionality
+    to save off catalogs recursively see :meth:`Catalog.save <pystac.Catalog.save>`.
+
+    This method will write the JSON of the object to the object's assigned "self" link
+    or to the dest_href if provided. To set the self link, see
+    :meth:`STACObject.set_self_href <pystac.STACObject.set_self_href>`.
+
+    Convenience method for :meth:`STACObject.from_file <pystac.STACObject.from_file>`
+
+    Args:
+        obj : The STACObject to save.
+        include_self_link : If ``True``, include the ``"self"`` link with this object.
+            Otherwise, leave out the self link.
+        dest_href : Optional HREF to save the file to. If ``None``, the object will be
+            saved to the object's ``"self"`` href.
+        stac_io: Optional :class:`~StacIO` instance to use for I/O operations. If not
+            provided, will use :meth:`StacIO.default` to create an instance.
+    """
+    if stac_io is None:
+        stac_io = StacIO.default()
+    import os
+
+    dest_href = None if dest_href is None else str(os.fspath(dest_href))
+    obj.save_object(
+        include_self_link=include_self_link, dest_href=dest_href, stac_io=stac_io
+    )
+
+
+def read_dict(
+    d: dict[str, Any],
+    href: str | None = None,
+    root: Catalog | None = None,
+    stac_io: StacIO | None = None,
+) -> STACObject:
+    """Reads a :class:`~STACObject` or :class:`~ItemCollection` from a JSON-like dict
+    representing a serialized STAC object.
+
+    This method will return either a :class:`~Catalog`, :class:`~Collection`,
+    or :class`~Item` based on the contents of the dict.
+
+    This is a convenience method for either
+    :meth:`StacIO.stac_object_from_dict <pystac.StacIO.stac_object_from_dict>`.
+
+    Args:
+        d : The dict to parse.
+        href : Optional href that is the file location of the object being
+            parsed.
+        root : Optional root of the catalog for this object.
+            If provided, the root's resolved object cache can be used to search for
+            previously resolved instances of the STAC object.
+        stac_io: Optional :class:`~StacIO` instance to use for reading. If ``None``,
+            the default instance will be used.
+
+    Raises:
+        STACTypeError : If the ``d`` dictionary does not represent a valid
+            :class:`~pystac.STACObject`. Note that an :class:`~pystac.ItemCollection`
+            is not a :class:`~pystac.STACObject` and must be read using
+            :meth:`ItemCollection.from_dict <pystac.ItemCollection.from_dict>`
+    """
+    if stac_io is None:
+        stac_io = StacIO.default()
+    return stac_io.stac_object_from_dict(d, href, root)
+
+
+def __getattr__(name: str) -> Any:
+    if name == "validation":
+        import warnings
+        import pystac.validation
+
+        warnings.warn(
+            "pystac.validation will not be automatically imported to the package in "
+            "pystac v2.0. Instead, import it directly: `import pystac.validation`",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return pystac.validation
+    raise AttributeError(f"module '{__name__}' has no attribute '{name}'")