fix: deprecate the label extension (#1270)

Author: gadomski

.coveragerc

@@ -7,4 +7,7 @@ exclude_lines =
 [run]
 branch = true
 source =
-    pystac
+    pystac
+omit = 
+    pystac/extensions/label.py
+    

CHANGELOG.md

@@ -30,6 +30,7 @@
 
 - `ExtensionManagementMixin.validate_has_extension` is replaced with `ExtensionManagementMixin.ensure_has_extension`. Calling `ExtensionManagementMixin.validate_has_extension` will raise a `DeprecationWarning` and call `ExtensionManagementMixin.ensure_has_extension` ([#1248](https://github.com/stac-utils/pystac/pull/1248))
 - `validate_all` for dicts; use `validate_all_dict` instead ([#1246](https://github.com/stac-utils/pystac/pull/1246))
+- `Label` extension ([#1270](https://github.com/stac-utils/pystac/pull/1270))
 
 ## [v1.8.4] - 2023-09-22
 

docs/api.rst

@@ -95,7 +95,6 @@ PySTAC provides support for the following STAC Extensions:
 * :mod:`Electro-Optical <pystac.extensions.eo>`
 * :mod:`File Info <pystac.extensions.file>`
 * :mod:`Item Assets <pystac.extensions.item_assets>`
-* :mod:`Label <pystac.extensions.label>`
 * :mod:`MGRS <pystac.extensions.mgrs>`
 * :mod:`Point Cloud <pystac.extensions.pointcloud>`
 * :mod:`Projection <pystac.extensions.projection>`

docs/api/extensions.rst

@@ -19,7 +19,6 @@ pystac.extensions
     file.FileExtension
     grid.GridExtension
     item_assets.ItemAssetsExtension
-    label.LabelExtension
     mgrs.MgrsExtension
     pointcloud.PointcloudExtension
     projection.ProjectionExtension

docs/api/extensions/label.rst

@@ -681,44 +681,25 @@ Mapping over Items
 ------------------
 
 The :func:`Catalog.map_items <pystac.Catalog.map_items>` method is useful for
+into smaller chunks (e.g. tiling out large image items).
+item, you can return multiple items, in case you are generating new objects, or splitting items
 manipulating items in a STAC. This will create a full copy of the STAC, so will leave
 the original catalog unmodified. In the method that manipulates and returns the modified
-item, you can return multiple items, in case you are generating new objects (e.g.
-creating a :class:`~pystac.LabelItem` for image items in a stac), or splitting items
-into smaller chunks (e.g. tiling out large image items).
 
 .. code-block:: python
 
    def modify_item_title(item):
        item.title = 'Some new title'
        return item
 
-   def create_label_item(item):
-       # Assumes the GeoJSON labels are in the
-       # same location as the image
-       img_href = item.assets['ortho'].href
-       label_href = '{}.geojson'.format(os.path.splitext(img_href)[0])
-       label_item = LabelItem(id='Labels',
-                         geometry=item.geometry,
-                         bbox=item.bbox,
-                         datetime=datetime.utcnow(),
-                         properties={},
-                         label_description='labels',
-                         label_type='vector',
-                         label_properties='label',
-                         label_classes=[
-                         LabelClasses(classes=['one', 'two'],
-                                      name='label')
-                         ],
-                         label_tasks=['classification'])
-       label_item.add_source(item, assets=['ortho'])
-       label_item.add_geojson_labels(label_href)
-
-       return [item, label_item]
+   def duplicate_item(item):
+       duplicated_item = item.clone()
+       duplicated_item.id += "-duplicated"
+       return [item, duplicated_item]
 
 
    c = catalog.map_items(modify_item_title)
-   c = c.map_items(create_label_item)
+   c = c.map_items(duplicate_item)
    new_catalog = c
 
 .. _copy stacs:
@@ -731,11 +712,7 @@ and mutations of STAC data. The :func:`STACObject.full_copy
 <pystac.STACObject.full_copy>` mechanism handles this in a way that ties the elements of
 the copies STAC together correctly. This includes situations where there might be cycles
 in the graph of connected objects of the STAC (which otherwise would be `a tree
-<https://en.wikipedia.org/wiki/Tree_(graph_theory)>`_). For example, if a
-:class:`~pystac.LabelItem` lists a :attr:`~pystac.LabelItem.source` that is an item also
-contained in the root catalog; the full copy of the STAC will ensure that the
-:class:`~pystac.Item` instance representing the source imagery item is the same instance
-that is linked to by the :class:`~pystac.LabelItem`.
+<https://en.wikipedia.org/wiki/Tree_(graph_theory)>`_).
 
 Resolving STAC objects
 ======================

docs/concepts.rst

@@ -36,8 +36,8 @@ How to create STAC Catalogs with PySTAC
 This was a tutorial that was part of a 30 minute presentation at the `community STAC
 sprint
 <https://github.com/radiantearth/community-sprints/tree/master/11052019-arlignton-va>`_
-in Arlington, VA in November 2019. It runs through creating a STAC of image or label
-items from the `SpaceNet 5 <https://www.topcoder.com/challenges/30099956>`_ dataset.
+in Arlington, VA in November 2019. It runs through creating a STAC of images
+from the `SpaceNet 5 <https://www.topcoder.com/challenges/30099956>`_ dataset.
 
 Creating a Landsat 8 STAC
 -------------------------