Skip to main content

orditect-protocol

Storage interaction contracts for the Orditect ecosystem

Python 3.12+

orditect-protocol is the connection contract between the Orditect frameworks and storage backends. It defines what is stored and how it is retrieved — never how a backend implements it.

It is the layer that lets orditect-core / orditect-flow / orditect-stream store content, audit events, results, and execution snapshots against one contract, and lets any backend (PostgreSQL, MinIO, Milvus, memory, local JSON, ...) plug in by implementing the same contract.

Position in the Orditect ecosystem

orditect-core / orditect-flow / orditect-stream
        |  store & query via this contract
        v
orditect-protocol        <-- THIS PACKAGE (contracts only, zero implementation)
        |  implemented by
        v
storage adapters: orditect-adapter-memory (open, reference) /
                  PostgreSQL / MinIO / Milvus / ... (commercial)

The governance hot path is deliberately NOT here. Semaphores, token buckets, quotas, task state, and the lineage hot index live in orditect-core, pinned to Redis (millisecond-sensitive, Lua-atomic). This package governs only the content side: where content, snapshots, audit, and results go.

Boundary discipline (red lines)

  1. Zero implementation — contracts and models only; no storage logic.
  2. Zero Redis dialect — no ZSET / Lua / TTL keywords in any signature or docstring; terms speak of leases, terminal states, idempotency keys.
  3. Zero business semantics — no WHERE-style business query DSL; only mechanism fields (time range, pagination, status-as-opaque-string).

The five domains

Each domain is a narrow sink/query protocol pair. An implementation declares the half-domains it supports via CapabilitySet; the rest must raise UnsupportedCapabilityError (never silently no-op, term T8).

Domain Sink Query Purpose
Content ContentWriter ContentReader Pointer-ized content bodies (all modalities)
Audit AuditWriter AuditReader Append-only idempotent event log
Result ResultWriter ResultReader Stream manifests with true TTL
Snapshot SnapshotWriter SnapshotReader Execution snapshots + tree/version queries
Dependency DependencyWriter DependencyReader Pure-edge dependency facts + graph queries (T12)

Consistency terms

Twelve normative terms (lease model, terminal irreversibility, idempotency, pointer discipline, vocabulary neutrality, clock discipline, explicit capability, observation non-blocking, concurrency atomicity, execution identity alignment, cross-media alignment) are frozen in docs/terms.md. Every protocol method's docstring references the terms it enforces.

Implementing against the contract

Three implementation shapes, three compliance tiers:

Storage backend (full)

Implement the half-domains you support, structured as per-domain parts (see orditect-adapter-memory for the reference structure), declare them in a CapabilitySet — sink and query in pairs — and certify:

from orditect.protocol.conformance import run_conformance

def test_conformance():
    report = run_conformance(my_store.snapshot, profile="full")
    assert report.eligibility_error is None
    assert report.failed == 0, report.summary()

Bridge / external-framework producer (producer)

A bridge only needs to write correctly: implement the sink half-domains (snapshot_sink + audit_sink is a typical start, plus dependency_sink when wiring dependency governance) and certify under the producer tier:

report = run_conformance(my_bridge, profile="producer")
assert report.failed == 0, report.summary()

Business vocabulary of the external framework is translated to opaque strings at the bridge edge — never flowing back into any framework package (see docs/bridge-discipline.md).

Read-only consumer (consumer)

Visualization / diagnostics tools implement the query half-domains and, for deep read verification, the seed() hook:

report = run_conformance(my_viewer, profile="consumer")
assert report.failed == 0, report.summary()

Passing the kit under the appropriate tier is the only compatibility certification. Undeclared half-domains skip, never fail (T8).

Versioning

Independent version line. Terms changes are minor/major bumps with a CHANGELOG entry. The 1.0 freeze requires a second real backend (a production relational adapter) passing the full conformance kit.

License

Apache-2.0

Metadata

Release files for orditect-protocol 0.1.7

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

Source distribution (sdist)

Source distribution for orditect-protocol 0.1.7
File Size Uploaded Provenance Actions
orditect_protocol-0.1.7.tar.gz 38.6 kB With provenance Details for orditect_protocol-0.1.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for orditect-protocol 0.1.7
File Interpreter ABI Platform Actions
orditect_protocol-0.1.7-py3-none-any.whl Python 3 none any Details for orditect_protocol-0.1.7-py3-none-any.whl

Total release size: 91.2 kB

Release files / orditect_protocol-0.1.7.tar.gz

Download URL orditect_protocol-0.1.7.tar.gz
Size 38.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0b90dff0186acd425f0991736e685ccfdba4e24e93103c7828f3bc8bd99ead20
BLAKE2b-256 checksum
How to use checksums
058b3247939a1b9c6b5b71ab9a70192fa338a4647f27af91d0fa65fd02f9c939
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.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 Sep 22, 2026.

Transparency log

Release files / orditect_protocol-0.1.7-py3-none-any.whl

Download URL orditect_protocol-0.1.7-py3-none-any.whl
Size 52.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f539a72627143caa708f409c1992ddfe44849b6b0d42e67ca452c06850854060
BLAKE2b-256 checksum
How to use checksums
74aca8940c906909cc905c403602cec8bc9a1f8f3d2a144fe79ae620bd157072
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.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 Sep 22, 2026.

Transparency log

Security for orditect-protocol 0.1.7

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for orditect_protocol-0.1.7.tar.gz

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 Sep 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.7 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page