pystac-ext-osc 1.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pystac/extensions/__about__.py +17 -0
- pystac/extensions/ogc_record.py +566 -0
- pystac/extensions/osc.py +264 -0
- pystac/extensions/py.typed +1 -0
- pystac_ext_osc-1.0.0.dist-info/METADATA +101 -0
- pystac_ext_osc-1.0.0.dist-info/RECORD +8 -0
- pystac_ext_osc-1.0.0.dist-info/WHEEL +4 -0
- pystac_ext_osc-1.0.0.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Copyright 2026 Terradue
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Package metadata for Open Science Catalogue pystac extension."""
|
|
16
|
+
|
|
17
|
+
__version__ = "1.0.0"
|
|
@@ -0,0 +1,566 @@
|
|
|
1
|
+
# Copyright 2026 Terradue
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""OGC API Records adapter for PySTAC 1.x.x; see README for boundaries."""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
from copy import deepcopy
|
|
20
|
+
from typing import TYPE_CHECKING, Any, Generic, Literal, TypeAlias, TypedDict, TypeVar
|
|
21
|
+
|
|
22
|
+
from pystac.utils import datetime_to_str, str_to_datetime
|
|
23
|
+
|
|
24
|
+
import pystac
|
|
25
|
+
|
|
26
|
+
T = TypeVar("T")
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
if TYPE_CHECKING:
|
|
30
|
+
from datetime import datetime as Datetime
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class _RequiredLanguage(TypedDict):
|
|
34
|
+
code: str
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class Language(_RequiredLanguage, total=False):
|
|
38
|
+
"""Language metadata as defined by the OGC Records language.yaml schema.
|
|
39
|
+
|
|
40
|
+
``code`` is a required RFC 5646 language tag. Optional ``name`` is the
|
|
41
|
+
untranslated language name and must be nonempty when supplied;
|
|
42
|
+
``alternate`` names the language in another language, usually English.
|
|
43
|
+
``dir`` defaults to ``ltr`` in the schema when omitted.
|
|
44
|
+
|
|
45
|
+
This structure provides static typing, not runtime schema validation.
|
|
46
|
+
"""
|
|
47
|
+
|
|
48
|
+
name: str
|
|
49
|
+
alternate: str
|
|
50
|
+
dir: Literal["ltr", "rtl", "ttb", "btt"]
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
class _RequiredThemeConcept(TypedDict):
|
|
54
|
+
id: str
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
class ThemeConcept(_RequiredThemeConcept, total=False):
|
|
58
|
+
"""A theme concept with a required identifier and optional descriptions.
|
|
59
|
+
|
|
60
|
+
``url``, when supplied, must be a URI.
|
|
61
|
+
"""
|
|
62
|
+
|
|
63
|
+
title: str
|
|
64
|
+
description: str
|
|
65
|
+
url: str
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class Theme(TypedDict):
|
|
69
|
+
"""Theme metadata as defined by the OGC Records theme.yaml schema.
|
|
70
|
+
|
|
71
|
+
Both fields are required. ``concepts`` must contain at least one concept;
|
|
72
|
+
``scheme`` identifies the knowledge organization system, preferably by a
|
|
73
|
+
resolvable URI. This structure provides static typing, not runtime schema
|
|
74
|
+
validation.
|
|
75
|
+
"""
|
|
76
|
+
|
|
77
|
+
concepts: list[ThemeConcept]
|
|
78
|
+
scheme: str
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
class _RequiredFormatName(TypedDict):
|
|
82
|
+
name: str
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
class NamedFormat(_RequiredFormatName, total=False):
|
|
86
|
+
"""A format identified by name, optionally including its media type."""
|
|
87
|
+
|
|
88
|
+
mediaType: str
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
class _RequiredFormatMediaType(TypedDict):
|
|
92
|
+
mediaType: str
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
class MediaTypeFormat(_RequiredFormatMediaType, total=False):
|
|
96
|
+
"""A format identified by media type, optionally including its name."""
|
|
97
|
+
|
|
98
|
+
name: str
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
# OGC format.yaml requires name or mediaType (or both). The union expresses
|
|
102
|
+
# this constraint for static typing without runtime schema validation.
|
|
103
|
+
Format: TypeAlias = NamedFormat | MediaTypeFormat
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
class _RequiredExternalId(TypedDict):
|
|
107
|
+
value: str
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
class ExternalId(_RequiredExternalId, total=False):
|
|
111
|
+
"""An external identifier with a required value and optional scheme.
|
|
112
|
+
|
|
113
|
+
``scheme`` references the authority or knowledge organization system
|
|
114
|
+
from which the identifier was obtained, preferably by a resolvable URI.
|
|
115
|
+
This structure provides static typing, not runtime schema validation.
|
|
116
|
+
"""
|
|
117
|
+
|
|
118
|
+
scheme: str
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
# roles.yaml requires at least one entry; length is not checked at runtime.
|
|
122
|
+
Roles: TypeAlias = list[str]
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
class ContactDetail(_RequiredExternalId, total=False):
|
|
126
|
+
"""A phone number or email address with optional roles.
|
|
127
|
+
|
|
128
|
+
Reuses the required string value structure. Phone values must match
|
|
129
|
+
``^\\+[1-9]{1}[0-9]{3,14}$``; email values must use email format.
|
|
130
|
+
"""
|
|
131
|
+
|
|
132
|
+
roles: Roles
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
class ContactAddress(TypedDict, total=False):
|
|
136
|
+
"""A contact's physical address; all fields are optional."""
|
|
137
|
+
|
|
138
|
+
deliveryPoint: list[str]
|
|
139
|
+
city: str
|
|
140
|
+
administrativeArea: str
|
|
141
|
+
postalCode: str
|
|
142
|
+
country: str
|
|
143
|
+
roles: Roles
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
class _RequiredContactLink(TypedDict):
|
|
147
|
+
href: str
|
|
148
|
+
type: str
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
class _ContactLinkFields(_RequiredContactLink, total=False):
|
|
152
|
+
"""Shared contact link fields from linkBase.yaml and link.yaml.
|
|
153
|
+
|
|
154
|
+
``href`` must be a URI; ``created`` and ``updated`` use date-time strings.
|
|
155
|
+
"""
|
|
156
|
+
|
|
157
|
+
hreflang: str
|
|
158
|
+
title: str
|
|
159
|
+
length: int
|
|
160
|
+
profile: list[str]
|
|
161
|
+
created: str
|
|
162
|
+
updated: str
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
class ContactLink(_ContactLinkFields, total=False):
|
|
166
|
+
"""An online contact link with required href and media type."""
|
|
167
|
+
|
|
168
|
+
rel: str
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
class ContactLogo(_ContactLinkFields):
|
|
172
|
+
"""A contact logo with required href, media type, and icon relation.
|
|
173
|
+
|
|
174
|
+
The media type should be an image media type.
|
|
175
|
+
"""
|
|
176
|
+
|
|
177
|
+
rel: Literal["icon"]
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
class _ContactFields(TypedDict, total=False):
|
|
181
|
+
identifier: str
|
|
182
|
+
position: str
|
|
183
|
+
logo: ContactLogo
|
|
184
|
+
phones: list[ContactDetail]
|
|
185
|
+
emails: list[ContactDetail]
|
|
186
|
+
addresses: list[ContactAddress]
|
|
187
|
+
links: list[ContactLink]
|
|
188
|
+
hoursOfService: str
|
|
189
|
+
contactInstructions: str
|
|
190
|
+
roles: Roles
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
class _RequiredContactName(_ContactFields):
|
|
194
|
+
name: str
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
class NamedContact(_RequiredContactName, total=False):
|
|
198
|
+
"""A contact identified by name, optionally including an organization."""
|
|
199
|
+
|
|
200
|
+
organization: str
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
class _RequiredContactOrganization(_ContactFields):
|
|
204
|
+
organization: str
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
class OrganizationContact(_RequiredContactOrganization, total=False):
|
|
208
|
+
"""A contact identified by organization, optionally including a name."""
|
|
209
|
+
|
|
210
|
+
name: str
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
# contact.yaml requires name or organization (or both). As with Format,
|
|
214
|
+
# the union provides static typing, not runtime schema validation.
|
|
215
|
+
Contact: TypeAlias = NamedContact | OrganizationContact
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
class MetadataField(Generic[T]):
|
|
219
|
+
"""A live, optional accessor into the record properties dictionary."""
|
|
220
|
+
|
|
221
|
+
def __init__(self, key: str) -> None:
|
|
222
|
+
self.key = key
|
|
223
|
+
|
|
224
|
+
def __get__(self, instance: Any, owner: Any = None) -> Any:
|
|
225
|
+
if instance is None:
|
|
226
|
+
return self
|
|
227
|
+
return instance.properties.get(self.key)
|
|
228
|
+
|
|
229
|
+
def __set__(self, instance: Any, value: T | None) -> None:
|
|
230
|
+
if value is None:
|
|
231
|
+
instance.properties.pop(self.key, None)
|
|
232
|
+
else:
|
|
233
|
+
instance.properties[self.key] = value
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
class RecordMetadataMixin:
|
|
237
|
+
"""Direct recordCommonProperties accessors; dates use their JSON string form.
|
|
238
|
+
|
|
239
|
+
Nested structures remain open dictionaries, allowing future extensions.
|
|
240
|
+
These accessors do not perform JSON Schema validation.
|
|
241
|
+
"""
|
|
242
|
+
|
|
243
|
+
created = MetadataField[str]("created")
|
|
244
|
+
updated = MetadataField[str]("updated")
|
|
245
|
+
type = MetadataField[str]("type")
|
|
246
|
+
title = MetadataField[str]("title")
|
|
247
|
+
description = MetadataField[str]("description")
|
|
248
|
+
keywords = MetadataField[list[str]]("keywords")
|
|
249
|
+
themes = MetadataField[list[Theme]]("themes")
|
|
250
|
+
language = MetadataField[Language]("language")
|
|
251
|
+
languages = MetadataField[list[Language]]("languages")
|
|
252
|
+
resource_languages = MetadataField[list[Language]]("resourceLanguages")
|
|
253
|
+
external_ids = MetadataField[list[ExternalId]]("externalIds")
|
|
254
|
+
formats = MetadataField[list[Format]]("formats")
|
|
255
|
+
contacts = MetadataField[list[Contact]]("contacts")
|
|
256
|
+
license = MetadataField[str]("license")
|
|
257
|
+
rights = MetadataField[str]("rights")
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
class RecordCommonProperties(RecordMetadataMixin):
|
|
261
|
+
"""Backward-compatible metadata view sharing the record properties."""
|
|
262
|
+
|
|
263
|
+
def __init__(self, record: OGCRecord) -> None:
|
|
264
|
+
self.record = record
|
|
265
|
+
|
|
266
|
+
@property
|
|
267
|
+
def properties(self) -> dict[str, Any]:
|
|
268
|
+
return self.record.properties
|
|
269
|
+
|
|
270
|
+
def to_dict(self) -> dict[str, Any]:
|
|
271
|
+
return deepcopy(self.properties)
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
class OGCRecord(RecordMetadataMixin, pystac.Item):
|
|
275
|
+
"""Item-compatible Record, with OGC serialization as the default.
|
|
276
|
+
|
|
277
|
+
Initializes STACObject directly to avoid Item's mandatory temporal extent.
|
|
278
|
+
This compatibility seam must be reviewed for future PySTAC releases.
|
|
279
|
+
`time` and STAC datetime fields are independent: no implicit conversion.
|
|
280
|
+
"""
|
|
281
|
+
|
|
282
|
+
SCHEMA_URI = (
|
|
283
|
+
"https://schemas.opengis.net/ogcapi/records/part1/1.0/openapi/schemas/recordGeoJSON.yaml"
|
|
284
|
+
)
|
|
285
|
+
_RESERVED = frozenset(
|
|
286
|
+
{
|
|
287
|
+
"id",
|
|
288
|
+
"type",
|
|
289
|
+
"geometry",
|
|
290
|
+
"properties",
|
|
291
|
+
"links",
|
|
292
|
+
"assets",
|
|
293
|
+
"bbox",
|
|
294
|
+
"collection",
|
|
295
|
+
"stac_extensions",
|
|
296
|
+
}
|
|
297
|
+
)
|
|
298
|
+
|
|
299
|
+
# Preserve the positional PySTAC Item constructor API and OGC keyword options.
|
|
300
|
+
def __init__( # noqa: PLR0917
|
|
301
|
+
self,
|
|
302
|
+
id: str | int,
|
|
303
|
+
geometry: dict[str, Any] | None = None,
|
|
304
|
+
bbox: list[float] | None = None,
|
|
305
|
+
datetime: Datetime | None = None,
|
|
306
|
+
properties: dict[str, Any] | None = None,
|
|
307
|
+
start_datetime: Datetime | None = None,
|
|
308
|
+
end_datetime: Datetime | None = None,
|
|
309
|
+
stac_extensions: list[str] | None = None,
|
|
310
|
+
href: str | None = None,
|
|
311
|
+
collection: str | pystac.Collection | None = None,
|
|
312
|
+
extra_fields: dict[str, Any] | None = None,
|
|
313
|
+
assets: dict[str, pystac.Asset] | None = None,
|
|
314
|
+
*,
|
|
315
|
+
time: dict[str, Any] | None = None,
|
|
316
|
+
conforms_to: list[str] | None = None,
|
|
317
|
+
link_templates: list[dict[str, Any]] | None = None,
|
|
318
|
+
) -> None:
|
|
319
|
+
"""Initialize a record, copying metadata and assigning asset ownership.
|
|
320
|
+
|
|
321
|
+
OGC ``time`` is independent of the STAC datetime arguments. Optional
|
|
322
|
+
OGC fields override matching entries in ``extra_fields`` when supplied.
|
|
323
|
+
|
|
324
|
+
Raises:
|
|
325
|
+
TypeError: If the identifier is not a string or integer.
|
|
326
|
+
ValueError: If extra fields override managed record fields.
|
|
327
|
+
"""
|
|
328
|
+
if isinstance(id, bool) or not isinstance(id, (str, int)):
|
|
329
|
+
raise TypeError("Record id must be a string or integer")
|
|
330
|
+
pystac.STACObject.__init__(self, list(stac_extensions or []))
|
|
331
|
+
self._record_id = id
|
|
332
|
+
self.id = str(id) # PySTAC path/layout utilities require a string.
|
|
333
|
+
self.geometry = deepcopy(geometry)
|
|
334
|
+
self.bbox = deepcopy(bbox)
|
|
335
|
+
self._null_properties = properties is None
|
|
336
|
+
self.properties = deepcopy(properties) if properties is not None else {}
|
|
337
|
+
self.extra_fields = deepcopy(extra_fields) if extra_fields else {}
|
|
338
|
+
if self._RESERVED.intersection(self.extra_fields):
|
|
339
|
+
raise ValueError("extra_fields must not override managed fields")
|
|
340
|
+
self.assets = {}
|
|
341
|
+
self.collection_id = None
|
|
342
|
+
self._stac_io = None
|
|
343
|
+
self._set_temporal_properties(datetime, start_datetime, end_datetime)
|
|
344
|
+
for field_name, field_value in (
|
|
345
|
+
("time", time),
|
|
346
|
+
("conformsTo", conforms_to),
|
|
347
|
+
("linkTemplates", link_templates),
|
|
348
|
+
):
|
|
349
|
+
if field_value is not None:
|
|
350
|
+
self.extra_fields[field_name] = deepcopy(field_value)
|
|
351
|
+
self._attach_stac_objects(collection, assets, href)
|
|
352
|
+
|
|
353
|
+
def _attach_stac_objects(
|
|
354
|
+
self,
|
|
355
|
+
collection: str | pystac.Collection | None,
|
|
356
|
+
assets: dict[str, pystac.Asset] | None,
|
|
357
|
+
href: str | None,
|
|
358
|
+
) -> None:
|
|
359
|
+
"""Set collection links, asset ownership, and the record's location."""
|
|
360
|
+
if isinstance(collection, pystac.Collection):
|
|
361
|
+
self.set_collection(collection)
|
|
362
|
+
elif collection is not None:
|
|
363
|
+
self.collection_id = collection
|
|
364
|
+
for key, asset in (assets or {}).items():
|
|
365
|
+
self.add_asset(key, asset)
|
|
366
|
+
if href is not None:
|
|
367
|
+
self.set_self_href(href)
|
|
368
|
+
|
|
369
|
+
def _set_temporal_properties(
|
|
370
|
+
self,
|
|
371
|
+
instant: Datetime | None,
|
|
372
|
+
start: Datetime | None,
|
|
373
|
+
end: Datetime | None,
|
|
374
|
+
) -> None:
|
|
375
|
+
"""Apply explicit STAC dates, retaining dates already in properties."""
|
|
376
|
+
self.datetime = instant
|
|
377
|
+
if instant is not None:
|
|
378
|
+
self.properties["datetime"] = datetime_to_str(instant)
|
|
379
|
+
elif self.properties.get("datetime") is not None:
|
|
380
|
+
self.datetime = str_to_datetime(self.properties["datetime"])
|
|
381
|
+
for field_name, value in (("start_datetime", start), ("end_datetime", end)):
|
|
382
|
+
if value is not None:
|
|
383
|
+
self.properties[field_name] = datetime_to_str(value)
|
|
384
|
+
|
|
385
|
+
@property
|
|
386
|
+
def record_id(self) -> str | int:
|
|
387
|
+
return self._record_id if str(self._record_id) == self.id else self.id
|
|
388
|
+
|
|
389
|
+
@property
|
|
390
|
+
def record_metadata(self) -> RecordCommonProperties:
|
|
391
|
+
return RecordCommonProperties(self)
|
|
392
|
+
|
|
393
|
+
@property
|
|
394
|
+
def time(self) -> dict[str, Any] | None:
|
|
395
|
+
return self.extra_fields.get("time")
|
|
396
|
+
|
|
397
|
+
@time.setter
|
|
398
|
+
def time(self, value: dict[str, Any] | None) -> None:
|
|
399
|
+
self.extra_fields["time"] = value
|
|
400
|
+
|
|
401
|
+
@property
|
|
402
|
+
def conforms_to(self) -> list[str]:
|
|
403
|
+
"""The live list of conformance URIs.
|
|
404
|
+
|
|
405
|
+
Raises:
|
|
406
|
+
TypeError: If the stored value is not a list of strings.
|
|
407
|
+
"""
|
|
408
|
+
conformance = self.extra_fields.setdefault("conformsTo", [])
|
|
409
|
+
if not isinstance(conformance, list) or not all(
|
|
410
|
+
isinstance(uri, str) for uri in conformance
|
|
411
|
+
):
|
|
412
|
+
raise TypeError("conformsTo must be a list of strings")
|
|
413
|
+
return conformance
|
|
414
|
+
|
|
415
|
+
@conforms_to.setter
|
|
416
|
+
def conforms_to(self, value: list[str]) -> None:
|
|
417
|
+
self.extra_fields["conformsTo"] = value
|
|
418
|
+
|
|
419
|
+
@property
|
|
420
|
+
def link_templates(self) -> list[dict[str, Any]]:
|
|
421
|
+
"""The live list of link template dictionaries.
|
|
422
|
+
|
|
423
|
+
Raises:
|
|
424
|
+
TypeError: If the stored value is not a list of dictionaries.
|
|
425
|
+
"""
|
|
426
|
+
templates = self.extra_fields.setdefault("linkTemplates", [])
|
|
427
|
+
if not isinstance(templates, list) or not all(
|
|
428
|
+
isinstance(template, dict) for template in templates
|
|
429
|
+
):
|
|
430
|
+
raise TypeError("linkTemplates must be a list of dictionaries")
|
|
431
|
+
return templates
|
|
432
|
+
|
|
433
|
+
@link_templates.setter
|
|
434
|
+
def link_templates(self, value: list[dict[str, Any]]) -> None:
|
|
435
|
+
self.extra_fields["linkTemplates"] = value
|
|
436
|
+
|
|
437
|
+
def to_dict(
|
|
438
|
+
self, include_self_link: bool = True, transform_hrefs: bool = True
|
|
439
|
+
) -> dict[str, Any]:
|
|
440
|
+
props = deepcopy(self.properties)
|
|
441
|
+
if self.datetime is not None:
|
|
442
|
+
props["datetime"] = datetime_to_str(self.datetime)
|
|
443
|
+
doc = deepcopy(self.extra_fields)
|
|
444
|
+
doc.update(
|
|
445
|
+
type="Feature",
|
|
446
|
+
id=self.record_id,
|
|
447
|
+
geometry=deepcopy(self.geometry),
|
|
448
|
+
properties=None if self._null_properties and not props else props,
|
|
449
|
+
links=[
|
|
450
|
+
link.to_dict(transform_href=transform_hrefs)
|
|
451
|
+
for link in self.links
|
|
452
|
+
if include_self_link or link.rel != pystac.RelType.SELF
|
|
453
|
+
],
|
|
454
|
+
)
|
|
455
|
+
if self.bbox is not None:
|
|
456
|
+
doc["bbox"] = list(self.bbox)
|
|
457
|
+
# Preserve extension declarations/assets as GeoJSON foreign members.
|
|
458
|
+
# Never substitute conformsTo for stac_extensions.
|
|
459
|
+
if self.stac_extensions:
|
|
460
|
+
doc["stac_extensions"] = list(self.stac_extensions)
|
|
461
|
+
if self.assets:
|
|
462
|
+
doc["assets"] = {key: deepcopy(asset.to_dict()) for key, asset in self.assets.items()}
|
|
463
|
+
if self.collection_id is not None:
|
|
464
|
+
doc["collection"] = self.collection_id
|
|
465
|
+
return doc
|
|
466
|
+
|
|
467
|
+
def to_record_dict(
|
|
468
|
+
self, include_self_link: bool = True, transform_hrefs: bool = True
|
|
469
|
+
) -> dict[str, Any]:
|
|
470
|
+
return self.to_dict(include_self_link, transform_hrefs)
|
|
471
|
+
|
|
472
|
+
@classmethod
|
|
473
|
+
def matches_object_type(cls, d: dict[str, Any]) -> bool:
|
|
474
|
+
# Structural recognition only; GeoJSON/STAC overlap prevents unique dispatch.
|
|
475
|
+
return (
|
|
476
|
+
d.get("type") == "Feature"
|
|
477
|
+
and all(key in d for key in ("id", "geometry", "properties"))
|
|
478
|
+
and isinstance(d["id"], (str, int))
|
|
479
|
+
and not isinstance(d["id"], bool)
|
|
480
|
+
and (d["properties"] is None or isinstance(d["properties"], dict))
|
|
481
|
+
)
|
|
482
|
+
|
|
483
|
+
@classmethod
|
|
484
|
+
def from_dict(
|
|
485
|
+
cls,
|
|
486
|
+
d: dict[str, Any],
|
|
487
|
+
href: str | None = None,
|
|
488
|
+
root: pystac.Catalog | None = None,
|
|
489
|
+
migrate: bool = True,
|
|
490
|
+
preserve_dict: bool = True,
|
|
491
|
+
) -> OGCRecord:
|
|
492
|
+
"""Read Records; migrate is accepted for compatibility but never applied.
|
|
493
|
+
|
|
494
|
+
Always copies document metadata, even when preserve_dict=False.
|
|
495
|
+
"""
|
|
496
|
+
if not cls.matches_object_type(d):
|
|
497
|
+
raise ValueError("Expected a Record GeoJSON Feature with id, geometry, properties")
|
|
498
|
+
obj = cls(
|
|
499
|
+
id=d["id"],
|
|
500
|
+
geometry=d["geometry"],
|
|
501
|
+
properties=d["properties"],
|
|
502
|
+
bbox=d.get("bbox"),
|
|
503
|
+
collection=d.get("collection"),
|
|
504
|
+
stac_extensions=d.get("stac_extensions"),
|
|
505
|
+
extra_fields={k: v for k, v in d.items() if k not in cls._RESERVED},
|
|
506
|
+
assets={k: pystac.Asset.from_dict(deepcopy(v)) for k, v in d.get("assets", {}).items()},
|
|
507
|
+
)
|
|
508
|
+
for link in d.get("links", []):
|
|
509
|
+
if href is None or link.get("rel") != "self":
|
|
510
|
+
obj.add_link(pystac.Link.from_dict(deepcopy(link)))
|
|
511
|
+
if href is not None:
|
|
512
|
+
obj.set_self_href(href)
|
|
513
|
+
if root is not None:
|
|
514
|
+
obj.set_root(root)
|
|
515
|
+
return obj
|
|
516
|
+
|
|
517
|
+
def clone(self) -> OGCRecord:
|
|
518
|
+
doc = self.to_dict(transform_hrefs=False)
|
|
519
|
+
doc["links"] = []
|
|
520
|
+
result = type(self).from_dict(doc)
|
|
521
|
+
for link in self.links:
|
|
522
|
+
result.add_link(link.clone())
|
|
523
|
+
result._stac_io = self._stac_io
|
|
524
|
+
return result
|
|
525
|
+
|
|
526
|
+
def to_stac_item(self) -> pystac.Item:
|
|
527
|
+
"""Explicit export; requires a genuine STAC temporal extent.
|
|
528
|
+
|
|
529
|
+
Constructing an Item does not replace full STAC schema validation.
|
|
530
|
+
"""
|
|
531
|
+
if self.datetime is None and not all(
|
|
532
|
+
self.properties.get(k) is not None for k in ("start_datetime", "end_datetime")
|
|
533
|
+
):
|
|
534
|
+
raise ValueError("STAC export requires datetime or start_datetime/end_datetime")
|
|
535
|
+
extra = deepcopy(self.extra_fields)
|
|
536
|
+
extra.pop("stac_version", None)
|
|
537
|
+
item = pystac.Item(
|
|
538
|
+
id=self.id,
|
|
539
|
+
geometry=deepcopy(self.geometry),
|
|
540
|
+
bbox=deepcopy(self.bbox),
|
|
541
|
+
datetime=self.datetime,
|
|
542
|
+
properties=deepcopy(self.properties),
|
|
543
|
+
stac_extensions=list(self.stac_extensions),
|
|
544
|
+
collection=self.collection_id,
|
|
545
|
+
extra_fields=extra,
|
|
546
|
+
assets={k: v.clone() for k, v in self.assets.items()},
|
|
547
|
+
)
|
|
548
|
+
for link in self.links:
|
|
549
|
+
item.add_link(link.clone())
|
|
550
|
+
return item
|
|
551
|
+
|
|
552
|
+
def validate(self, validator: Any = None) -> list[Any]:
|
|
553
|
+
"""Validate the OGC document with an explicitly supplied validator.
|
|
554
|
+
|
|
555
|
+
Supply an object exposing validate(document), configured for the OGC
|
|
556
|
+
OpenAPI 3.0 schema and its references. No implicit STAC validation.
|
|
557
|
+
"""
|
|
558
|
+
if validator is None:
|
|
559
|
+
raise ValueError(
|
|
560
|
+
"Supply an OGC schema validator; for STAC use record.to_stac_item().validate()"
|
|
561
|
+
)
|
|
562
|
+
validator.validate(self.to_dict(transform_hrefs=False))
|
|
563
|
+
return [self.SCHEMA_URI]
|
|
564
|
+
|
|
565
|
+
def __repr__(self) -> str:
|
|
566
|
+
return f"<OGCRecord id={self.record_id!r}>"
|
pystac/extensions/osc.py
ADDED
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
# Copyright 2026 Terradue
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Implements the :stac-ext:`Open Science Catalog Extension <osc>`."""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
from typing import Any, ClassVar, Generic, Literal, TypeVar, cast
|
|
20
|
+
|
|
21
|
+
from pystac.extensions.base import ExtensionManagementMixin, PropertiesExtension
|
|
22
|
+
from pystac.extensions.hooks import ExtensionHooks
|
|
23
|
+
from pystac.utils import StringEnum
|
|
24
|
+
|
|
25
|
+
import pystac
|
|
26
|
+
|
|
27
|
+
#: Generalized version of :class:`~pystac.Catalog`, :class:`~pystac.Collection`,
|
|
28
|
+
#: or :class:`~pystac.Item`
|
|
29
|
+
T = TypeVar("T", pystac.Catalog, pystac.Collection, pystac.Item)
|
|
30
|
+
|
|
31
|
+
SCHEMA_URI: str = "https://stac-extensions.github.io/osc/v1.0.0/schema.json"
|
|
32
|
+
PREFIX: str = "osc:"
|
|
33
|
+
|
|
34
|
+
TYPE_PROP: str = PREFIX + "type"
|
|
35
|
+
STATUS_PROP: str = PREFIX + "status"
|
|
36
|
+
WORKFLOWS_PROP: str = PREFIX + "workflows"
|
|
37
|
+
PROJECT_PROP: str = PREFIX + "project"
|
|
38
|
+
REGION_PROP: str = PREFIX + "region"
|
|
39
|
+
VARIABLES_PROP: str = PREFIX + "variables"
|
|
40
|
+
MISSIONS_PROP: str = PREFIX + "missions"
|
|
41
|
+
EXPERIMENT_PROP: str = PREFIX + "experiment"
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
class OscType(StringEnum):
|
|
45
|
+
"""The supported Open Science Catalog resource types."""
|
|
46
|
+
|
|
47
|
+
PROJECT = "project"
|
|
48
|
+
PRODUCT = "product"
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
class OscStatus(StringEnum):
|
|
52
|
+
"""The supported lifecycle states for OSC projects and products."""
|
|
53
|
+
|
|
54
|
+
PLANNED = "planned"
|
|
55
|
+
ONGOING = "ongoing"
|
|
56
|
+
COMPLETED = "completed"
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
class OscExtension(
|
|
60
|
+
Generic[T],
|
|
61
|
+
PropertiesExtension,
|
|
62
|
+
ExtensionManagementMixin[pystac.Catalog | pystac.Collection | pystac.Item],
|
|
63
|
+
):
|
|
64
|
+
"""The Open Science Catalog Extension for Catalogs, Collections, and Items."""
|
|
65
|
+
|
|
66
|
+
name: Literal["osc"] = "osc"
|
|
67
|
+
|
|
68
|
+
def apply_project(
|
|
69
|
+
self,
|
|
70
|
+
*,
|
|
71
|
+
status: OscStatus,
|
|
72
|
+
workflows: list[str] | None = None,
|
|
73
|
+
) -> None:
|
|
74
|
+
"""Apply the OSC project fields and remove product-only fields."""
|
|
75
|
+
self.osc_type = OscType.PROJECT
|
|
76
|
+
self.status = status
|
|
77
|
+
self.workflows = workflows
|
|
78
|
+
|
|
79
|
+
self.project = None
|
|
80
|
+
self.region = None
|
|
81
|
+
self.variables = None
|
|
82
|
+
self.missions = None
|
|
83
|
+
self.experiment = None
|
|
84
|
+
|
|
85
|
+
def apply_product(
|
|
86
|
+
self,
|
|
87
|
+
*,
|
|
88
|
+
status: OscStatus,
|
|
89
|
+
project: str,
|
|
90
|
+
region: str | None = None,
|
|
91
|
+
variables: list[str] | None = None,
|
|
92
|
+
missions: list[str] | None = None,
|
|
93
|
+
experiment: str | None = None,
|
|
94
|
+
) -> None:
|
|
95
|
+
"""Apply the OSC product fields and remove project-only fields."""
|
|
96
|
+
self.osc_type = OscType.PRODUCT
|
|
97
|
+
self.status = status
|
|
98
|
+
self.project = project
|
|
99
|
+
self.region = region
|
|
100
|
+
self.variables = variables
|
|
101
|
+
self.missions = missions
|
|
102
|
+
self.experiment = experiment
|
|
103
|
+
|
|
104
|
+
self.workflows = None
|
|
105
|
+
|
|
106
|
+
@property
|
|
107
|
+
def osc_type(self) -> OscType | None:
|
|
108
|
+
"""The OSC resource type."""
|
|
109
|
+
value = self._get_property(TYPE_PROP, str)
|
|
110
|
+
return OscType(value) if value is not None else None
|
|
111
|
+
|
|
112
|
+
@osc_type.setter
|
|
113
|
+
def osc_type(self, value: OscType | None) -> None:
|
|
114
|
+
self._set_property(TYPE_PROP, value.value if value is not None else None)
|
|
115
|
+
|
|
116
|
+
@property
|
|
117
|
+
def status(self) -> OscStatus | None:
|
|
118
|
+
"""The OSC lifecycle status."""
|
|
119
|
+
value = self._get_property(STATUS_PROP, str)
|
|
120
|
+
return OscStatus(value) if value is not None else None
|
|
121
|
+
|
|
122
|
+
@status.setter
|
|
123
|
+
def status(self, value: OscStatus | None) -> None:
|
|
124
|
+
self._set_property(STATUS_PROP, value.value if value is not None else None)
|
|
125
|
+
|
|
126
|
+
@property
|
|
127
|
+
def workflows(self) -> list[str] | None:
|
|
128
|
+
"""The workflows created by an OSC project."""
|
|
129
|
+
return self._get_property(WORKFLOWS_PROP, list[str])
|
|
130
|
+
|
|
131
|
+
@workflows.setter
|
|
132
|
+
def workflows(self, value: list[str] | None) -> None:
|
|
133
|
+
self._set_property(WORKFLOWS_PROP, value)
|
|
134
|
+
|
|
135
|
+
@property
|
|
136
|
+
def project(self) -> str | None:
|
|
137
|
+
"""The project associated with an OSC product."""
|
|
138
|
+
return self._get_property(PROJECT_PROP, str)
|
|
139
|
+
|
|
140
|
+
@project.setter
|
|
141
|
+
def project(self, value: str | None) -> None:
|
|
142
|
+
self._set_property(PROJECT_PROP, value)
|
|
143
|
+
|
|
144
|
+
@property
|
|
145
|
+
def region(self) -> str | None:
|
|
146
|
+
"""The geographic region associated with an OSC product."""
|
|
147
|
+
return self._get_property(REGION_PROP, str)
|
|
148
|
+
|
|
149
|
+
@region.setter
|
|
150
|
+
def region(self, value: str | None) -> None:
|
|
151
|
+
self._set_property(REGION_PROP, value)
|
|
152
|
+
|
|
153
|
+
@property
|
|
154
|
+
def variables(self) -> list[str] | None:
|
|
155
|
+
"""The variables observed by an OSC product."""
|
|
156
|
+
return self._get_property(VARIABLES_PROP, list[str])
|
|
157
|
+
|
|
158
|
+
@variables.setter
|
|
159
|
+
def variables(self, value: list[str] | None) -> None:
|
|
160
|
+
self._set_property(VARIABLES_PROP, value)
|
|
161
|
+
|
|
162
|
+
@property
|
|
163
|
+
def missions(self) -> list[str] | None:
|
|
164
|
+
"""The missions providing input to an OSC product."""
|
|
165
|
+
return self._get_property(MISSIONS_PROP, list[str])
|
|
166
|
+
|
|
167
|
+
@missions.setter
|
|
168
|
+
def missions(self, value: list[str] | None) -> None:
|
|
169
|
+
self._set_property(MISSIONS_PROP, value)
|
|
170
|
+
|
|
171
|
+
@property
|
|
172
|
+
def experiment(self) -> str | None:
|
|
173
|
+
"""The experiment that created an OSC product."""
|
|
174
|
+
return self._get_property(EXPERIMENT_PROP, str)
|
|
175
|
+
|
|
176
|
+
@experiment.setter
|
|
177
|
+
def experiment(self, value: str | None) -> None:
|
|
178
|
+
self._set_property(EXPERIMENT_PROP, value)
|
|
179
|
+
|
|
180
|
+
@classmethod
|
|
181
|
+
def get_schema_uri(cls) -> str:
|
|
182
|
+
"""Return the supported OSC extension schema identifier."""
|
|
183
|
+
return SCHEMA_URI
|
|
184
|
+
|
|
185
|
+
@classmethod
|
|
186
|
+
def ext(cls, obj: T, add_if_missing: bool = False) -> OscExtension[T]:
|
|
187
|
+
"""Wrap a Catalog, Collection, or Item with live OSC accessors.
|
|
188
|
+
|
|
189
|
+
Args:
|
|
190
|
+
obj: Object whose OSC fields will be read or modified.
|
|
191
|
+
add_if_missing: Add the schema declaration when absent.
|
|
192
|
+
|
|
193
|
+
Raises:
|
|
194
|
+
pystac.ExtensionNotImplemented: If the declaration is missing and
|
|
195
|
+
adding it was not requested.
|
|
196
|
+
pystac.ExtensionTypeError: If the object type is unsupported.
|
|
197
|
+
"""
|
|
198
|
+
if isinstance(obj, pystac.Collection):
|
|
199
|
+
cls.ensure_has_extension(obj, add_if_missing)
|
|
200
|
+
return cast("OscExtension[T]", CollectionOscExtension(obj))
|
|
201
|
+
if isinstance(obj, pystac.Catalog):
|
|
202
|
+
cls.ensure_has_extension(obj, add_if_missing)
|
|
203
|
+
return cast("OscExtension[T]", CatalogOscExtension(obj))
|
|
204
|
+
if isinstance(obj, pystac.Item):
|
|
205
|
+
cls.ensure_has_extension(obj, add_if_missing)
|
|
206
|
+
return cast("OscExtension[T]", ItemOscExtension(obj))
|
|
207
|
+
raise pystac.ExtensionTypeError(cls._ext_error_message(obj))
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
class CatalogOscExtension(OscExtension[pystac.Catalog]):
|
|
211
|
+
"""Expose OSC fields on a PySTAC catalog."""
|
|
212
|
+
|
|
213
|
+
catalog: pystac.Catalog
|
|
214
|
+
properties: dict[str, Any]
|
|
215
|
+
|
|
216
|
+
def __init__(self, catalog: pystac.Catalog) -> None:
|
|
217
|
+
self.catalog = catalog
|
|
218
|
+
self.properties = catalog.extra_fields
|
|
219
|
+
|
|
220
|
+
def __repr__(self) -> str:
|
|
221
|
+
return f"<CatalogOscExtension Catalog id={self.catalog.id}>"
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
class CollectionOscExtension(OscExtension[pystac.Collection]):
|
|
225
|
+
"""Expose OSC fields on a PySTAC collection."""
|
|
226
|
+
|
|
227
|
+
collection: pystac.Collection
|
|
228
|
+
properties: dict[str, Any]
|
|
229
|
+
|
|
230
|
+
def __init__(self, collection: pystac.Collection) -> None:
|
|
231
|
+
self.collection = collection
|
|
232
|
+
self.properties = collection.extra_fields
|
|
233
|
+
|
|
234
|
+
def __repr__(self) -> str:
|
|
235
|
+
return f"<CollectionOscExtension Collection id={self.collection.id}>"
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
class ItemOscExtension(OscExtension[pystac.Item]):
|
|
239
|
+
"""Expose OSC fields on a PySTAC item."""
|
|
240
|
+
|
|
241
|
+
item: pystac.Item
|
|
242
|
+
properties: dict[str, Any]
|
|
243
|
+
|
|
244
|
+
def __init__(self, item: pystac.Item) -> None:
|
|
245
|
+
self.item = item
|
|
246
|
+
self.properties = item.properties
|
|
247
|
+
|
|
248
|
+
def __repr__(self) -> str:
|
|
249
|
+
return f"<ItemOscExtension Item id={self.item.id}>"
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
class OscExtensionHooks(ExtensionHooks):
|
|
253
|
+
"""Describe OSC schema membership for PySTAC migration hooks."""
|
|
254
|
+
|
|
255
|
+
schema_uri: str = SCHEMA_URI
|
|
256
|
+
prev_extension_ids: ClassVar[set[str]] = set()
|
|
257
|
+
stac_object_types: ClassVar[set[pystac.STACObjectType]] = {
|
|
258
|
+
pystac.STACObjectType.CATALOG,
|
|
259
|
+
pystac.STACObjectType.COLLECTION,
|
|
260
|
+
pystac.STACObjectType.ITEM,
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
OSC_EXTENSION_HOOKS: ExtensionHooks = OscExtensionHooks()
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: pystac-ext-osc
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: STAC Open Science Catalog Extension Specification pystac implementation.
|
|
5
|
+
Project-URL: Documentation, https://terradue.github.io/pystac-ext-osc/
|
|
6
|
+
Project-URL: Issues, https://github.com/Terradue/pystac-ext-osc/issues
|
|
7
|
+
Project-URL: Source, https://github.com/Terradue/pystac-ext-osc
|
|
8
|
+
Project-URL: Changelog, https://github.com/Terradue/pystac-ext-osc/blob/main/CHANGELOG.md
|
|
9
|
+
Author-email: Terradue <info@terradue.com>, Simone Tripodi <simone.tripodi@terradue.com>, Fabrice Brito <fabrice.brito@terradue.com>
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Classifier: Development Status :: 4 - Beta
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
21
|
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
22
|
+
Requires-Python: >=3.10
|
|
23
|
+
Requires-Dist: pystac<2,>=1
|
|
24
|
+
Provides-Extra: test
|
|
25
|
+
Requires-Dist: pytest-cov<8,>=7.1.0; extra == 'test'
|
|
26
|
+
Requires-Dist: pytest<10,>=9.1.1; extra == 'test'
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
<!--
|
|
30
|
+
Copyright 2026 Terradue
|
|
31
|
+
|
|
32
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
33
|
+
you may not use this file except in compliance with the License.
|
|
34
|
+
You may obtain a copy of the License at
|
|
35
|
+
|
|
36
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
37
|
+
|
|
38
|
+
Unless required by applicable law or agreed to in writing, software
|
|
39
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
40
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
41
|
+
See the License for the specific language governing permissions and
|
|
42
|
+
limitations under the License.
|
|
43
|
+
-->
|
|
44
|
+
|
|
45
|
+
# Open Science Catalog PySTAC extension
|
|
46
|
+
|
|
47
|
+
[](https://pypi.org/project/pystac-ext-osc)
|
|
48
|
+
[](https://pypi.org/project/pystac-ext-osc)
|
|
49
|
+
[](https://github.com/terradue/pystac-ext-osc/actions/workflows/package.yaml?query=branch%3Adevelop)
|
|
50
|
+
[](https://app.codecov.io/gh/terradue/pystac-ext-osc/tree/develop)
|
|
51
|
+
|
|
52
|
+
PySTAC implementation of the [Open Science Catalog STAC Extension v1.0.0](https://github.com/stac-extensions/osc), with an [OGC API Records](https://ogcapi.ogc.org/records/) adapter.
|
|
53
|
+
|
|
54
|
+
Use `OscExtension.ext()` for project/product metadata on Catalogs, Collections, and Items. Use `OGCRecord` for workflow and experiment records. See the [OSC tutorial](docs/tutorials/first-steps.md) and [OGC Record guide](docs/how-to/ogc-records.md) for runnable examples and validation boundaries.
|
|
55
|
+
|
|
56
|
+
## Project conventions
|
|
57
|
+
|
|
58
|
+
This project is templated a Hatch-based Python package with:
|
|
59
|
+
|
|
60
|
+
- Apache-2.0 license
|
|
61
|
+
- Keep a Changelog-compatible `CHANGELOG.md`
|
|
62
|
+
- Diátaxis documentation under `docs/`
|
|
63
|
+
- top-level `mkdocs.yaml`
|
|
64
|
+
- Taskfile integration with `Terradue/taskfile-utils`
|
|
65
|
+
- GitHub Actions CI
|
|
66
|
+
|
|
67
|
+
## Documentation
|
|
68
|
+
|
|
69
|
+
Read the [project documentation](https://terradue.github.io/pystac-ext-osc/) for Python examples, the field reference, and API documentation.
|
|
70
|
+
|
|
71
|
+
To preview it locally:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
python -m pip install . "mkdocs<2" mkdocs-material "mkdocstrings[python]"
|
|
75
|
+
mkdocs serve
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Contribute
|
|
79
|
+
|
|
80
|
+
Submit a [Github issue](/issues) if you have comments or suggestions.
|
|
81
|
+
|
|
82
|
+
### Local quality checks
|
|
83
|
+
|
|
84
|
+
Install [Hatch](https://hatch.pypa.io/) and [Taskfiles](https://taskfile.dev/docs/guide) then install the Git hook:
|
|
85
|
+
|
|
86
|
+
```console
|
|
87
|
+
task quality:pre-commit:install
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Every commit runs Ruff (including the configured McCabe complexity limit),
|
|
91
|
+
Ruff formatting, strict mypy checks, and the pytest suite.
|
|
92
|
+
|
|
93
|
+
Run the complete hook explicitly with:
|
|
94
|
+
|
|
95
|
+
```console
|
|
96
|
+
task quality:pre-commit:run
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
pystac/extensions/__about__.py,sha256=5sXKmeIQeA5m0T6u3gu6sqeF2e2PEKfzY-hAMnTjN_A,664
|
|
2
|
+
pystac/extensions/ogc_record.py,sha256=AJgXsjTWd0A6tJjUY7uzoqhTePbCmC5-RVnehjC76Sw,19132
|
|
3
|
+
pystac/extensions/osc.py,sha256=HcKM79YfFE57Yr6N-DW1CSmGmYLWPHFiTqpZ0u1nhuo,8635
|
|
4
|
+
pystac/extensions/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
|
|
5
|
+
pystac_ext_osc-1.0.0.dist-info/METADATA,sha256=RdD4AJS6pY_-8J6Qz8tvT7ZnoieSq2cZ2eUyPgy0ZmA,4369
|
|
6
|
+
pystac_ext_osc-1.0.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
|
|
7
|
+
pystac_ext_osc-1.0.0.dist-info/licenses/LICENSE,sha256=ncoZH9Riydi4edtpNYeB7IymLIEpnL1SQB0fM4A8NHA,11343
|
|
8
|
+
pystac_ext_osc-1.0.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Terradue
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|