pointcosm 0.4.0__tar.gz

pointcosm-0.4.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 PointCosm
+
+   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.

pointcosm-0.4.0/PKG-INFO

@@ -0,0 +1,217 @@
+Metadata-Version: 2.4
+Name: pointcosm
+Version: 0.4.0
+Summary: Official Python SDK for the PointCosm customer API
+Keywords: pointcosm,sdk,api-client,openapi
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: attrs>=26.1,<27
+Requires-Dist: httpx>=0.28.1,<0.29
+Maintainer: PointCosm
+Requires-Python: >=3.11, <3.15
+Project-URL: Repository, https://github.com/pointcosm-studio/pointcosm-python
+Project-URL: Issues, https://github.com/pointcosm-studio/pointcosm-python/issues
+Description-Content-Type: text/markdown
+
+# Pointcosm Python SDK
+
+[简体中文](README.zh-CN.md) | English
+
+> **Status:** implementation is complete for local validation. This package has not been
+> published and is not approved for production use.
+
+This repository contains the public Pointcosm Python SDK. Its sole contract authority is a pinned,
+reviewed commit of `pointcosm-sdk-contracts`; the SDK imports Customer/Auth OpenAPI, language-neutral
+manifests, sensitive-field rules and bundle metadata from that clean local checkout without network
+access. Train and Auth remain upstream runtime fact sources for the contracts repository, but are
+never direct SDK generation inputs. Mixed internal `GET /openapi.json` contracts are prohibited.
+
+## Development setup
+
+The validated compatibility range is CPython 3.11 through 3.14.
+
+```bash
+uv sync --all-groups --python 3.14
+uv run python -c "import pointcosm"
+uv run pytest
+```
+
+Train Platform commands that load application settings must explicitly use:
+
+```bash
+APP_PROFILE=local
+```
+
+## Safety boundaries
+
+- Never commit real access tokens, client secrets, STS credentials, Webhook secrets, or signed URLs.
+- Do not generate from an internal or mixed OpenAPI document.
+- Do not weaken contract, deterministic-generation, error, or sensitive-sentinel gates.
+- Building local wheel or sdist artifacts is allowed for validation only.
+- Uploading to TestPyPI or PyPI, creating a public tag or release, and declaring production
+  readiness require separate explicit project-owner approval.
+- Publishing uses GitHub Actions Trusted Publishing with the protected `pypi` environment. No
+  long-lived PyPI token belongs in repository or organization secrets.
+
+The reviewed implementation artifacts are under
+[`specs/001-python-sdk-v1/`](specs/001-python-sdk-v1/).
+
+## Contract status
+
+The pinned customer OpenAPI snapshot contains 17 paths, 25 public operations and 45 referenced
+schemas. It declares standard `ApiFailureResponse` responses for HTTP 401, 403 and 500 on all 25
+public operations, plus HTTP 422 on all 21 applicable operations. The strict contract gate is:
+
+```bash
+uv run pytest -q tests/contract/test_standard_error_responses.py
+```
+
+Do not skip, xfail or weaken this test during future contract refreshes.
+
+## Contract refresh review
+
+Candidate acquisition and review belong to `pointcosm-sdk-contracts`. This SDK only consumes a full
+40-character commit whose checkout HEAD matches, whose tracked and untracked working tree is clean,
+and whose bundle release, bundle SHA and every declared artifact SHA/size pass. Branches, tags used
+without resolution, abbreviated revisions, dirty checkouts, URLs and loose OpenAPI files are rejected.
+
+The currently approved input is contracts commit `1df69d43b6ac571b31f1c6c67d7d2df38742947d`,
+bundle `0.5.0`, bundle SHA
+`8b948c05f25016b0da7957a3791936d85a15a945bfdc25de4befb43806f75a22`:
+
+```bash
+uv run python scripts/import_contract_bundle.py \
+  /path/to/pointcosm-sdk-contracts \
+  --revision 1df69d43b6ac571b31f1c6c67d7d2df38742947d \
+  --bundle-release 0.5.0 \
+  --bundle-sha256 8b948c05f25016b0da7957a3791936d85a15a945bfdc25de4befb43806f75a22 \
+  --customer-sha256 34c9aa8d5a59ef4e54a3c5960eba9326b01045db493a57332aa07df256e8c9f6 \
+  --auth-sha256 ff17917c6ccab2fcf1cb6c2ee0392c2efea6dfca567d084a6434836c36c489cf
+uv run python scripts/validate_auth_openapi.py openapi/auth-public.openapi.json
+uv run python scripts/generate.py --check
+```
+
+Use the same command with `--check` after import. Review the imported neutral manifests, Python
+manifests, generated source and provenance diff before accepting it. Auth v1 remains exactly one
+marked `POST /api/oauth/token` operation; credential management and admin operations remain excluded.
+
+Bundle 0.3.0 is a deliberate breaking cleanup. Public `Product`, `Asset`, `Task`, `TaskListItem` and
+`TaskDetail` no longer expose backend display/pipeline/execution fields. Unknown response fields
+remain forward-compatible but are never attached as public attributes. Customer-visible pricing is
+limited to green-point prices and frozen task charges; RMB references and compute-center costs remain
+forbidden.
+
+Bundle 0.4.0 added typed seven-stage milestone timing and richer transfer lifecycle/timestamp quality
+to task progress. Bundle 0.5.0 makes the customer-safe `TaskProgress` projection required and non-null
+on create/rerun `TaskOut`, list `TaskListItem` and retrieve `TaskDetailOut`; its seven English milestone
+values and exactly seven `milestones` entries remain unchanged. SDK 0.4.0 exposes `Task.progress`,
+`TaskListItem.progress` and `TaskDetail.progress` as typed immutable public models.
+
+## Installation
+
+The project is not published yet. For local development:
+
+```bash
+uv sync --all-groups
+```
+
+## Static Bearer
+
+```python
+import os
+
+from pointcosm import Pointcosm
+
+with Pointcosm(
+    base_url="http://localhost:8200",
+    access_token=os.getenv("POINTCOSM_ACCESS_TOKEN", "synthetic-doc-token"),
+) as client:
+    if os.getenv("POINTCOSM_DOCS_DRY_RUN") != "1":
+        products = client.train.list_products()
+```
+
+## Client credentials
+
+The Auth Service uses port 8100 locally. Production base URLs must come from approved customer
+configuration; the SDK repository and package do not publish deployment locators. Production use is
+not approved.
+
+```python
+import os
+
+from pointcosm import Pointcosm
+
+client = Pointcosm.from_client_credentials(
+    base_url="http://localhost:8200",
+    auth_base_url="http://localhost:8100",
+    client_id=os.getenv("POINTCOSM_CLIENT_ID", "synthetic-client"),
+    client_secret=os.getenv("POINTCOSM_CLIENT_SECRET", "synthetic-secret"),
+    resource="train-platform-api",
+)
+if os.getenv("POINTCOSM_DOCS_DRY_RUN") != "1":
+    account = client.billing.get_green_point_account()
+client.close()
+```
+
+Credential creation, listing, rotation and revocation remain UI/admin workflows and are not SDK
+APIs.
+
+## Capabilities and errors
+
+The stable namespaces are `client.train`, `client.storage`, `client.webhooks` and `client.billing`.
+Methods return stable public models and may raise exceptions from `pointcosm.exceptions`.
+For a complete method catalog and end-to-end examples, see the
+[Chinese SDK usage guide](docs/006-python-sdk-guide.zh-CN.md) and the
+[public API reference](docs/004-public-api-reference.md).
+
+```python
+from pointcosm.exceptions import (
+    PointcosmApiError,
+    PointcosmContractError,
+    PointcosmTransportError,
+)
+
+handled_errors = (PointcosmApiError, PointcosmContractError, PointcosmTransportError)
+```
+
+API errors expose bounded `status_code`, `code`, `message`, `details`, `request_id` and
+`operation_id`. They never retain raw bodies or headers.
+
+## Sensitive values
+
+STS keys, Webhook secrets and signed download URLs use `SensitiveStr`. `str` and `repr` are
+redacted; revealing a value requires the explicit `get_secret_value()` method. Never log the
+revealed value.
+
+## Lifecycle, timeout and retry
+
+SDK-created HTTP clients close on context exit. Injected `httpx` clients remain caller-owned and
+must be closed by the caller. Redirects are always disabled. Injected proxies and event hooks are
+also caller-owned; the SDK cannot sanitize logging performed by them.
+
+```python
+from pointcosm import RetryPolicy, TimeoutConfig
+
+timeout = TimeoutConfig(connect=5, read=30, write=30, pool=5)
+retry = RetryPolicy(max_attempts=3, max_elapsed=10)
+```
+
+Retry is disabled by default. When explicitly enabled, only operations whose reviewed manifest
+metadata says `retry=safe` can retry timeout/connect failures or HTTP 429/502/503/504. Mutation,
+secret, authentication, business and contract failures never retry.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE). The license does not grant permission to use
+PointCosm trade names, trademarks, service marks or product names except as described by the
+license.

