Merge pull request #568 from stac-utils/main

Merge v1.0 changes to the 1.0 release branch

Author: lossyrob

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+formats:
+  # Temporarily disabling PDF downloads due to problem with nbsphinx in LateX builds
+  # - pdf
+  - epub
+
+python:
+  version: "3.7"
+  install:
+    - requirements: requirements-docs.txt
+    - method: pip
+      path: .
+
+sphinx:
+  fail_on_warning: false

CHANGELOG.md

@@ -10,6 +10,47 @@
 
 ### Deprecated
 
+### Fixed
+
+## [v1.0.0]
+
+### Added
+
+- `ProjectionExtension.crs_string` to provide a single string to describe the coordinate reference system (CRS).
+  Useful because projections can be defined by EPSG code, WKT, or projjson.
+  ([#548](https://github.com/stac-utils/pystac/pull/548))
+- SAR Extension summaries([#556](https://github.com/stac-utils/pystac/pull/556))
+- Migration for `sar:type` -> `sar:product_type` and `sar:polarization` ->
+  `sar:polarizations` for pre-0.9 catalogs
+  ([#556](https://github.com/stac-utils/pystac/pull/556))
+- Migration from `eo:epsg` -> `proj:epsg` for pre-0.9 catalogs ([#557](https://github.com/stac-utils/pystac/pull/557))
+- Collection summaries for Point Cloud Extension ([#558](https://github.com/stac-utils/pystac/pull/558))
+- `PhenomenologyType` enum for recommended values of `pc:type` & `SchemaType` enum for
+  valid values of `type` in [Point Cloud Schema
+  Objects](https://github.com/stac-extensions/pointcloud#schema-object)
+  ([#548](https://github.com/stac-utils/pystac/pull/548))
+- `to_dict` and equality definition for `extensions.item_asset.AssetDefinition` ([#564](https://github.com/stac-utils/pystac/pull/564))
+- `Asset.common_metadata` property ([#563](https://github.com/stac-utils/pystac/pull/563))
+
+### Changed
+
+- The `from_dict` method on STACObjects will set the object's root link when a `root` parameter is present. An ItemCollection `from_dict` with a root parameter will set the root on each of it's Items. ([#549](https://github.com/stac-utils/pystac/pull/549))
+- Calling `ExtensionManagementMixin.validate_has_extension` with `add_if_missing = True`
+  on an ownerless `Asset` will raise a `STACError` ([#554](https://github.com/stac-utils/pystac/pull/554))
+- `PointcloudSchema` -> `Schema`, `PointcloudStatistic` -> `Statistic` for consistency
+  with naming convention in other extensions
+  ([#548](https://github.com/stac-utils/pystac/pull/548))
+- `RequiredPropertyMissing` always raised when trying to get a required property that is
+  `None` (`STACError` or `KeyError` was previously being raised in some cases)
+  ([#561](https://github.com/stac-utils/pystac/pull/561))
+
+### Fixed
+
+- Added `Collections` as a type that can be extended for extensions whose fields can appear in collection summaries ([#547](https://github.com/stac-utils/pystac/pull/547))
+- Allow resolved self links when getting an object's self href ([#555](https://github.com/stac-utils/pystac/pull/555))
+- Fixed type annotation on SummariesLabelExtension.label_properties setter ([#562](https://github.com/stac-utils/pystac/pull/562))
+- Allow comparable types with alternate parameter naming of __lt__ method to pass structural type linting for RangeSummary ([#562](https://github.com/stac-utils/pystac/pull/562))
+
 ## [v1.0.0-rc.3]
 
 ### Added
@@ -436,7 +477,8 @@ use `Band.create`
 
 Initial release.
 
-[Unreleased]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.3..main>
+[Unreleased]: <https://github.com/stac-utils/pystac/compare/v1.0.0..main>
+[v1.0.0]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.3..v1.0.0>
 [v1.0.0-rc.3]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.2..v1.0.0-rc.3>
 [v1.0.0-rc.2]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.1..v1.0.0-rc.2>
 [v1.0.0-rc.1]: <https://github.com/stac-utils/pystac/compare/v1.0.0-beta.3..v1.0.0-rc.1>

docs/api.rst

@@ -294,6 +294,106 @@ ExtensionManagementMixin
    :members:
    :show-inheritance:
 
+Datacube Extension
+------------------
+
+These classes are representations of the :stac-ext:`EO Extension Spec <eo>`.
+
+DimensionType
+~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.DimensionType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+HorizontalSpatialDimensionAxis
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.HorizontalSpatialDimensionAxis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+VerticalSpatialDimensionAxis
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.VerticalSpatialDimensionAxis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Dimension
+~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.Dimension
+   :members:
+   :show-inheritance:
+
+HorizontalSpatialDimension
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.HorizontalSpatialDimension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+VerticalSpatialDimension
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.VerticalSpatialDimension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+TemporalSpatialDimension
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.TemporalSpatialDimension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+AdditionalDimension
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.AdditionalDimension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+DatacubeExtension
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.DatacubeExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+CollectionDatacubeExtension
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.CollectionDatacubeExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+ItemDatacubeExtension
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.ItemDatacubeExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+AssetDatacubeExtension
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.datacube.AssetDatacubeExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
 Electro-Optical Extension
 -------------------------
 
@@ -365,6 +465,27 @@ FileExtension
    :show-inheritance:
    :undoc-members:
 
+Item Assets Extension
+---------------------
+
+These classes are representations of the :stac-ext:`Item Assets Extension Spec
+<item-assets>`.
+
+AssetDefinition
+~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.item_assets.AssetDefinition
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ItemAssetsExtension
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.item_assets.ItemAssetsExtension
+   :members:
+   :show-inheritance:
+
 Label Extension
 ---------------
 
@@ -423,17 +544,62 @@ LabelExtension
 Pointcloud Extension
 --------------------
 
-Implements the :stac-ext:`Point Cloud Extension <pointcloud>`.
+These classes are representations of the :stac-ext:`Pointcloud Extension Spec
+<pointcloud>`.
 
-PointcloudItemExt
+PhenomenologyType
 ~~~~~~~~~~~~~~~~~
 
-**TEMPORARILY REMOVED**
+.. autoclass:: pystac.extensions.pointcloud.PhenomenologyType
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
-.. .. autoclass:: pystac.extensions.pointcloud.PointcloudItemExt
-..    :members:
-..    :undoc-members:
-..    :show-inheritance:
+SchemaType
+~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.SchemaType
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Schema
+~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.Schema
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+Statistic
+~~~~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.Statistic
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+PointcloudExtension
+~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.PointcloudExtension
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+ItemPointcloudExtension
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.ItemPointcloudExtension
+   :members:
+   :show-inheritance:
+
+AssetPointcloudExtension
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.pointcloud.AssetPointcloudExtension
+   :members:
+   :show-inheritance:
 
 Projection Extension
 --------------------
@@ -499,8 +665,63 @@ RasterExtension
    :show-inheritance:
    :inherited-members:
 
+SAR Extension
+-------------
+These classes are representations of the :stac-ext:`SAR Extension Spec
+<sar>`.
+
+FrequencyBand
+~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.FrequencyBand
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Polarization
+~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.Polarization
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+ObservationDirection
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.ObservationDirection
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+SarExtension
+~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.SarExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+ItemSarExtension
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.ItemSarExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+AssetSarExtension
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sar.AssetSarExtension
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
 Satellite Extension
 -------------------
+These classes are representations of the :stac-ext:`Satellite Extension Spec
+<sat>`.
 
 OrbitState
 ~~~~~~~~~~

pystac/__init__.py

@@ -30,14 +30,13 @@
     Extent,
     SpatialExtent,
     TemporalExtent,
-    Provider,
-    ProviderRole,
     Summaries,
 )
+from pystac.common_metadata import CommonMetadata
 from pystac.summaries import RangeSummary
-from pystac.item import Item, Asset, CommonMetadata
+from pystac.item import Item, Asset
 from pystac.item_collection import ItemCollection
-
+from pystac.provider import ProviderRole, Provider
 import pystac.validation
 
 import pystac.extensions.hooks