Skip to content

Commit

Permalink
Merge pull request #442 from duckontheweb/fix/326-327-update-proposal…
Browse files Browse the repository at this point in the history
…-extensions

Update docs and tests for Version, Label, and File Info extensions
  • Loading branch information
Jon Duckworth authored Jun 15, 2021
2 parents f90d52b + b2fdf5e commit 4a6a564
Show file tree
Hide file tree
Showing 11 changed files with 711 additions and 559 deletions.
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[report]
fail_under = 89
fail_under = 90

[run]
source = pystac
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
- Package author to `stac-utils`, email to `[email protected]`, url to this repo ([#409](https://github.com/stac-utils/pystac/pull/409))
- `StacIO.read_json` passes arbitrary positional and keyword arguments to
`StacIO.read_text` ([#433](https://github.com/stac-utils/pystac/pull/433))
- `FileExtension` updated to work with File Info Extension v2.0.0 ([#442](https://github.com/stac-utils/pystac/pull/442))
- `FileExtension` only operates on `pystac.Asset` instances ([#442](https://github.com/stac-utils/pystac/pull/442))

### Fixed

Expand Down
96 changes: 51 additions & 45 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,20 +283,37 @@ SummariesEOExtension
:undoc-members:
:show-inheritance:

Label Extension
---------------
File Info Extension
-------------------

These classes are representations of the :stac-ext:`Label Extension Spec <label>`.
These classes are representations of the :stac-ext:`File Info Extension Spec <file>`.

LabelItemExt
~~~~~~~~~~~~
ByteOrder
~~~~~~~~~

**TEMPORARILY REMOVED**
.. autoclass:: pystac.extensions.file.ByteOrder
:members:
:show-inheritance:
:undoc-members:

.. .. autoclass:: pystac.extensions.label.LabelItemExt
.. :members:
.. :undoc-members:
.. :show-inheritance:
MappingObject
~~~~~~~~~~~~~

.. autoclass:: pystac.extensions.file.MappingObject
:members:

FileExtension
~~~~~~~~~~~~~

.. autoclass:: pystac.extensions.file.FileExtension
:members:
:show-inheritance:
:undoc-members:

Label Extension
---------------

These classes are representations of the :stac-ext:`Label Extension Spec <label>`.

LabelRelType
~~~~~~~~~~~~
Expand Down Expand Up @@ -340,6 +357,14 @@ LabelStatistics
:members:
:undoc-members:

LabelExtension
~~~~~~~~~~~~~~

.. autoclass:: pystac.extensions.label.LabelExtension
:members:
:undoc-members:
:show-inheritance:

Pointcloud Extension
--------------------

Expand Down Expand Up @@ -461,30 +486,10 @@ SatItemExt
.. :undoc-members:
.. :show-inheritance:
Single File STAC Extension
--------------------------

These classes are representations of the :stac-ext:`Single File STAC Extension
<single-file-stac>`.

**TEMPORARILY REMOVED**

.. .. automodule:: pystac.extensions.single_file_stac
.. :members: create_single_file_stac
SingleFileSTACCatalogExt
~~~~~~~~~~~~~~~~~~~~~~~~

**TEMPORARILY REMOVED**

.. .. autoclass:: pystac.extensions.single_file_stac.SingleFileSTACCatalogExt
.. :members:
.. :undoc-members:
Version Extension
-----------------

Implements the :stac-ext:`Version Extension <version>`.
Implements the :stac-ext:`Versioning Indicators Extension <version>`.

VersionRelType
~~~~~~~~~~~~~~
Expand All @@ -493,25 +498,26 @@ VersionRelType
:members:
:show-inheritance:

VersionCollectionExt
~~~~~~~~~~~~~~~~~~~~
VersionExtension
~~~~~~~~~~~~~~~~

**TEMPORARILY REMOVED**
.. autoclass:: pystac.extensions.version.VersionExtension
:members:
:show-inheritance:

.. .. autoclass:: pystac.extensions.version.VersionCollectionExt
.. :members:
.. :undoc-members:
.. :show-inheritance:
CollectionVersionExtension
~~~~~~~~~~~~~~~~~~~~~~~~~~

VersionItemExt
~~~~~~~~~~~~~~
.. autoclass:: pystac.extensions.version.CollectionVersionExtension
:members:
:show-inheritance:

**TEMPORARILY REMOVED**
ItemVersionExtension
~~~~~~~~~~~~~~~~~~~~

.. .. autoclass:: pystac.extensions.version.VersionItemExt
.. :members:
.. :undoc-members:
.. :show-inheritance:
.. autoclass:: pystac.extensions.version.ItemVersionExtension
:members:
:show-inheritance:

View Geometry Extension
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion pystac/extensions/eo.py
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ class EOExtension(
.. code-block:: python
>>> item: pystac.Item = ...
>>> view_ext = ViewExtension.ext(item)
>>> eo_ext = EOExtension.ext(item)
"""

def apply(
Expand Down
Loading

0 comments on commit 4a6a564

Please sign in to comment.