Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and tests for Version, Label, and File Info extensions #442

Merged
merged 12 commits into from
Jun 15, 2021
Merged

Update docs and tests for Version, Label, and File Info extensions #442

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
72cb40c
Update docstrings for version extension
duckontheweb Jun 15, 2021
e812001
Fix variable name in EO example
duckontheweb Jun 15, 2021
be5c264
Update docstrings for File Extension
duckontheweb Jun 15, 2021
a9e884d
Update docstrings for Label Extension
duckontheweb Jun 15, 2021
b405ba2
Update File Info Extension to v2.0.0
duckontheweb Jun 15, 2021
9c2ad6d
Update file ext tests, only extend Assets
duckontheweb Jun 15, 2021
313c1fd
Use get_required and property constants in Label Ext
duckontheweb Jun 15, 2021
1ba9831
Improve test coverage for Label Extension
duckontheweb Jun 15, 2021
35d6757
Bump minimum coverage to 90%
duckontheweb Jun 15, 2021
60ec62b
Add Label, File Info extension docs, remove Single File
duckontheweb Jun 15, 2021
8486774
Make FileExtension a concrete class
duckontheweb Jun 15, 2021
b2fdf5e
Update CHANGELOG
duckontheweb Jun 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .coveragerc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[report]
fail_under = 89
fail_under = 90

[run]
source = pystac
96 changes: 51 additions & 45 deletions docs/api.rst
View file
Open in desktop
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
View file
Open in desktop
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