Skip to content

README.md

Latest commit

 

History

History
71 lines (42 loc) · 3.77 KB

README.md

File metadata and controls

71 lines (42 loc) · 3.77 KB
Raw

CoreLink Python SDK

Maturity: Prerelease Alpha
Package metadata: corelink-sdk 0.1.0.dev0
Python: >=3.9
Public contract: corelink-public-v1.yaml 1.0.0-draft

Generated Python client for the CoreLink Public API. The package source exists, but CoreLink does not yet claim a production-supported PyPI/Stable release. Public license/support policy and sandbox/runtime conformance remain release gates.

What is currently covered

The generated client follows the current reviewed public contract, whose primary public slice is Device + Command. Broader telemetry/location/partner/event behavior remains contract- and acceptance-gated.

Build/verify from source

Create a Python 3.9+ environment and install the repository requirements/package using your normal isolated Python workflow. For a basic generated-source verification:

python -m compileall corelink_sdk

This is a prerelease source workflow, not a claim that a Stable public package is published.

Authentication and tenant context

The current public API uses Bearer JWT authentication and explicit tenant-scoped paths. Obtain credentials through the approved CoreLink environment/onboarding boundary; do not invent a token endpoint from SDK internals.

Use least-privilege credentials, keep tenant context explicit, and avoid logging credentials or sensitive customer payloads.

Devices and commands

Public device identity is corelink_device_id. Provider-specific IDs remain internal implementation details.

Command creation is asynchronous and idempotency-aware. Retrying the same logical command must preserve the original Idempotency-Key; an accepted POST does not prove that the physical device executed the command.

Because this package is generated/prerelease, exact generated class and method names may change. Use the generated source/type hints for the pinned revision instead of relying on undocumented wrapper APIs.

Errors and retries

Follow the OpenAPI problem/error definitions. Validation/auth/authorization failures should not be blindly retried. Preserve correlation/request identifiers needed for diagnosis and reconcile uncertain writes before creating a second logical operation.

Contract provenance

Generation provenance is recorded in .corelink-contract.json and CODEGEN.md. Existing prerelease metadata references a development source revision; supported releases must use immutable/tagged contract provenance.

Regeneration

Generated files under corelink_sdk/ are not hand-maintained. Change normative schemas in CoreLinkPlatform/api-contracts, regenerate deterministically, then review the generated diff.

License and publication gate

Current package metadata declares LicenseRef-Proprietary. Public repository visibility is not an open-source license. The applicable organization license/support policy must be explicitly resolved before supported public package publication.

Release gates

Before a supported package release:

  • license/support policy is accepted;
  • contract provenance is immutable/version-identifiable;
  • generation/build is reproducible;
  • auth/tenant/error/retry behavior matches the contract;
  • conformance passes against an accepted mock/sandbox/runtime revision;
  • release provenance/signing/documentation gates pass.

Backlog: PY-01, PY-02, PY-03.

Documentation