Skip to main content

Kinemica Verify

CI PyPI Python 3.10+ License

Open-source verification infrastructure for physical-world work performed by people, agents, and machines.

Kinemica Verify turns a machine-readable Work Contract and collected evidence into a deterministic pass/fail result. It can bind that result to the exact contract, evidence manifest, and file-backed evidence with SHA-256, then authenticate the resulting record with an Ed25519 signature.

v0.3 adds a deterministic execution-trace ingestion layer so operational systems can generate verification evidence from an ordered event stream instead of hand-authoring manifest.yaml.

Install

python -m pip install kinemica-verify

Kinemica Verify requires Python 3.10 or newer.

Verify structured evidence

kinemica verify work.yaml evidence/

Expected result:

Kinemica Verify

Preconditions               PASS
Required steps              PASS
Safety constraints          PASS
Evidence                    PASS
Final state                 PASS

VERIFIED

The CLI exits with 0 for a verified job, 1 for a failed verification, and 2 for invalid input or configuration. Add --json to verification commands for machine-readable output.

Ingest an execution trace

Kinemica Execution Trace v1 is a JSON Lines event stream. Each event has a strictly increasing sequence, a kind, and a name. Events can represent preconditions, completed steps, measurements, artifacts, and final state.

{"version":1,"sequence":1,"kind":"precondition","name":"machine_powered_down","value":true}
{"version":1,"sequence":2,"kind":"step","name":"remove_old_filter"}
{"version":1,"sequence":3,"kind":"measurement","name":"max_force_n","value":31.8}
{"version":1,"sequence":4,"kind":"artifact","name":"before_image","path":"before_image.jpg"}
{"version":1,"sequence":5,"kind":"final_state","name":"system_test_passed","value":true}

Put the trace and any referenced files inside the evidence directory, then generate the manifest:

kinemica ingest-trace evidence/trace.jsonl evidence/
kinemica verify work.yaml evidence/

If manifest.yaml already exists, ingestion refuses to overwrite it unless --force is supplied.

The generated manifest automatically includes the source trace as the execution_trace file-backed artifact. Signed verification records therefore bind the exact trace bytes along with other file-backed evidence.

See docs/execution-traces.md for the event format, deterministic conversion rules, and trust boundary.

What it checks

Check Purpose
Preconditions Required state before work starts
Required steps Whether every mandated step is present in the evidence
Safety constraints Numeric limits such as force, torque, temperature, or other measured values
Evidence Whether required evidence exists and file-backed evidence stays inside the evidence boundary
Final state Whether the resulting state matches the contract

The same verification model can describe work performed by a person, robot, software agent, or mixed team.

Work Contract

A Work Contract states what must be true before, during, and after a job.

version: 1

task:
  id: replace-filter
  actor: robot

preconditions:
  machine_powered_down: true

required_steps:
  - remove_old_filter
  - install_new_filter
  - secure_cover

constraints:
  max_force_n:
    op: lte
    value: 40

evidence:
  required:
    - before_image
    - replacement_serial
    - installation_image
    - torque_reading
    - final_system_test

final_state:
  system_test_passed: true

Signed verification records

Generate an Ed25519 key pair:

kinemica keygen \
  --private-key signer.private.pem \
  --public-key signer.public.pem

Create a signed record while verifying a job:

kinemica verify \
  work.yaml \
  evidence/ \
  --signing-key signer.private.pem \
  --record verification.json

Authenticate the record and re-check its original inputs:

kinemica verify-record \
  verification.json \
  signer.public.pem \
  --contract work.yaml \
  --evidence evidence/

A signed record binds:

  • the exact Work Contract bytes
  • the exact Evidence Manifest bytes
  • every valid file-backed evidence artifact
  • task identity
  • the complete deterministic verification result
  • the signer public-key fingerprint

Verification records contain no implicit timestamp or random nonce, so identical inputs signed with the same key produce the same record.

See docs/verification-records.md for the record format and trust boundary.

