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.

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.2.21

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.2.21
File	Size	Uploaded
zmqruntime-0.2.21.tar.gz	111.2 kB	Sep 17, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for zmqruntime 0.2.21
File	Interpreter	ABI	Platform	Reset
zmqruntime-0.2.21-py3-none-any.whl 83.2 kB Sep 17, 2026	Python 3	none	any	Details

Total release size: 194.4 kB

Release files / zmqruntime-0.2.21.tar.gz

Download URL	zmqruntime-0.2.21.tar.gz
Size	111.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`4f4846da21a866453268b0d3fecb22601fbeb9576260aad8996173ee6924b0e8`
BLAKE2b-256 checksum How to use checksums	`9b34b62f243dc8a22d02fbdc3c06a7b7dc36360194c0c17a7300fa65c997e778`
Upload date	Sep 17, 2026
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.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/OpenHCSDev/ZMQRuntime
Publishing commit: github.com/OpenHCSDev/ZMQRuntime/tree/1fe63de559a11a1ca0bf560d820e0915f29f1c2e

Workflow

Publishing configuration: github.com/OpenHCSDev/ZMQRuntime/blob/1fe63de559a11a1ca0bf560d820e0915f29f1c2e/.github/workflows/publish.yml
Publishing logs: github.com/OpenHCSDev/ZMQRuntime/actions/runs/35268443212/attempts/1

Artifact

Subject: zmqruntime-0.2.21.tar.gz
SHA-256 checksum: 4f4846da21a866453268b0d3fecb22601fbeb9576260aad8996173ee6924b0e8 Verifying attestations

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

Download URL	zmqruntime-0.2.21-py3-none-any.whl
Size	83.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4f67232aed1d3d395ad2fd1b5b593d55f881e760c02dfa65ed4fb32cd6aa8ee0`
BLAKE2b-256 checksum How to use checksums	`eb80d53854167476cdb97a921643edc35cb4351b20ba308cb6f25bc5a43f41ce`
Upload date	Sep 17, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/OpenHCSDev/ZMQRuntime
Publishing commit: github.com/OpenHCSDev/ZMQRuntime/tree/1fe63de559a11a1ca0bf560d820e0915f29f1c2e

Workflow

Publishing configuration: github.com/OpenHCSDev/ZMQRuntime/blob/1fe63de559a11a1ca0bf560d820e0915f29f1c2e/.github/workflows/publish.yml
Publishing logs: github.com/OpenHCSDev/ZMQRuntime/actions/runs/35268443212/attempts/1

Artifact

Subject: zmqruntime-0.2.21-py3-none-any.whl
SHA-256 checksum: 4f67232aed1d3d395ad2fd1b5b593d55f881e760c02dfa65ed4fb32cd6aa8ee0 Verifying attestations