Merge pull request #540 from stac-utils/main

Merge v1.0.0-rc.3 changes into 1.0 branch

Author: Jon Duckworth

.coveragerc

@@ -1,5 +1,11 @@
 [report]
-fail_under = 91
+fail_under = 94
+exclude_lines =
+    if TYPE_CHECKING:
+
 
 [run]
-source = pystac
+branch = true
+source =
+    pystac
+    tests

.flake8

@@ -1,3 +1,4 @@
 [flake8]
 max-line-length = 88
-extend-ignore = E203, W503, E731, E722
+extend-ignore = E203, W503, E731, E722
+per-file-ignores = __init__.py:F401

.github/workflows/continuous-integration.yml

@@ -14,15 +14,16 @@ jobs:
   test:
     name: test
     runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ startsWith(matrix.python-version, '3.10')}}
     strategy:
       # Allow other matrix jobs to complete if 1 fails
       fail-fast: false
       matrix:
         python-version:
-          - "3.6"
           - "3.7"
           - "3.8"
           - "3.9"
+          - "3.10.0-beta.3"
         os:
           - ubuntu-latest
           - windows-latest
@@ -36,6 +37,18 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - uses: actions-rs/toolchain@v1
+        # No wheels exist for orjson on Python 3.10 on MacOS or Windows, and the Linux
+        #  wheels are sometimes not uploaded until after the package is initially
+        # published. This sets up the Rust nightly toolchain so we can build the orjson
+        # wheel.
+        if: ${{ startsWith(matrix.python-version, '3.10')}}
+        with:
+          toolchain: nightly
+          override: true
+          default: true
+          profile: minimal
+
       - name: Cache dependencies (Linux)
         if: startsWith(runner.os, 'Linux')
         uses: actions/cache@v2
@@ -97,11 +110,14 @@ jobs:
           pip install -e ".[validation]"
       
       - name: Execute test suite
-        # --fail-under=0 ensures we publish the coverage regardless of whether it meets
-        # the minimum so we can use Codecov to evaluate gaps
-        run: |
-          coverage run --source=pystac/ -m unittest discover tests/
-          coverage xml --fail-under=0
+        run: ./scripts/test
+        env:
+          CHECK_COVERAGE: true
+
+      - name: Prepare ./coverage.xml
+        # Ignore the configured fail-under to ensure we upload the coverage report. We
+        # will trigger a failure for coverage drops in a later job
+        run: coverage xml --fail-under 0
 
       - name: Upload All coverage to Codecov
         uses: codecov/codecov-action@v1
@@ -111,16 +127,22 @@ jobs:
           file: ./coverage.xml
           fail_ci_if_error: false 
 
+      - name: Check for coverage drop
+        # This will use the configured fail-under, causing this job to fail if the
+        # coverage drops.
+        run: coverage report
+
   lint:
     runs-on: ubuntu-latest
     strategy:
       # Allow other matrix jobs to complete if 1 fails
       fail-fast: false
       matrix:
         python-version:
-          - "3.6"
           - "3.7"
           - "3.8"
+          - "3.9"
+          - "3.10.0-beta.3"
 
     steps:
       - uses: actions/checkout@v2

CHANGELOG.md

@@ -4,13 +4,52 @@
 
 ### Added
 
