pystac-ext-osc 1.0.0__tar.gz

pystac_ext_osc-1.0.0/.gitignore

@@ -0,0 +1,40 @@
+# Copyright {{ copyright_year }} Terradue
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.dist/
+build/
+dist/
+.coverage
+coverage.xml
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Environments
+.venv/
+
+# MkDocs
+site/
+
+# Editors
+.idea/
+.vscode/
+.DS_Store
+
+.task
+uv.lock

pystac_ext_osc-1.0.0/CHANGELOG.md

@@ -0,0 +1,51 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+- Replace stale InSAR documentation with OSC v1.0.0 examples and OGC Records guides and API reference.
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+- Use the explicit OSC extension accessor in tests and resolve Ruff import, cast, suppression, and class-state diagnostics.
+
+### Security
+
+### Added
+
+## [1.0.0] - 2026-10-06
+
+### Added
+
+- Initial project release.
+
+[Unreleased]: https://github.com/Terradue/pystac-ext-osc/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/Terradue/pystac-ext-osc/releases/tag/1.0.0

pystac_ext_osc-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+           of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Terradue
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pystac_ext_osc-1.0.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.5
+Name: pystac-ext-osc
+Version: 1.0.0
+Summary: STAC Open Science Catalog Extension Specification pystac implementation.
+Project-URL: Documentation, https://terradue.github.io/pystac-ext-osc/
+Project-URL: Issues, https://github.com/Terradue/pystac-ext-osc/issues
+Project-URL: Source, https://github.com/Terradue/pystac-ext-osc
+Project-URL: Changelog, https://github.com/Terradue/pystac-ext-osc/blob/main/CHANGELOG.md
+Author-email: Terradue <info@terradue.com>, Simone Tripodi <simone.tripodi@terradue.com>, Fabrice Brito <fabrice.brito@terradue.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: pystac<2,>=1
+Provides-Extra: test
+Requires-Dist: pytest-cov<8,>=7.1.0; extra == 'test'
+Requires-Dist: pytest<10,>=9.1.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Open Science Catalog PySTAC extension
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pystac-ext-osc.svg)](https://pypi.org/project/pystac-ext-osc)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pystac-ext-osc.svg)](https://pypi.org/project/pystac-ext-osc)
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/terradue/pystac-ext-osc/package.yaml?branch=develop&event=push&label=build&logo=githubactions)](https://github.com/terradue/pystac-ext-osc/actions/workflows/package.yaml?query=branch%3Adevelop)
+[![Code coverage](https://img.shields.io/codecov/c/github/terradue/pystac-ext-osc/develop?logo=codecov)](https://app.codecov.io/gh/terradue/pystac-ext-osc/tree/develop)
+
+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.
+
+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.
+
+## Project conventions
+
+This project is templated a Hatch-based Python package with:
+
+- Apache-2.0 license
+- Keep a Changelog-compatible `CHANGELOG.md`
+- Diátaxis documentation under `docs/`
+- top-level `mkdocs.yaml`
+- Taskfile integration with `Terradue/taskfile-utils`
+- GitHub Actions CI
+
+## Documentation
+
+Read the [project documentation](https://terradue.github.io/pystac-ext-osc/) for Python examples, the field reference, and API documentation.
+
+To preview it locally:
+
+```bash
+python -m pip install . "mkdocs<2" mkdocs-material "mkdocstrings[python]"
+mkdocs serve
+```
+
+## Contribute
+
+Submit a [Github issue](/issues) if you have comments or suggestions.
+
+### Local quality checks
+
+Install [Hatch](https://hatch.pypa.io/) and [Taskfiles](https://taskfile.dev/docs/guide) then install the Git hook:
+
+```console
+task quality:pre-commit:install
+```
+
+Every commit runs Ruff (including the configured McCabe complexity limit),
+Ruff formatting, strict mypy checks, and the pytest suite.
+
+Run the complete hook explicitly with:
+
+```console
+task quality:pre-commit:run
+```
+
+## License
+
+[![Apache License, Version 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)

pystac_ext_osc-1.0.0/README.md

@@ -0,0 +1,73 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Open Science Catalog PySTAC extension
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pystac-ext-osc.svg)](https://pypi.org/project/pystac-ext-osc)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pystac-ext-osc.svg)](https://pypi.org/project/pystac-ext-osc)
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/terradue/pystac-ext-osc/package.yaml?branch=develop&event=push&label=build&logo=githubactions)](https://github.com/terradue/pystac-ext-osc/actions/workflows/package.yaml?query=branch%3Adevelop)
+[![Code coverage](https://img.shields.io/codecov/c/github/terradue/pystac-ext-osc/develop?logo=codecov)](https://app.codecov.io/gh/terradue/pystac-ext-osc/tree/develop)
+
+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.
+
+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.
+
+## Project conventions
+
+This project is templated a Hatch-based Python package with:
+
+- Apache-2.0 license
+- Keep a Changelog-compatible `CHANGELOG.md`
+- Diátaxis documentation under `docs/`
+- top-level `mkdocs.yaml`
+- Taskfile integration with `Terradue/taskfile-utils`
+- GitHub Actions CI
+
+## Documentation
+
+Read the [project documentation](https://terradue.github.io/pystac-ext-osc/) for Python examples, the field reference, and API documentation.
+
+To preview it locally:
+
+```bash
+python -m pip install . "mkdocs<2" mkdocs-material "mkdocstrings[python]"
+mkdocs serve
+```
+
+## Contribute
+
+Submit a [Github issue](/issues) if you have comments or suggestions.
+
+### Local quality checks
+
+Install [Hatch](https://hatch.pypa.io/) and [Taskfiles](https://taskfile.dev/docs/guide) then install the Git hook:
+
+```console
+task quality:pre-commit:install
+```
+
+Every commit runs Ruff (including the configured McCabe complexity limit),
+Ruff formatting, strict mypy checks, and the pytest suite.
+
+Run the complete hook explicitly with:
+
+```console
+task quality:pre-commit:run
+```
+
+## License
+
+[![Apache License, Version 2.0](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://www.apache.org/licenses/LICENSE-2.0)

pystac_ext_osc-1.0.0/docs/explanation/architecture.md

@@ -0,0 +1,41 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Scope, architecture, and validation
+
+## Package structure
+
+The distribution is `pystac-ext-osc`. Import OSC wrappers from `pystac.extensions.osc` and the record adapter from `pystac.extensions.ogc_record`. The wheel excludes the shared namespace initializer owned by PySTAC.
+
+`OscExtension.ext()` chooses a Catalog, Collection, or Item wrapper. It writes directly into the object's existing metadata dictionary. It does not register an `.ext.osc` accessor. `OSC_EXTENSION_HOOKS` declares the v1.0.0 schema, no previous extension identifiers, and Catalog/Collection/Item types; registration with a migration system is left to callers.
+
+The published OSC v1.0.0 schema and upstream main schema were compared on 2026-10-06 and were identical. The implemented project/product field set matches them. Source: [OSC specification](https://github.com/stac-extensions/osc).
+
+## OGC Records and STAC
+
+`OGCRecord` subclasses `pystac.Item` to reuse links, assets, and compatible extension wrappers. It initializes `STACObject` directly to allow records without a STAC datetime. This dependency on PySTAC's object internals warrants testing when upgrading PySTAC.
+
+Default serialization produces a Record GeoJSON Feature. STAC declarations and assets are preserved as foreign members when supplied. Use `OGCRecord.from_dict()` explicitly: ordinary PySTAC dispatch does not distinguish arbitrary records from STAC Items. `to_stac_item()` is an explicit conversion requiring a STAC instant or both interval endpoints. OGC `time` is independent and is never converted automatically.
+
+## Validation boundaries
+
+Neither OSC apply methods nor serialization runs JSON Schema validation. Apply methods mutate fields sequentially and clear omitted optional values. They do not provide transactional updates or create related links.
+
+For STAC validation, install `pystac[validation]` and call the STAC object's `validate()`. Schema retrieval may require network access or an application-configured schema cache.
+
+`OGCRecord.from_dict()` checks basic Feature structure, not full OGC conformance. The metadata accessors expose dictionaries and do not validate nested schemas. `record.validate(validator)` requires an explicit object exposing `validate(document)`, configured for the OGC schema and references. Calling it without a validator raises `ValueError`. For STAC validation use `record.to_stac_item().validate()`.
+
+The adapter is an in-memory document interface, not an OGC API server, search client, or conformance certification. See [OGC Record reference](../reference/ogc-records.md).

pystac_ext_osc-1.0.0/docs/explanation/index.md

@@ -0,0 +1,19 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Explanation
+
+[Architecture and validation](architecture.md) explains how OSC wrappers and OGC Records use PySTAC, and where schema validation is required.

pystac_ext_osc-1.0.0/docs/how-to/index.md

@@ -0,0 +1,21 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# How-to guides
+
+- [Install the package and build the documentation](install.md).
+- [Update OSC fields and connect resources](use-extension.md).
+- [Create and read OGC workflow and experiment records](ogc-records.md).

pystac_ext_osc-1.0.0/docs/how-to/install.md

@@ -0,0 +1,62 @@
+<!--
+Copyright 2026 Terradue
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Install and build
+
+## Install the library
+
+The package declares Python 3.10 or later and PySTAC `>=1,<2`. The test matrix covers Python 3.10–3.14.
+
+```bash
+python -m pip install pystac-ext-osc
+python -c "from pystac.extensions.osc import OscExtension; print(OscExtension.get_schema_uri())"
+```
+
+## Install from a checkout
+
+```bash
+git clone https://github.com/Terradue/pystac-ext-osc.git
+cd pystac-ext-osc
+python -m pip install -e .
+```
+
+If an existing editable installation predates a packaging change, repeat the editable install in that environment.
+
+## Preview the documentation
+
+Install the package and documentation tools in the same environment. Use a regular install for documentation: static API discovery does not reliably find editable modules inside the shared PySTAC namespace. Reinstall after changing source code:
+
+```bash
+python -m pip install . "mkdocs<2" mkdocs-material "mkdocstrings[python]"
+mkdocs serve
+```
+
+Build with warnings treated as errors:
+
+```bash
+mkdocs build --strict
+```
+
+## Run repository checks
+
+With Hatch installed, run these commands from the checkout:
+
+```bash
+hatch run dev:check
+hatch run dev:typecheck
+hatch run dev:security
+hatch run test:test
+```