Skip to main content

ZMQRuntime

Generic ZeroMQ transport, lifecycle, progress, cancellation, viewer-control, and execution-projection primitives.

Important boundary

ZMQServer and ZMQClient are abstract application integration points. They cannot be instantiated directly:

  • a server implements handle_control_message and handle_data_message;
  • a client implements _spawn_server_process and send_data.

The package does not provide a generic send_request API or define an application's execution payload. Applications subclass the bases and map their typed domain requests onto the transport.

Transport configuration

from zmqruntime import TransportMode, ZMQConfig
from zmqruntime.transport import get_zmq_transport_url

config = ZMQConfig(control_port_offset=1000)
data_url = get_zmq_transport_url(
    7777,
    host="localhost",
    mode=TransportMode.TCP,
    config=config,
)

Application subclasses can use serve_forever, readiness probes, control port helpers, progress records, cancellation messages, lifecycle engines, and projection adapters without duplicating socket or process machinery.

Execution completion

Execution clients with a registered progress subscription wake on the server's terminal ExecutionStatusSnapshot. The existing callback sequence barrier still waits for every admitted progress callback. Registration replays the latest progress and terminal record; a missing terminal notification recovers through STATUS using the configured wait interval. Clients without progress registration continue to use STATUS.

Applications that enrich successful results override ExecutionServer.finalize_execution_record(record). This record-only hook runs under the lifecycle lock after task completion and before STATUS or terminal publication can observe the record. It must not publish progress or acquire transport resources. The task's recorded end time retains its existing boundary. Already admitted progress is published before the terminal record; new progress admissions after a terminal transition are discarded.

Installation

python -m pip install zmqruntime

Documentation: zmqruntime.readthedocs.io.

For local development, install the documentation dependencies and run a clean, warning-fatal build:

python -m pip install -e ".[dev,docs]"
python -m sphinx -E -W --keep-going -b html docs/source docs/_build/html

Repository: OpenHCSDev/ZMQRuntime.

Metadata

Release files for zmqruntime 0.6.6

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

Source distribution (sdist)

Source distribution for zmqruntime 0.6.6
File Size Uploaded Provenance Actions
zmqruntime-0.6.6.tar.gz 728.5 kB With provenance Details for zmqruntime-0.6.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for zmqruntime 0.6.6
File Interpreter ABI Platform Actions
zmqruntime-0.6.6-py3-none-any.whl Python 3 none any Details for zmqruntime-0.6.6-py3-none-any.whl

Total release size: 827.6 kB

Release files / zmqruntime-0.6.6.tar.gz

Download URL zmqruntime-0.6.6.tar.gz
Size 728.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7d887e06bcac16de6da73dad3a0724ea1c7cfff0be63ed895b6704a7196a70be
BLAKE2b-256 checksum
How to use checksums
207ee1c98ab8c240a912cc5abf4a9d4810020a448b09637f42b175a66b0cc9c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

Release files / zmqruntime-0.6.6-py3-none-any.whl

Download URL zmqruntime-0.6.6-py3-none-any.whl
Size 99.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8c9ab03a9ff4f6c1ca6f8a7ae54e4f48d36f8749a2fc5d1a7e54ff72b0c3a0eb
BLAKE2b-256 checksum
How to use checksums
ea1ec0a609491b6b3cb0686bd80c7a41b6e2ece50a06dc293840045c8c8a4e1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Nov 17, 2026.

Transparency log

Security for zmqruntime 0.6.6

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 zmqruntime-0.6.6.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 Nov 17, 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.6.6 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