+### Removed
+
+### Changed
+
+### Deprecated
+
+## [v1.0.0-rc.3]
+
+### Added
+
+- (Experimental) support for Python 3.10 ([#473](https://github.com/stac-utils/pystac/pull/473))
+-  `LabelTask` enum in `pystac.extensions.label` with recommended values for
+  `"label:tasks"` field ([#484](https://github.com/stac-utils/pystac/pull/484))
+-  `LabelMethod` enum in `pystac.extensions.label` with recommended values for
+  `"label:methods"` field ([#484](https://github.com/stac-utils/pystac/pull/484))
+- Label Extension summaries ([#484](https://github.com/stac-utils/pystac/pull/484))
+- Timestamps Extension summaries ([#513](https://github.com/stac-utils/pystac/pull/513))
+- Define equality and `__repr__` of `RangeSummary` instances based on `to_dict`
+  representation ([#513](https://github.com/stac-utils/pystac/pull/513))
+- Sat Extension summaries ([#509](https://github.com/stac-utils/pystac/pull/509))
+- `Catalog.get_collections` for getting all child
+  `Collections` for a catalog, and `Catalog.get_all_collections` for recursively getting
+  all child `Collections` for a catalog and its children ([#511](https://github.com/stac-utils/pystac/pull/))
+
 ### Changed
 
+- Renamed `Asset.properties` -> `Asset.extra_fields` and `Link.properties` ->
+  `Link.extra_fields` for consistency with other STAC objects
+  ([#510](https://github.com/stac-utils/pystac/pull/510))
+
 ### Fixed
 
+- Bug in `pystac.serialization.identify_stac_object_type` where invalid objects with
+  `stac_version == 1.0.0` were incorrectly identified as Catalogs
+  ([#487](https://github.com/stac-utils/pystac/pull/487))
+- `Link` constructor classes (e.g. `Link.from_dict`, `Link.canonical`, etc.) now return
+  the calling class instead of always returning the `Link` class
+  ([#512](https://github.com/stac-utils/pystac/pull/512))
+- Sat extension now includes all fields defined in v1.0.0
+  ([#509](https://github.com/stac-utils/pystac/pull/509))
+
 ### Removed
 
-### Deprecated
+- `STAC_IO` class in favor of `StacIO`. This was deprecated in v1.0.0-beta.1 and has
+  been removed in this release. ([#490](https://github.com/stac-utils/pystac/pull/490))
+- Support for Python 3.6 ([#500](https://github.com/stac-utils/pystac/pull/500))
 
 ## [v1.0.0-rc.2]
 
@@ -131,7 +170,7 @@
 - Removed `LinkMixin`, and implemented those methods on `STACObject` directly. STACObject was the only class using LinkMixin and this should not effect users ([#309](https://github.com/stac-utils/pystac/pull/309)
 - Removed `single-file-stac` extension; this extension is being removed in favor of ItemCollection usage ([#309](https://github.com/stac-utils/pystac/pull/309)
 
-# Deprecated
+### Deprecated
 
 - Deprecated `STAC_IO` in favor of new `StacIO` class. `STAC_IO` will be removed in
   v1.0.0. ([#309](https://github.com/stac-utils/pystac/pull/309))
@@ -397,7 +436,8 @@ use `Band.create`
 
 Initial release.
 
-[Unreleased]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.2..main>
+[Unreleased]: <https://github.com/stac-utils/pystac/compare/v1.0.0-rc.3..main>
+[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>
 [v1.0.0-beta.3]: <https://github.com/stac-utils/pystac/compare/v1.0.0-beta.2..v1.0.0-beta.3>

README.md

@@ -6,10 +6,19 @@
 [![Gitter](https://badges.gitter.im/SpatioTemporal-Asset-Catalog/python.svg)](https://gitter.im/SpatioTemporal-Asset-Catalog/python?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-PySTAC is a library for working with [SpatialTemporal Asset Catalog](https://stacspec.org) in Python 3.
+PySTAC is a library for working with [SpatioTemporal Asset Catalog](https://stacspec.org) in Python 3.
 
 ## Installation
 
+PySTAC requires Python >= 3.7. This project follows the recommendations of
+[NEP-29](https://numpy.org/neps/nep-0029-deprecation_policy.html) in deprecating support
+for Python versions. This means that users can expect support for Python 3.7 to be
+removed from the `main` branch after Dec 26, 2021 and therefore from the next release
+after that date.
+
+*Support for Python >= 3.10 should be considered experimental
+until further notice.*
+
 PySTAC has a single required dependency (`python-dateutil`).
 PySTAC can be installed from pip or the source repository.
 
@@ -34,6 +43,10 @@ optional `orjson` requirements:
 > pip install pystac[orjson]
 ```
 
+> *`orjson` wheels are only available for Linux in Python 3.10. If you are using the
+> `orjson` extra with Python 3.10 you will need to have the Rust nightly toolchain
+> installed as your default toolchain in order to build the package wheel.*
+
 From source repository:
 
 ```bash

docs/api.rst

@@ -86,6 +86,14 @@ TemporalExtent
    :members:
    :undoc-members:
 
+ProviderRole
+~~~~~~~~~~~~
+
+.. autoclass:: pystac.ProviderRole
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Provider
 ~~~~~~~~
 
@@ -185,16 +193,6 @@ DuplicateKeyReportingMixin
    :members:
    :show-inheritance:
 
-STAC_IO
-~~~~~~~
-
-.. deprecated:: 1.0.0-beta.1
-   Use :class:`pystac.StacIO` instead. This class will be removed in v1.0.0.
-
-.. autoclass:: pystac.stac_io.STAC_IO
-   :members:
-   :undoc-members:
-
 Layout
 ------
 
@@ -501,6 +499,45 @@ RasterExtension
    :show-inheritance:
    :inherited-members:
 
+Satellite Extension
+-------------------
+
+OrbitState
+~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sat.OrbitState
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+SatExtension
+~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sat.SatExtension
+   :members:
+   :show-inheritance:
+
+ItemSatExtension
+~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sat.ItemSatExtension
+   :members:
+   :show-inheritance:
+
+AssetSatExtension
+~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sat.AssetSatExtension
+   :members:
+   :show-inheritance:
+
+SummariesSatExtension
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.sat.SummariesSatExtension
+   :members:
+   :show-inheritance:
+
 Scientific Extension
 --------------------
 
@@ -538,17 +575,29 @@ ItemScientificExtension
 Timestamps Extension
 --------------------
 
-Implements the :stac-ext:`Timestamps Extension <timestamps>`.
+These classes are representations of the :stac-ext:`Timestamps Extension Spec
+<timestamps>`.
 
-TimestampsItemExt
-~~~~~~~~~~~~~~~~~
+TimestampsExtension
+~~~~~~~~~~~~~~~~~~~
 
-**TEMPORARILY REMOVED**
+.. autoclass:: pystac.extensions.timestamps.TimestampsExtension
+   :members:
+   :show-inheritance:
 
-.. .. autoclass:: pystac.extensions.timestamps.TimestampsItemExt
-..    :members:
-..    :undoc-members:
-..    :show-inheritance:
+ItemTimestampsExtension
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.timestamps.ItemTimestampsExtension
+   :members:
+   :show-inheritance:
+
+AssetTimestampsExtension
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: pystac.extensions.timestamps.AssetTimestampsExtension
+   :members:
+   :show-inheritance:
 
 SAR Extension
 -------------

docs/conf.py

@@ -4,7 +4,7 @@
 #
 # This file does only contain a selection of the most common options. For a
 # full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 

docs/contributing.rst

@@ -39,6 +39,10 @@ or the entire project using:
 
     ./scripts/test
 
+The last command will also check test coverage. To view the coverage report, you can run
+`coverage report` (to view the report in the terminal) or `coverage html` (to generate
+an HTML report that can be opened in a browser).
+
 More details on using ``unittest`` are `here
 <https://docs.python.org/3/library/unittest.html>`_.
 
@@ -53,7 +57,7 @@ PySTAC uses
 - `black <https://github.com/psf/black>`_ for Python code formatting
 - `codespell <https://github.com/codespell-project/codespell/>`_ to check code for common misspellings
 - `doc8 <https://github.com/pycqa/doc8>`__ for style checking on RST files in the docs
-- `flake8 <http://flake8.pycqa.org/en/latest/>`_ for Python style checks
+- `flake8 <https://flake8.pycqa.org/en/latest/>`_ for Python style checks
 - `mypy <http://www.mypy-lang.org/>`_ for Python type annotation checks
 
 Run all of these with ``pre-commit run --all-files`` or a single one using

docs/make.bat

@@ -21,7 +21,7 @@ if errorlevel 9009 (
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 

docs/tutorials/creating-a-landsat-stac.ipynb

@@ -988,7 +988,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This would be a good time to check our work - we can print out the GeoJSON and use [geojson.io](http://geojson.io/) to check and make sure we're using scenes that overlap our location. If this footprint is somewhere unexpected in the world, make sure the Lat/Long coordinates are correct and in the right order!"
+    "This would be a good time to check our work - we can print out the GeoJSON and use [geojson.io](https://geojson.io/) to check and make sure we're using scenes that overlap our location. If this footprint is somewhere unexpected in the world, make sure the Lat/Long coordinates are correct and in the right order!"
    ]
   },
   {