osdu-python-client 0.4.1__tar.gz

osdu_python_client-0.4.1/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 2020 Open Subsurface Data Universe Software / Platform / Domain Data Mgmt Services / Wellbore
+
+   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_client-0.4.1/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: osdu-python-client
+Version: 0.4.1
+Summary: Python client for OSDU services
+Author: OSDU team
+License-Expression: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs>=26.1.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: openapi-python-client>=0.28.3
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.33.1
+Requires-Dist: ruff>=0.15.12
+Provides-Extra: azure
+Requires-Dist: msal>=1.35.1; extra == "azure"
+Requires-Dist: azure-identity>=1.14.0; extra == "azure"
+Provides-Extra: gcp
+Requires-Dist: google-auth[requests]>=2.0.0; extra == "gcp"
+Provides-Extra: ibm
+Requires-Dist: python-keycloak>=3.0.0; extra == "ibm"
+Provides-Extra: all-csp
+Requires-Dist: msal>=1.35.1; extra == "all-csp"
+Requires-Dist: azure-identity>=1.14.0; extra == "all-csp"
+Requires-Dist: google-auth[requests]>=2.0.0; extra == "all-csp"
+Requires-Dist: python-keycloak>=3.0.0; extra == "all-csp"
+Provides-Extra: dev
+Requires-Dist: pytest==9.0.3; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev"
+Requires-Dist: pydantic-settings==2.14.0; extra == "dev"
+Requires-Dist: msal==1.36.0; extra == "dev"
+Dynamic: license-file
+
+# OSDU Python Client
+
+[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/060070c2-8a92-457a-bf34-8c625391b777/badge)](https://developer.equinor.com/governance/scm-policy/)
+
+Python client library for [OSDU](https://osduforum.org/) services, automatically generated from OpenAPI specifications and wrapped with a handwritten facade that handles authentication, retries, partition headers, and ergonomic per-operation calls.
+
+## Installation
+
+```bash
+pip install osdu-python-client
+```
+
+The base install supports Community/baremetal (Keycloak client credentials) and AWS (OAuth2 client credentials) — both use only `httpx` which is already a core dependency. For other cloud providers, install the matching extra:
+
+| Cloud | Extra | Command |
+|-------|-------|---------|
+| Azure / Entra ID | `azure` | `pip install 'osdu-python-client[azure]'` |
+| GCP | `gcp` | `pip install 'osdu-python-client[gcp]'` |
+| IBM | `ibm` | `pip install 'osdu-python-client[ibm]'` |
+| All providers | `all-csp` | `pip install 'osdu-python-client[all-csp]'` |
+
+Python 3.13+ is required.
+
+## Quick Start
+
+```python
+from osdu_python_client import OsduClient
+from osdu_python_client.generated.search.models.query_request import QueryRequest
+
+with OsduClient() as osdu:  # config loaded from .env
+    dto = osdu.search.query_records(
+        body=QueryRequest(kind="osdu:wks:master-data--Wellbore:*", query="*", limit=1)
+    )
+    for record in dto.results:
+        print(record.additional_properties)
+```
+
+Each `osdu.<service>.<operation>(...)` call auto-binds the underlying client and `data-partition-id`, returns the parsed response model on 2xx, and raises `OsduError` on non-2xx. Call `.detailed(...)` on any operation to get the full `Response` envelope (status code, headers, parsed error model).
+
+## Available Services
+
+| Attribute        | Service                    |
+| ---------------- | -------------------------- |
+| `crs_catalog`    | CRS Catalog                |
+| `crs_conversion` | CRS Conversion             |
+| `dataset`        | Dataset                    |
+| `entitlements`   | Entitlements               |
+| `file`           | File                       |
+| `indexer`        | Indexer                    |
+| `workflow`       | Ingestion Workflow Service |
+| `legal`          | Legal                      |
+| `notification`   | Notification               |
+| `partition`      | Partition                  |
+| `policy`         | Policy                     |
+| `register`       | Register                   |
+| `schema`         | Schema                     |
+| `search`         | Search                     |
+| `seismic_ddms`   | Seismic DDMS               |
+| `storage`        | Storage                    |
+| `unit`           | Unit                       |
+| `wellbore_ddms`  | Wellbore DDMS              |
+
+## Configuration
+
+Configuration is loaded from environment variables or a `.env` file:
+
+```ini
+SERVER=https://your-osdu-instance.com
+DATA_PARTITION_ID=your-partition
+AUTH_PROVIDER=azure_msal
+CLIENT_ID=...
+AUTHORITY=https://login.microsoftonline.com/<tenant>
+SCOPES=.../.default
+AUTH_MODE=interactive   # interactive | device_flow | client_credentials | workload_identity
+```
+
+## Auth Providers
+
+Auth is pluggable via `AUTH_PROVIDER`. Azure MSAL is built in; other CSPs can be passed directly.
+
+| Provider | Status | Required config |
+|---|---|---|
+| `azure_msal` | built-in | `CLIENT_ID`, `AUTHORITY`, `SCOPES`, `AUTH_MODE` |
+| `aws_cognito` | stub | bring your own `TokenProvider` |
+| `gcp_iam` | stub | bring your own `TokenProvider` |
+| `ibm_iam` | stub | bring your own `TokenProvider` |
+
+### Azure MSAL flows
+
+| `AUTH_MODE` | When to use | Required config |
+|---|---|---|
+| `interactive` | Local dev / tests | `client_id`, `authority`, `scopes` |
+| `device_flow` | Headless scripts | `client_id`, `authority`, `scopes` |
+| `client_credentials` | CI, service-to-service | + `client_secret` |
+| `workload_identity` | AKS / Workload Identity Federation | `scopes`; optional `azure_client_id`, `azure_tenant_id`, `azure_federated_token_file` |
+
+Tokens are cached to `.msal_token_cache.bin` (override with `MSAL_CACHE_PATH`). The transport retries 401 once with `force_refresh=True` and retries `429/502/503/504` with exponential backoff honouring `Retry-After`.
+
+For `workload_identity` the token is cached in memory because there a writeable file system may not be available. The optional parameters are typically set by the Kubernetes runtime.
+
+### Custom / bring-your-own provider
+
+Implement the `TokenProvider` protocol (one method) and pass it directly:
+
+```python
+class MyAwsProvider:
+    def get_token(self, force_refresh: bool = False) -> str:
+        return "..."  # return a bearer token string
+
+osdu = OsduClient(token_provider=MyAwsProvider())
+```
+
+## Async
+
+```python
+import asyncio
+from osdu_python_client import AsyncOsduClient
+from osdu_python_client.generated.search.models.query_request import QueryRequest
+
+async def main():
+    async with AsyncOsduClient() as osdu:
+        dto = await osdu.search.query_records(
+            body=QueryRequest(kind="osdu:wks:master-data--Wellbore:*", query="*", limit=1)
+        )
+        return dto.results
+
+asyncio.run(main())
+```
+
+## Per-service Header Overrides
+
+```python
+# Scope extra headers to one service
+with osdu.with_headers(service="crs_conversion", **{"frame-of-reference": "units=SI"}):
+    osdu.crs_conversion.convert_records(body=req)
+
+# Or apply to all services (e.g. correlation IDs)
+with osdu.with_headers(**{"x-correlation-id": correlation_id}):
+    ...
+```
+
+The async client exposes the same helper as `async with osdu.with_headers(...)`.
+
+## Debugging
+
+```python
+from osdu_python_client import enable_debug_logging
+enable_debug_logging()                    # transport + auth at DEBUG
+enable_debug_logging(include_bodies=True) # also log truncated request/response bodies
+```
+
+`Authorization` and `Cookie` headers are always redacted from log output. Bodies are off by default because OSDU payloads may contain PII.
+
+## Low-level: Raw Generated Client
+
+The generated clients can be used directly with a static token when you need full control:
+
+```python
+from osdu_python_client.generated.entitlements.api.list_group_on_behalf_of_api import (
+    list_all_partition_groups,
+)
+from osdu_python_client.generated.entitlements.client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://your-osdu-instance.com/api/entitlements/v2",
+    token="YOUR_ACCESS_TOKEN",
+)
+
+result = list_all_partition_groups.sync_detailed(
+    client=client,
+    data_partition_id="your-partition-id",
+    type_="NONE",
+)
+if result.parsed:
+    for group in result.parsed.groups:
+        print(group.name, group.email)
+```
+
+The async variant is `asyncio_detailed(...)`.
+
+## Development
+
+```bash
+git clone https://community.opengroup.org/osdu/platform/system/sdks/osdu-python-client.git
+cd osdu-python-client
+uv sync --all-extras
+uv run python generate_all.py
+uv run pytest tests/test_facade.py tests/test_transport.py -q
+```
+
+For adding services, updating OpenAPI specs, the release process, and project structure, see [docs/development.md](docs/development.md).
+
+## License
+
+Ref. [License Information](LICENSE)
+

osdu_python_client-0.4.1/README.md

@@ -0,0 +1,196 @@
+# OSDU Python Client
+
+[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/060070c2-8a92-457a-bf34-8c625391b777/badge)](https://developer.equinor.com/governance/scm-policy/)
+
+Python client library for [OSDU](https://osduforum.org/) services, automatically generated from OpenAPI specifications and wrapped with a handwritten facade that handles authentication, retries, partition headers, and ergonomic per-operation calls.
+
+## Installation
+
+```bash
+pip install osdu-python-client
+```
+
+The base install supports Community/baremetal (Keycloak client credentials) and AWS (OAuth2 client credentials) — both use only `httpx` which is already a core dependency. For other cloud providers, install the matching extra:
+
+| Cloud | Extra | Command |
+|-------|-------|---------|
+| Azure / Entra ID | `azure` | `pip install 'osdu-python-client[azure]'` |
+| GCP | `gcp` | `pip install 'osdu-python-client[gcp]'` |
+| IBM | `ibm` | `pip install 'osdu-python-client[ibm]'` |
+| All providers | `all-csp` | `pip install 'osdu-python-client[all-csp]'` |
+
+Python 3.13+ is required.
+
+## Quick Start
+
+```python
+from osdu_python_client import OsduClient
+from osdu_python_client.generated.search.models.query_request import QueryRequest
+
+with OsduClient() as osdu:  # config loaded from .env
+    dto = osdu.search.query_records(
+        body=QueryRequest(kind="osdu:wks:master-data--Wellbore:*", query="*", limit=1)
+    )
+    for record in dto.results:
+        print(record.additional_properties)
+```
+
+Each `osdu.<service>.<operation>(...)` call auto-binds the underlying client and `data-partition-id`, returns the parsed response model on 2xx, and raises `OsduError` on non-2xx. Call `.detailed(...)` on any operation to get the full `Response` envelope (status code, headers, parsed error model).
+
+## Available Services
+
+| Attribute        | Service                    |
+| ---------------- | -------------------------- |
+| `crs_catalog`    | CRS Catalog                |
+| `crs_conversion` | CRS Conversion             |
+| `dataset`        | Dataset                    |
+| `entitlements`   | Entitlements               |
+| `file`           | File                       |
+| `indexer`        | Indexer                    |
+| `workflow`       | Ingestion Workflow Service |
+| `legal`          | Legal                      |
+| `notification`   | Notification               |
+| `partition`      | Partition                  |
+| `policy`         | Policy                     |
+| `register`       | Register                   |
+| `schema`         | Schema                     |
+| `search`         | Search                     |
+| `seismic_ddms`   | Seismic DDMS               |
+| `storage`        | Storage                    |
+| `unit`           | Unit                       |
+| `wellbore_ddms`  | Wellbore DDMS              |
+
+## Configuration
+
+Configuration is loaded from environment variables or a `.env` file:
+
+```ini
+SERVER=https://your-osdu-instance.com
+DATA_PARTITION_ID=your-partition
+AUTH_PROVIDER=azure_msal
+CLIENT_ID=...
+AUTHORITY=https://login.microsoftonline.com/<tenant>
+SCOPES=.../.default
+AUTH_MODE=interactive   # interactive | device_flow | client_credentials | workload_identity
+```
+
+## Auth Providers
+
+Auth is pluggable via `AUTH_PROVIDER`. Azure MSAL is built in; other CSPs can be passed directly.
+
+| Provider | Status | Required config |
+|---|---|---|
+| `azure_msal` | built-in | `CLIENT_ID`, `AUTHORITY`, `SCOPES`, `AUTH_MODE` |
+| `aws_cognito` | stub | bring your own `TokenProvider` |
+| `gcp_iam` | stub | bring your own `TokenProvider` |
+| `ibm_iam` | stub | bring your own `TokenProvider` |
+
+### Azure MSAL flows
+
+| `AUTH_MODE` | When to use | Required config |
+|---|---|---|
+| `interactive` | Local dev / tests | `client_id`, `authority`, `scopes` |
+| `device_flow` | Headless scripts | `client_id`, `authority`, `scopes` |
+| `client_credentials` | CI, service-to-service | + `client_secret` |
+| `workload_identity` | AKS / Workload Identity Federation | `scopes`; optional `azure_client_id`, `azure_tenant_id`, `azure_federated_token_file` |
+
+Tokens are cached to `.msal_token_cache.bin` (override with `MSAL_CACHE_PATH`). The transport retries 401 once with `force_refresh=True` and retries `429/502/503/504` with exponential backoff honouring `Retry-After`.
+
+For `workload_identity` the token is cached in memory because there a writeable file system may not be available. The optional parameters are typically set by the Kubernetes runtime.
+
+### Custom / bring-your-own provider
+
+Implement the `TokenProvider` protocol (one method) and pass it directly:
+
+```python
+class MyAwsProvider:
+    def get_token(self, force_refresh: bool = False) -> str:
+        return "..."  # return a bearer token string
+
+osdu = OsduClient(token_provider=MyAwsProvider())
+```
+
+## Async
+
+```python
+import asyncio
+from osdu_python_client import AsyncOsduClient
+from osdu_python_client.generated.search.models.query_request import QueryRequest
+
+async def main():
+    async with AsyncOsduClient() as osdu:
+        dto = await osdu.search.query_records(
+            body=QueryRequest(kind="osdu:wks:master-data--Wellbore:*", query="*", limit=1)
+        )
+        return dto.results
+
+asyncio.run(main())
+```
+
+## Per-service Header Overrides
+
+```python
+# Scope extra headers to one service
+with osdu.with_headers(service="crs_conversion", **{"frame-of-reference": "units=SI"}):
+    osdu.crs_conversion.convert_records(body=req)
+
+# Or apply to all services (e.g. correlation IDs)
+with osdu.with_headers(**{"x-correlation-id": correlation_id}):
+    ...
+```
+
+The async client exposes the same helper as `async with osdu.with_headers(...)`.
+
+## Debugging
+
+```python
+from osdu_python_client import enable_debug_logging
+enable_debug_logging()                    # transport + auth at DEBUG
+enable_debug_logging(include_bodies=True) # also log truncated request/response bodies
+```
+
+`Authorization` and `Cookie` headers are always redacted from log output. Bodies are off by default because OSDU payloads may contain PII.
+
+## Low-level: Raw Generated Client
+
+The generated clients can be used directly with a static token when you need full control:
+
+```python
+from osdu_python_client.generated.entitlements.api.list_group_on_behalf_of_api import (
+    list_all_partition_groups,
+)
+from osdu_python_client.generated.entitlements.client import AuthenticatedClient
+
+client = AuthenticatedClient(
+    base_url="https://your-osdu-instance.com/api/entitlements/v2",
+    token="YOUR_ACCESS_TOKEN",
+)
+
+result = list_all_partition_groups.sync_detailed(
+    client=client,
+    data_partition_id="your-partition-id",
+    type_="NONE",
+)
+if result.parsed:
+    for group in result.parsed.groups:
+        print(group.name, group.email)
+```
+
+The async variant is `asyncio_detailed(...)`.
+
+## Development
+
+```bash
+git clone https://community.opengroup.org/osdu/platform/system/sdks/osdu-python-client.git
+cd osdu-python-client
+uv sync --all-extras
+uv run python generate_all.py
+uv run pytest tests/test_facade.py tests/test_transport.py -q
+```
+
+For adding services, updating OpenAPI specs, the release process, and project structure, see [docs/development.md](docs/development.md).
+
+## License
+
+Ref. [License Information](LICENSE)
+