osdu-python-models 0.5.0__tar.gz

osdu_python_models-0.5.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 Equinor ASA
+
+   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.

osdu_python_models-0.5.0/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: osdu-python-models
+Version: 0.5.0
+Summary: Typed Pydantic models for OSDU data payloads — opt-in companion to osdu-python-client
+Author: Equinor
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/equinor/osdu-python-models
+Project-URL: Repository, https://github.com/equinor/osdu-python-models
+Project-URL: Issues, https://github.com/equinor/osdu-python-models/issues
+Keywords: osdu,pydantic,schemas,models,wellbore,ddms
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.9
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator>=0.26; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# osdu-python-models
+
+Typed **Pydantic v2** models for OSDU `data` payloads — an opt-in companion to
+[`osdu-python-client`](https://community.opengroup.org/osdu/platform/system/sdks/osdu-python-client),
+mirroring the C# [`osdu-csharp-schemas`](https://github.com/equinor/osdu-csharp-schemas)
+library.
+
+> **Scope.** Covers **all `work-product-component`,
+> `master-data` and `dataset` entity types** in the pinned OSDU snapshot — **194
+> entity types across 551 schema versions** (93 work-product-component + 73
+> master-data + 28 dataset), plus **128 shared `abstract` modules** pulled in on
+> demand. The generator is data-driven: the scope is the `SCOPE_GROUPS` list in
+> `tools/generate.py`, and every type and version is discovered from the snapshot
+> automatically, so a snapshot bump or adding a group needs no other code change.
+> `abstract` schemas are not listed explicitly — only those reachable from a
+> selected entity's `$ref` closure are generated.
+
+## Why
+
+`osdu-python-client` leaves the record `data` block free-form (a `dict`), matching
+the canonical `os-core-common` `Map<String, Object>` — the right call, because OSDU
+`data` is schema-on-read and versioned by `kind`. But consumers building ingestion
+or validation logic for a **specific kind + version** still want types: autocomplete,
+runtime validation, and self-documenting payloads. This package provides exactly
+that, without touching the client.
+
+```python
+from osdu_models.workproductcomponent.well_log.v1_5_0 import Data, Curve
+
+# Typed authoring — autocomplete + validation
+data = Data(
+    WellboreID="namespace:master-data--Wellbore:abc:",
+    TopMeasuredDepth=1234.5,
+    Curves=[Curve(Mnemonic="GR")],
+)
+
+# Bridge into the client's free-form `data` — just model_dump(), no client changes
+record = {"kind": "osdu:wks:work-product-component--WellLog:1.5.0",
+          "acl": ..., "legal": ...,
+          "data": data.model_dump(by_alias=True, exclude_none=True)}
+```
+
+Reading is the mirror image: `Data.model_validate(record["data"])`.
+
+## Install
+
+```sh
+pip install osdu-python-models
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv add osdu-python-models
+```
+
+Models are shipped pre-generated in the published distributions — no codegen step
+needed to consume them. To build from source instead, see
+[Build & test](https://github.com/equinor/osdu-python-models#build--test).
+
+> Each tagged version is also attached to its
+> [GitHub Release](https://github.com/equinor/osdu-python-models/releases) as
+> `.whl` / `.tar.gz` assets.
+
+## Design
+
+- **Types only the `data` block.** The client owns the envelope (id/kind/acl/legal);
+  this package owns `data`. The two compose via `model_dump()` / `model_validate()`.
+- **Side-by-side versions.** Each published version is its own module
+  (`well_log/v1_4_0.py`, `v1_5_0.py`) — no "latest wins", explicit per-`kind`.
+- **Shared abstract modules.** OSDU `abstract/*` building blocks are generated
+  **once** under `osdu_models/abstract/<type>/v<ver>.py`; each entity model
+  imports them rather than inlining a private copy. This removes the ~96 % class
+  duplication of a per-entity bundling approach (551 models: ~65,000 → 2,071 class
+  defs) and is what makes scaling to the full schema set viable. Same idea as
+  the C# library's `ExternalReferenceCode` abstract sharing.
+- **String-only constraints stripped off non-string nodes.** A few OSDU schemas
+  attach `pattern`/`format` to `array`/`integer` fields (e.g.
+  `AbstractColumnBasedTable.IntegerColumn`); the generator drops them so Pydantic
+  v2 doesn't reject otherwise-valid payloads.
+- **`extra='allow'` everywhere.** Unknown / forward-compatible fields round-trip
+  untouched (the Pydantic equivalent of C#'s `[JsonExtensionData]`).
+- **String `format` dropped → plain `str`.** This library types `data` for
+  *lossless* round-tripping, not semantic validation. Honouring `format` would
+  make codegen emit validating/normalising types that defeat that or pull
+  optional deps: `date`/`date-time`/`time` (OSDU payloads carry non-conformant
+  variants a strict parser rejects), `email` (`EmailStr`, needs `email-validator`),
+  `uri` (`AnyUrl`, normalises the value). Keeping plain `str` preserves the input.
+  Same pragmatic choice the C# library makes.
+- **Pinned snapshot.** `schemas/2026.05.22/` is a frozen copy of the OSDU
+  `data-definitions` `Generated/` schemas (shared with the C# library). Bumping it
+  is an explicit, reviewable change.
+
+## Layout
+
+```
+osdu-python-models/
+├── schemas/2026.05.22/        # pinned data-definitions snapshot (abstract + entities)
+├── tools/generate.py          # restructures the `data` sub-schemas, runs datamodel-codegen
+├── src/osdu_models/            # generated Pydantic models (gitignored, regenerable)
+│   ├── abstract/<type>/v<ver>.py          # shared abstract building blocks (generated once)
+│   ├── workproductcomponent/<type>/v<ver>.py
+│   ├── masterdata/<type>/v<ver>.py        # → class Data, importing the shared abstracts
+│   └── dataset/<type>/v<ver>.py           # e.g. dataset/file_generic/v1_1_0.py
+├── tests/test_roundtrip.py    # round-trip + typed-access tests vs real OSDU examples (all versions)
+└── samples/author_welllog.py  # end-to-end authoring demo (no network)
+```
+
+## Build & test
+
+```sh
+uv venv && uv pip install -e ".[dev]"
+uv run python tools/generate.py     # generate models from the pinned snapshot
+uv run ruff check tools tests samples  # lint hand-written sources (not generated)
+uv run pytest                       # round-trip tests against OSDU example payloads
+uv run python samples/author_welllog.py
+```
+
+## How it works
+
+OSDU record schemas put the payload under `properties.data` as an `allOf` of
+abstract building blocks (`../abstract/*.json`) plus inline fields. `tools/generate.py`
+uses `datamodel-codegen` **directory mode**, which turns cross-file `$ref`s into
+Python imports:
+
+1. lifts each entity's `data` sub-schema (titled `Data`) and transitively
+   collects the shared `abstract/*` files it references,
+2. lays both out in a temp tree mirroring the output package structure (every
+   file at the same depth, `<pkg>/<snake>/v<ver>.json`), cleaning schema quirks
+   and rewriting every `$ref` to a canonical root-relative path (`../../<pkg>/
+   <snake>/v<ver>.json`) so it resolves identically regardless of which file the
+   resolver treats as the base — sidestepping a `datamodel-codegen` quirk that
+   otherwise resolves a shared schema's nested `$ref`s against the *referencing*
+   entity's directory,
+3. runs `datamodel-codegen` **once** over that tree — emitting each abstract as a
+   shared module and each entity as a `Data` model that imports them.
+
+Generated code is gitignored — regenerable from the pinned snapshot, never
+hand-edited.
+
+## Contributing
+
+Contributions are welcome — see [`CONTRIBUTING.md`](https://github.com/equinor/osdu-python-models/blob/main/CONTRIBUTING.md) for
+development setup, the pull-request process, and commit conventions.
+
+## Security
+
+To report a security vulnerability, follow the process in
+[`SECURITY.md`](https://github.com/equinor/osdu-python-models/blob/main/SECURITY.md). Do not open a public issue.
+
+## License
+
+Licensed under the [Apache License 2.0](https://github.com/equinor/osdu-python-models/blob/main/LICENSE).

osdu_python_models-0.5.0/README.md

@@ -0,0 +1,153 @@
+# osdu-python-models
+
+Typed **Pydantic v2** models for OSDU `data` payloads — an opt-in companion to
+[`osdu-python-client`](https://community.opengroup.org/osdu/platform/system/sdks/osdu-python-client),
+mirroring the C# [`osdu-csharp-schemas`](https://github.com/equinor/osdu-csharp-schemas)
+library.
+
+> **Scope.** Covers **all `work-product-component`,
+> `master-data` and `dataset` entity types** in the pinned OSDU snapshot — **194
+> entity types across 551 schema versions** (93 work-product-component + 73
+> master-data + 28 dataset), plus **128 shared `abstract` modules** pulled in on
+> demand. The generator is data-driven: the scope is the `SCOPE_GROUPS` list in
+> `tools/generate.py`, and every type and version is discovered from the snapshot
+> automatically, so a snapshot bump or adding a group needs no other code change.
+> `abstract` schemas are not listed explicitly — only those reachable from a
+> selected entity's `$ref` closure are generated.
+
+## Why
+
+`osdu-python-client` leaves the record `data` block free-form (a `dict`), matching
+the canonical `os-core-common` `Map<String, Object>` — the right call, because OSDU
+`data` is schema-on-read and versioned by `kind`. But consumers building ingestion
+or validation logic for a **specific kind + version** still want types: autocomplete,
+runtime validation, and self-documenting payloads. This package provides exactly
+that, without touching the client.
+
+```python
+from osdu_models.workproductcomponent.well_log.v1_5_0 import Data, Curve
+
+# Typed authoring — autocomplete + validation
+data = Data(
+    WellboreID="namespace:master-data--Wellbore:abc:",
+    TopMeasuredDepth=1234.5,
+    Curves=[Curve(Mnemonic="GR")],
+)
+
+# Bridge into the client's free-form `data` — just model_dump(), no client changes
+record = {"kind": "osdu:wks:work-product-component--WellLog:1.5.0",
+          "acl": ..., "legal": ...,
+          "data": data.model_dump(by_alias=True, exclude_none=True)}
+```
+
+Reading is the mirror image: `Data.model_validate(record["data"])`.
+
+## Install
+
+```sh
+pip install osdu-python-models
+```
+
+or with [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv add osdu-python-models
+```
+
+Models are shipped pre-generated in the published distributions — no codegen step
+needed to consume them. To build from source instead, see
+[Build & test](https://github.com/equinor/osdu-python-models#build--test).
+
+> Each tagged version is also attached to its
+> [GitHub Release](https://github.com/equinor/osdu-python-models/releases) as
+> `.whl` / `.tar.gz` assets.
+
+## Design
+
+- **Types only the `data` block.** The client owns the envelope (id/kind/acl/legal);
+  this package owns `data`. The two compose via `model_dump()` / `model_validate()`.
+- **Side-by-side versions.** Each published version is its own module
+  (`well_log/v1_4_0.py`, `v1_5_0.py`) — no "latest wins", explicit per-`kind`.
+- **Shared abstract modules.** OSDU `abstract/*` building blocks are generated
+  **once** under `osdu_models/abstract/<type>/v<ver>.py`; each entity model
+  imports them rather than inlining a private copy. This removes the ~96 % class
+  duplication of a per-entity bundling approach (551 models: ~65,000 → 2,071 class
+  defs) and is what makes scaling to the full schema set viable. Same idea as
+  the C# library's `ExternalReferenceCode` abstract sharing.
+- **String-only constraints stripped off non-string nodes.** A few OSDU schemas
+  attach `pattern`/`format` to `array`/`integer` fields (e.g.
+  `AbstractColumnBasedTable.IntegerColumn`); the generator drops them so Pydantic
+  v2 doesn't reject otherwise-valid payloads.
+- **`extra='allow'` everywhere.** Unknown / forward-compatible fields round-trip
+  untouched (the Pydantic equivalent of C#'s `[JsonExtensionData]`).
+- **String `format` dropped → plain `str`.** This library types `data` for
+  *lossless* round-tripping, not semantic validation. Honouring `format` would
+  make codegen emit validating/normalising types that defeat that or pull
+  optional deps: `date`/`date-time`/`time` (OSDU payloads carry non-conformant
+  variants a strict parser rejects), `email` (`EmailStr`, needs `email-validator`),
+  `uri` (`AnyUrl`, normalises the value). Keeping plain `str` preserves the input.
+  Same pragmatic choice the C# library makes.
+- **Pinned snapshot.** `schemas/2026.05.22/` is a frozen copy of the OSDU
+  `data-definitions` `Generated/` schemas (shared with the C# library). Bumping it
+  is an explicit, reviewable change.
+
+## Layout
+
+```
+osdu-python-models/
+├── schemas/2026.05.22/        # pinned data-definitions snapshot (abstract + entities)
+├── tools/generate.py          # restructures the `data` sub-schemas, runs datamodel-codegen
+├── src/osdu_models/            # generated Pydantic models (gitignored, regenerable)
+│   ├── abstract/<type>/v<ver>.py          # shared abstract building blocks (generated once)
+│   ├── workproductcomponent/<type>/v<ver>.py
+│   ├── masterdata/<type>/v<ver>.py        # → class Data, importing the shared abstracts
+│   └── dataset/<type>/v<ver>.py           # e.g. dataset/file_generic/v1_1_0.py
+├── tests/test_roundtrip.py    # round-trip + typed-access tests vs real OSDU examples (all versions)
+└── samples/author_welllog.py  # end-to-end authoring demo (no network)
+```
+
+## Build & test
+
+```sh
+uv venv && uv pip install -e ".[dev]"
+uv run python tools/generate.py     # generate models from the pinned snapshot
+uv run ruff check tools tests samples  # lint hand-written sources (not generated)
+uv run pytest                       # round-trip tests against OSDU example payloads
+uv run python samples/author_welllog.py
+```
+
+## How it works
+
+OSDU record schemas put the payload under `properties.data` as an `allOf` of
+abstract building blocks (`../abstract/*.json`) plus inline fields. `tools/generate.py`
+uses `datamodel-codegen` **directory mode**, which turns cross-file `$ref`s into
+Python imports:
+
+1. lifts each entity's `data` sub-schema (titled `Data`) and transitively
+   collects the shared `abstract/*` files it references,
+2. lays both out in a temp tree mirroring the output package structure (every
+   file at the same depth, `<pkg>/<snake>/v<ver>.json`), cleaning schema quirks
+   and rewriting every `$ref` to a canonical root-relative path (`../../<pkg>/
+   <snake>/v<ver>.json`) so it resolves identically regardless of which file the
+   resolver treats as the base — sidestepping a `datamodel-codegen` quirk that
+   otherwise resolves a shared schema's nested `$ref`s against the *referencing*
+   entity's directory,
+3. runs `datamodel-codegen` **once** over that tree — emitting each abstract as a
+   shared module and each entity as a `Data` model that imports them.
+
+Generated code is gitignored — regenerable from the pinned snapshot, never
+hand-edited.
+
+## Contributing
+
+Contributions are welcome — see [`CONTRIBUTING.md`](https://github.com/equinor/osdu-python-models/blob/main/CONTRIBUTING.md) for
+development setup, the pull-request process, and commit conventions.
+
+## Security
+
+To report a security vulnerability, follow the process in
+[`SECURITY.md`](https://github.com/equinor/osdu-python-models/blob/main/SECURITY.md). Do not open a public issue.
+
+## License
+
+Licensed under the [Apache License 2.0](https://github.com/equinor/osdu-python-models/blob/main/LICENSE).

osdu_python_models-0.5.0/pyproject.toml

@@ -0,0 +1,56 @@
+[project]
+name = "osdu-python-models"
+version = "0.5.0"
+description = "Typed Pydantic models for OSDU data payloads — opt-in companion to osdu-python-client"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{ name = "Equinor" }]
+keywords = ["osdu", "pydantic", "schemas", "models", "wellbore", "ddms"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
+]
+dependencies = [
+    "pydantic>=2.9",
+]
+
+[project.urls]
+Homepage = "https://github.com/equinor/osdu-python-models"
+Repository = "https://github.com/equinor/osdu-python-models"
+Issues = "https://github.com/equinor/osdu-python-models/issues"
+
+[project.optional-dependencies]
+dev = [
+    "datamodel-code-generator>=0.26",
+    "pytest>=8.0",
+    "ruff>=0.6",
+]
+
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+# Lint only hand-written sources. `src/osdu_models` is datamodel-codegen output
+# (gitignored, regenerable, never hand-edited), so it is intentionally excluded.
+target-version = "py310"
+include = ["tools/**/*.py", "tests/**/*.py", "samples/**/*.py"]
+extend-exclude = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

osdu_python_models-0.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

osdu_python_models-0.5.0/src/osdu_models/abstract/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_python_models-0.5.0/src/osdu_models/abstract/abstract_access_control_list/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4

osdu_python_models-0.5.0/src/osdu_models/abstract/abstract_access_control_list/v1_0_0.py

@@ -0,0 +1,31 @@
+# generated by datamodel-codegen:
+#   filename:  abstract/abstract_access_control_list/v1_0_0.json
+
+from __future__ import annotations
+from pydantic import BaseModel, ConfigDict, Field, constr
+
+
+class AccessControlList(BaseModel):
+    """
+    The access control tags associated with this entity. This structure is included by the SystemProperties "acl", which is part of all OSDU records. Not extensible.
+    """
+
+    model_config = ConfigDict(
+        extra='allow',
+    )
+    owners: list[
+        constr(
+            pattern=r'^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$'
+        )
+    ] = Field(..., title='List of Owners')
+    """
+    The list of owners of this data record formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
+    """
+    viewers: list[
+        constr(
+            pattern=r'^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,7}$'
+        )
+    ] = Field(..., title='List of Viewers')
+    """
+    The list of viewers to which this data record is accessible/visible/discoverable formatted as an email (core.common.model.storage.validation.ValidationDoc.EMAIL_REGEX).
+    """

osdu_python_models-0.5.0/src/osdu_models/abstract/abstract_activity_parameter/__init__.py

@@ -0,0 +1,2 @@
+# generated by datamodel-codegen:
+#   filename:  tmp4rfivwe4