Skip to content

Commit 4a6a564

Browse files
author
Jon Duckworth
authored
Merge pull request #442 from duckontheweb/fix/326-327-update-proposal-extensions
Update docs and tests for Version, Label, and File Info extensions
2 parents f90d52b + b2fdf5e commit 4a6a564

File tree

11 files changed

+711
-559
lines changed

11 files changed

+711
-559
lines changed

.coveragerc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[report]
2-
fail_under = 89
2+
fail_under = 90
33

44
[run]
55
source = pystac

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
- Package author to `stac-utils`, email to `stac@radiant.earth`, url to this repo ([#409](https://github.com/stac-utils/pystac/pull/409))
1818
- `StacIO.read_json` passes arbitrary positional and keyword arguments to
1919
`StacIO.read_text` ([#433](https://github.com/stac-utils/pystac/pull/433))
20+
- `FileExtension` updated to work with File Info Extension v2.0.0 ([#442](https://github.com/stac-utils/pystac/pull/442))
21+
- `FileExtension` only operates on `pystac.Asset` instances ([#442](https://github.com/stac-utils/pystac/pull/442))
2022

2123
### Fixed
2224

docs/api.rst

Lines changed: 51 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -283,20 +283,37 @@ SummariesEOExtension
283283
:undoc-members:
284284
:show-inheritance:
285285

286-
Label Extension
287-
---------------
286+
File Info Extension
287+
-------------------
288288

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

291-
LabelItemExt
292-
~~~~~~~~~~~~
291+
ByteOrder
292+
~~~~~~~~~
293293

294-
**TEMPORARILY REMOVED**
294+
.. autoclass:: pystac.extensions.file.ByteOrder
295+
:members:
296+
:show-inheritance:
297+
:undoc-members:
295298

296-
.. .. autoclass:: pystac.extensions.label.LabelItemExt
297-
.. :members:
298-
.. :undoc-members:
299-
.. :show-inheritance:
299+
MappingObject
300+
~~~~~~~~~~~~~
301+
302+
.. autoclass:: pystac.extensions.file.MappingObject
303+
:members:
304+
305+
FileExtension
306+
~~~~~~~~~~~~~
307+
308+
.. autoclass:: pystac.extensions.file.FileExtension
309+
:members:
310+
:show-inheritance:
311+
:undoc-members:
312+
313+
Label Extension
314+
---------------
315+
316+
These classes are representations of the :stac-ext:`Label Extension Spec <label>`.
300317

301318
LabelRelType
302319
~~~~~~~~~~~~
@@ -340,6 +357,14 @@ LabelStatistics
340357
:members:
341358
:undoc-members:
342359

360+
LabelExtension
361+
~~~~~~~~~~~~~~
362+
363+
.. autoclass:: pystac.extensions.label.LabelExtension
364+
:members:
365+
:undoc-members:
366+
:show-inheritance:
367+
343368
Pointcloud Extension
344369
--------------------
345370

@@ -461,30 +486,10 @@ SatItemExt
461486
.. :undoc-members:
462487
.. :show-inheritance:
463488
464-
Single File STAC Extension
465-
--------------------------
466-
467-
These classes are representations of the :stac-ext:`Single File STAC Extension
468-
<single-file-stac>`.
469-
470-
**TEMPORARILY REMOVED**
471-
472-
.. .. automodule:: pystac.extensions.single_file_stac
473-
.. :members: create_single_file_stac
474-
475-
SingleFileSTACCatalogExt
476-
~~~~~~~~~~~~~~~~~~~~~~~~
477-
478-
**TEMPORARILY REMOVED**
479-
480-
.. .. autoclass:: pystac.extensions.single_file_stac.SingleFileSTACCatalogExt
481-
.. :members:
482-
.. :undoc-members:
483-
484489
Version Extension
485490
-----------------
486491

487-
Implements the :stac-ext:`Version Extension <version>`.
492+
Implements the :stac-ext:`Versioning Indicators Extension <version>`.
488493

489494
VersionRelType
490495
~~~~~~~~~~~~~~
@@ -493,25 +498,26 @@ VersionRelType
493498
:members:
494499
:show-inheritance:
495500

496-
VersionCollectionExt
497-
~~~~~~~~~~~~~~~~~~~~
501+
VersionExtension
502+
~~~~~~~~~~~~~~~~
498503

499-
**TEMPORARILY REMOVED**
504+
.. autoclass:: pystac.extensions.version.VersionExtension
505+
:members:
506+
:show-inheritance:
500507

501-
.. .. autoclass:: pystac.extensions.version.VersionCollectionExt
502-
.. :members:
503-
.. :undoc-members:
504-
.. :show-inheritance:
508+
CollectionVersionExtension
509+
~~~~~~~~~~~~~~~~~~~~~~~~~~
505510

506-
VersionItemExt
507-
~~~~~~~~~~~~~~
511+
.. autoclass:: pystac.extensions.version.CollectionVersionExtension
512+
:members:
513+
:show-inheritance:
508514

509-
**TEMPORARILY REMOVED**
515+
ItemVersionExtension
516+
~~~~~~~~~~~~~~~~~~~~
510517

511-
.. .. autoclass:: pystac.extensions.version.VersionItemExt
512-
.. :members:
513-
.. :undoc-members:
514-
.. :show-inheritance:
518+
.. autoclass:: pystac.extensions.version.ItemVersionExtension
519+
:members:
520+
:show-inheritance:
515521

516522
View Geometry Extension
517523
-----------------------

pystac/extensions/eo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ class EOExtension(
289289
.. code-block:: python
290290
291291
>>> item: pystac.Item = ...
292-
>>> view_ext = ViewExtension.ext(item)
292+
>>> eo_ext = EOExtension.ext(item)
293293
"""
294294

295295
def apply(

0 commit comments

Comments
 (0)