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 — Connector
analitiq.contracts.connection — ConnectionInput
analitiq.contracts.endpoints — ApiEndpointDoc, DatabaseEndpointDoc, DatabaseObject
analitiq.contracts.type_map — TypeMapReadDoc, TypeMapWriteDoc
analitiq.contracts.stream — StreamInput (+ the endpoint refs)
analitiq.contracts.pipelines.config — PipelineInput
analitiq.contracts.credentials_file — CredentialsFile
analitiq.contracts.endpoint_identity — derive_db_endpoint_id
analitiq.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.

Metadata

Release files for analitiq-contract-models 1.0.0rc12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for analitiq-contract-models 1.0.0rc12
File	Size	Uploaded
analitiq_contract_models-1.0.0rc12.tar.gz	106.9 kB	Jul 20, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for analitiq-contract-models 1.0.0rc12
File	Interpreter	ABI	Platform	Reset
analitiq_contract_models-1.0.0rc12-py3-none-any.whl 115.7 kB Jul 20, 2026	Python 3	none	any	Details

Total release size: 222.7 kB

Release files / analitiq_contract_models-1.0.0rc12.tar.gz

Download URL	analitiq_contract_models-1.0.0rc12.tar.gz
Size	106.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`e7c0981efe15280a3ba395a4cee2e84b9da038725d3d2c1111595a40f76c4674`
BLAKE2b-256 checksum How to use checksums	`61a9adf0afd3ad36454da2fb4998862d975e69e4b8e86d9cdbeaedbaace09886`
Upload date	Jul 20, 2026
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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/analitiq-ai/infrastructure
Publishing commit: github.com/analitiq-ai/infrastructure/tree/2134bd1b1b58c643df319058c3a083806867dde2

Workflow

Publishing configuration: github.com/analitiq-ai/infrastructure/blob/2134bd1b1b58c643df319058c3a083806867dde2/.github/workflows/contract-models-release.yml
Publishing logs: github.com/analitiq-ai/infrastructure/actions/runs/29767223375/attempts/1

Artifact

Subject: analitiq_contract_models-1.0.0rc12.tar.gz
SHA-256 checksum: e7c0981efe15280a3ba395a4cee2e84b9da038725d3d2c1111595a40f76c4674 Verifying attestations

Release files / analitiq_contract_models-1.0.0rc12-py3-none-any.whl

Download URL	analitiq_contract_models-1.0.0rc12-py3-none-any.whl
Size	115.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b73e2f560e48bf7523f1a32392c9d64fa34b2c1d36019d75f8f8615e8716802b`
BLAKE2b-256 checksum How to use checksums	`350954bc05354723c0c42bde639ffd2191c40e431d980b41f5f1fdd5ff8b09fa`
Upload date	Jul 20, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/analitiq-ai/infrastructure
Publishing commit: github.com/analitiq-ai/infrastructure/tree/2134bd1b1b58c643df319058c3a083806867dde2

Workflow

Publishing configuration: github.com/analitiq-ai/infrastructure/blob/2134bd1b1b58c643df319058c3a083806867dde2/.github/workflows/contract-models-release.yml
Publishing logs: github.com/analitiq-ai/infrastructure/actions/runs/29767223375/attempts/1

Artifact

Subject: analitiq_contract_models-1.0.0rc12-py3-none-any.whl
SHA-256 checksum: b73e2f560e48bf7523f1a32392c9d64fa34b2c1d36019d75f8f8615e8716802b Verifying attestations