pointcosm-0.4.0/README.md

@@ -0,0 +1,192 @@
+# Pointcosm Python SDK
+
+[简体中文](README.zh-CN.md) | English
+
+> **Status:** implementation is complete for local validation. This package has not been
+> published and is not approved for production use.
+
+This repository contains the public Pointcosm Python SDK. Its sole contract authority is a pinned,
+reviewed commit of `pointcosm-sdk-contracts`; the SDK imports Customer/Auth OpenAPI, language-neutral
+manifests, sensitive-field rules and bundle metadata from that clean local checkout without network
+access. Train and Auth remain upstream runtime fact sources for the contracts repository, but are
+never direct SDK generation inputs. Mixed internal `GET /openapi.json` contracts are prohibited.
+
+## Development setup
+
+The validated compatibility range is CPython 3.11 through 3.14.
+
+```bash
+uv sync --all-groups --python 3.14
+uv run python -c "import pointcosm"
+uv run pytest
+```
+
+Train Platform commands that load application settings must explicitly use:
+
+```bash
+APP_PROFILE=local
+```
+
+## Safety boundaries
+
+- Never commit real access tokens, client secrets, STS credentials, Webhook secrets, or signed URLs.
+- Do not generate from an internal or mixed OpenAPI document.
+- Do not weaken contract, deterministic-generation, error, or sensitive-sentinel gates.
+- Building local wheel or sdist artifacts is allowed for validation only.
+- Uploading to TestPyPI or PyPI, creating a public tag or release, and declaring production
+  readiness require separate explicit project-owner approval.
+- Publishing uses GitHub Actions Trusted Publishing with the protected `pypi` environment. No
+  long-lived PyPI token belongs in repository or organization secrets.
+
+The reviewed implementation artifacts are under
+[`specs/001-python-sdk-v1/`](specs/001-python-sdk-v1/).
+
+## Contract status
+
+The pinned customer OpenAPI snapshot contains 17 paths, 25 public operations and 45 referenced
+schemas. It declares standard `ApiFailureResponse` responses for HTTP 401, 403 and 500 on all 25
+public operations, plus HTTP 422 on all 21 applicable operations. The strict contract gate is:
+
+```bash
+uv run pytest -q tests/contract/test_standard_error_responses.py
+```
+
+Do not skip, xfail or weaken this test during future contract refreshes.
+
+## Contract refresh review
+
+Candidate acquisition and review belong to `pointcosm-sdk-contracts`. This SDK only consumes a full
+40-character commit whose checkout HEAD matches, whose tracked and untracked working tree is clean,
+and whose bundle release, bundle SHA and every declared artifact SHA/size pass. Branches, tags used
+without resolution, abbreviated revisions, dirty checkouts, URLs and loose OpenAPI files are rejected.
+
+The currently approved input is contracts commit `1df69d43b6ac571b31f1c6c67d7d2df38742947d`,
+bundle `0.5.0`, bundle SHA
+`8b948c05f25016b0da7957a3791936d85a15a945bfdc25de4befb43806f75a22`:
+
+```bash
+uv run python scripts/import_contract_bundle.py \
+  /path/to/pointcosm-sdk-contracts \
+  --revision 1df69d43b6ac571b31f1c6c67d7d2df38742947d \
+  --bundle-release 0.5.0 \
+  --bundle-sha256 8b948c05f25016b0da7957a3791936d85a15a945bfdc25de4befb43806f75a22 \
+  --customer-sha256 34c9aa8d5a59ef4e54a3c5960eba9326b01045db493a57332aa07df256e8c9f6 \
+  --auth-sha256 ff17917c6ccab2fcf1cb6c2ee0392c2efea6dfca567d084a6434836c36c489cf
+uv run python scripts/validate_auth_openapi.py openapi/auth-public.openapi.json
+uv run python scripts/generate.py --check
+```
+
+Use the same command with `--check` after import. Review the imported neutral manifests, Python
+manifests, generated source and provenance diff before accepting it. Auth v1 remains exactly one
+marked `POST /api/oauth/token` operation; credential management and admin operations remain excluded.
+
+Bundle 0.3.0 is a deliberate breaking cleanup. Public `Product`, `Asset`, `Task`, `TaskListItem` and
+`TaskDetail` no longer expose backend display/pipeline/execution fields. Unknown response fields
+remain forward-compatible but are never attached as public attributes. Customer-visible pricing is
+limited to green-point prices and frozen task charges; RMB references and compute-center costs remain
+forbidden.
+
+Bundle 0.4.0 added typed seven-stage milestone timing and richer transfer lifecycle/timestamp quality
+to task progress. Bundle 0.5.0 makes the customer-safe `TaskProgress` projection required and non-null
+on create/rerun `TaskOut`, list `TaskListItem` and retrieve `TaskDetailOut`; its seven English milestone
+values and exactly seven `milestones` entries remain unchanged. SDK 0.4.0 exposes `Task.progress`,
+`TaskListItem.progress` and `TaskDetail.progress` as typed immutable public models.
+
+## Installation
+
+The project is not published yet. For local development:
+
+```bash
+uv sync --all-groups
+```
+
+## Static Bearer
+
+```python
+import os
+
+from pointcosm import Pointcosm
+
+with Pointcosm(
+    base_url="http://localhost:8200",
+    access_token=os.getenv("POINTCOSM_ACCESS_TOKEN", "synthetic-doc-token"),
+) as client:
+    if os.getenv("POINTCOSM_DOCS_DRY_RUN") != "1":
+        products = client.train.list_products()
+```
+
+## Client credentials
+
+The Auth Service uses port 8100 locally. Production base URLs must come from approved customer
+configuration; the SDK repository and package do not publish deployment locators. Production use is
+not approved.
+
+```python
+import os
+
+from pointcosm import Pointcosm
+
+client = Pointcosm.from_client_credentials(
+    base_url="http://localhost:8200",
+    auth_base_url="http://localhost:8100",
+    client_id=os.getenv("POINTCOSM_CLIENT_ID", "synthetic-client"),
+    client_secret=os.getenv("POINTCOSM_CLIENT_SECRET", "synthetic-secret"),
+    resource="train-platform-api",
+)
+if os.getenv("POINTCOSM_DOCS_DRY_RUN") != "1":
+    account = client.billing.get_green_point_account()
+client.close()
+```
+
+Credential creation, listing, rotation and revocation remain UI/admin workflows and are not SDK
+APIs.
+
+## Capabilities and errors
+
+The stable namespaces are `client.train`, `client.storage`, `client.webhooks` and `client.billing`.
+Methods return stable public models and may raise exceptions from `pointcosm.exceptions`.
+For a complete method catalog and end-to-end examples, see the
+[Chinese SDK usage guide](docs/006-python-sdk-guide.zh-CN.md) and the
+[public API reference](docs/004-public-api-reference.md).
+
+```python
+from pointcosm.exceptions import (
+    PointcosmApiError,
+    PointcosmContractError,
+    PointcosmTransportError,
+)
+
+handled_errors = (PointcosmApiError, PointcosmContractError, PointcosmTransportError)
+```
+
+API errors expose bounded `status_code`, `code`, `message`, `details`, `request_id` and
+`operation_id`. They never retain raw bodies or headers.
+
+## Sensitive values
+
+STS keys, Webhook secrets and signed download URLs use `SensitiveStr`. `str` and `repr` are
+redacted; revealing a value requires the explicit `get_secret_value()` method. Never log the
+revealed value.
+
+## Lifecycle, timeout and retry
+
+SDK-created HTTP clients close on context exit. Injected `httpx` clients remain caller-owned and
+must be closed by the caller. Redirects are always disabled. Injected proxies and event hooks are
+also caller-owned; the SDK cannot sanitize logging performed by them.
+
+```python
+from pointcosm import RetryPolicy, TimeoutConfig
+
+timeout = TimeoutConfig(connect=5, read=30, write=30, pool=5)
+retry = RetryPolicy(max_attempts=3, max_elapsed=10)
+```
+
+Retry is disabled by default. When explicitly enabled, only operations whose reviewed manifest
+metadata says `retry=safe` can retry timeout/connect failures or HTTP 429/502/503/504. Mutation,
+secret, authentication, business and contract failures never retry.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE). The license does not grant permission to use
+PointCosm trade names, trademarks, service marks or product names except as described by the
+license.