colca-data-contracts
The payload contracts that Colca nodes and the services around them agree on, written as Python dataclasses on top of franzmq.
The package contains
- one class per contract (
_Metric,_Signal,_SystemElement,_CmdParam, …) with encoding, decoding and validation, - topic helpers that put the publishing node and the configured topic root
into every topic (
node_topic,COLCA_TOPIC_ROOT), - the builtin data models, semantic tags and metadata types,
- the generator for the schema bundle that nodes enforce
(
scripts/generate_bundle.py), - golden vectors in
src/colca_data_contracts/vectors/, which the Go tests of this repository read as well, so both sides answer the same cases.
Use
pip install ./contracts
from colca_data_contracts import node_topic
from colca_data_contracts.payload import Metric
topic = node_topic(Metric, "line1", "press3", "temp") # colca/v1/_Metric/<NODE_ID>/line1/press3/temp
NODE_ID names the node the process publishes under; COLCA_TOPIC_ROOT
changes the first segment from colca.
Develop
make contracts-test # from the repository root
make bundle # writes build/bundle/contracts-bundle.json
1 maintainer
Metadata
1 maintainer
Release files for colca-data-contracts 0.18.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| colca_data_contracts-0.18.2.tar.gz | 83.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| colca_data_contracts-0.18.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.1 kB
Release files / colca_data_contracts-0.18.2.tar.gz
| Download URL | colca_data_contracts-0.18.2.tar.gz |
|---|---|
| Size | 83.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ee14237699f90c0ce485408899a676b0960c43f6be75300fb6c5a16a8c60035a
|
|
BLAKE2b-256 checksum How to use checksums |
fc569121fb9a72637663b2ee5959880baed1c28a4fa2e20d590747f6c4bbc9f7
|
| 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 26, 2026.
Transparency logRelease files / colca_data_contracts-0.18.2-py3-none-any.whl
| Download URL | colca_data_contracts-0.18.2-py3-none-any.whl |
|---|---|
| Size | 66.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
599d122761d5d321c5b1ddd8818728c67a73c534eb17ded7f98f8a65e0996899
|
|
BLAKE2b-256 checksum How to use checksums |
627e12ed1d7375f1de78b46bb70afd8d9ce5e4f0311dc7db39c288dd96aab22f
|
| 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 26, 2026.
Transparency log
