This release is a pre-release and may not be stable for production use.
analitiq-contract-models
The Analitiq authored contract models (Pydantic) — the write/input shapes for
connectors, connections, endpoints, type-maps, streams, and pipelines. These are
the single source of truth the published JSON Schemas (schemas.analitiq.ai) are
generated from, packaged so the validator and the pipeline engine can
validate documents against the contract directly (model_validate) instead
of re-implementing its cross-field rules.
Install & use
pip install analitiq-contract-models
from analitiq.contracts.endpoints import ApiEndpointDoc
from pydantic import ValidationError
try:
ApiEndpointDoc.model_validate(doc) # structural + cross-field, offline
except ValidationError as exc:
... # every contract rule, enforced from the one source
Importing needs no environment: the package defaults DOMAIN to the public
contract host (analitiq.ai) before the models load.
What it ships
Analitiq's public contract surface — nothing internal.
The authored contract: the documents you write and Analitiq validates.
analitiq.contracts.connector—Connectoranalitiq.contracts.connection—ConnectionInputanalitiq.contracts.endpoints—ApiEndpointDoc,DatabaseEndpointDoc,DatabaseObjectanalitiq.contracts.type_map—TypeMapReadDoc,TypeMapWriteDocanalitiq.contracts.stream—StreamInput(+ the endpoint refs)analitiq.contracts.pipelines.config—PipelineInputanalitiq.contracts.credentials_file—CredentialsFileanalitiq.contracts.endpoint_identity—derive_db_endpoint_idanalitiq.contracts.shared— the shared building blocks those embed
The API contract: the request/response shapes of the public REST API.
analitiq.contracts.pipelines.data_sync— Data Sync API:PipelineRunRequest, the run/terminate/status responses, and the public run vocabulary (PublicRunStatus,PublicErrorCode)
Both are shape and rules only. Nothing here knows how Analitiq runs a pipeline,
stores a run, or names a state internally — those live server-side and depend on
this package, never the reverse. Internal persistence/catalog variants
(*Document/*Config/*Patch/*Read, resolved-connector/catalog shapes,
auth-state) are not included.
analitiq is a PEP 420 namespace shared with
analitiq-validator.
Source of truth
These modules are the canonical Analitiq contract models — not a copy of them, and not rendered from one. The published JSON Schemas are generated from the same files, so the schemas and this package cannot drift: there is only one definition to drift from.
Versioning
analitiq-contract-models is a strict validator (extra=forbid, closed enums), so
version bumps are coordinated: a consumer on an older minor rejects a newly-added
field a producer emits. See the publishing/versioning notes in the source repo for
the major/minor/patch semantics and the consumer rollout rule.
1 maintainer
Metadata
1 maintainer
Release files for analitiq-contract-models 1.0.0rc17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| analitiq_contract_models-1.0.0rc17.tar.gz | 120.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| analitiq_contract_models-1.0.0rc17-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 250.3 kB
Release files / analitiq_contract_models-1.0.0rc17.tar.gz
| Download URL | analitiq_contract_models-1.0.0rc17.tar.gz |
|---|---|
| Size | 120.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
91e07ad67fba3c9c944a4b9d444b2c94226aea12d8390748822cfc48e669c845
|
|
BLAKE2b-256 checksum How to use checksums |
6eae232df0beee49966065f555e3d4e962d29784f438c89027bdf1b86b9ae8d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 25, 2026.
Transparency logRelease files / analitiq_contract_models-1.0.0rc17-py3-none-any.whl
| Download URL | analitiq_contract_models-1.0.0rc17-py3-none-any.whl |
|---|---|
| Size | 130.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b243cd8bdd6d05268776b8c29092f325656224ccd13db2640f0e99b83d306d69
|
|
BLAKE2b-256 checksum How to use checksums |
705d2417f2d46f08a13c7e6b3f6315d9bf781a6fd4c1f3daed92577c0ea80cb0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 25, 2026.
Transparency log