Data flow

physical-world task
        |
        v
   Work Contract
        |
        v
person / robot / agent
        |
        v
 execution trace / evidence
        |
        v
 Kinemica Verify
        |
        +--> VERIFIED / NOT VERIFIED
        |
        +--> signed verification record

Execution-system adapters can translate telemetry, robot logs, ROS 2 messages, inspection outputs, or enterprise-system events into Execution Trace v1 while leaving the verification core unchanged.

Current scope

v0.3 verifies structured evidence and can deterministically derive Evidence Manifest v1 from a structured JSON Lines execution trace. It does not infer completion from images or video and does not yet decode ROS 2 bags or raw sensor streams directly.

VERIFIED means the supplied evidence satisfies the configured Work Contract. SIGNED RECORD VALID means the record is authentic for the supplied public key and, when source paths are provided, the bound inputs still match. These results do not prove unobserved physical reality, replace independent safety engineering, or constitute regulatory certification.

Design principles

  • Explicit contracts: completion criteria are machine-readable and reviewable before work starts.
  • Deterministic verification: the same contract and evidence produce the same result.
  • Evidence first: failures identify which requirement was not satisfied.
  • Cryptographic provenance: signed records bind results to exact source files and artifacts.
  • Actor agnostic: the same model works across people, robots, agents, and mixed teams.
  • Composable ingestion: execution-system adapters can feed a stable event format.
  • Local by default: the open-source verifier does not require a hosted service.

Repository layout

src/kinemica_verify/    Verifier, trace ingestion, signing, and CLI
examples/               Complete example jobs, traces, and evidence
schemas/                Public interchange schemas
docs/                   Format and trust-boundary documentation
tests/                  Verification, trace, integrity, signing, and CLI tests

Development

python -m pip install -e ".[dev]"
ruff check .
pytest

CI runs installation, lint, tests, deterministic trace-to-manifest regeneration, the reference verification, a full signed-record round trip, and a clean wheel installation on supported Python versions.

Roadmap

  1. Add a reference ROS 2 rosbag2/MCAP adapter that emits Execution Trace v1.
  2. Add reproducible benchmarks for physical-work verification failures.
  3. Add reference adapters for agent/tool execution logs and industrial telemetry.
  4. Add pluggable evidence attestations without weakening deterministic local verification.
  5. Stabilize the public interchange formats based on real integrations and external use.

Compatibility and verification semantics take priority over feature count.

Contributing

See CONTRIBUTING.md. Security issues should follow SECURITY.md.

Maintainer

Created and maintained by Sylvester Kaczmarek.

License

Apache License 2.0. See LICENSE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kinemica_verify-0.3.0.tar.gz (25.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kinemica_verify-0.3.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file kinemica_verify-0.3.0.tar.gz.

File metadata

  • Download URL: kinemica_verify-0.3.0.tar.gz
  • Upload date:
  • Size: 25.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kinemica_verify-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5b1bc0346c12e6b7890ab9c9823c5fad50da599de77786fd99512026772d8457
MD5 0d256f398f1a3981b49d87dca5d5d9e5
BLAKE2b-256 bc8b4bbaed53265b0157f1f29d0e1e1ec062fc5be722880717854df803a33910

See more details on using hashes here.

Provenance

The following attestation bundles were made for kinemica_verify-0.3.0.tar.gz:

Publisher: publish-to-pypi.yml on kinemica/kinemica-verify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kinemica_verify-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: kinemica_verify-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 24.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for kinemica_verify-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9004d865a7e5802646a5c502343d16c40d10261bb40ca4f0ef3d1bd945446ec
MD5 b9df62f276f59170622fcbd21f939b6c
BLAKE2b-256 681c6f45d635a53bad8d863e5f5ce9c31b1ba26f7fa753b7a8741910d39cdc1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for kinemica_verify-0.3.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on kinemica/kinemica-verify

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 files

0.2.1

2 files

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