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

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.19
File	Size	Uploaded
zmqruntime-0.2.19.tar.gz	108.3 kB	Aug 27, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for zmqruntime 0.2.19
File	Interpreter	ABI	Platform	Reset
zmqruntime-0.2.19-py3-none-any.whl 81.5 kB Aug 27, 2026	Python 3	none	any	Details

Total release size: 189.8 kB

Release files / zmqruntime-0.2.19.tar.gz

Download URL	zmqruntime-0.2.19.tar.gz
Size	108.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`0c7bb659ae6b3c95b68cb939d913567d74ff7dde4849525f5ee974ee1b129e7c`
BLAKE2b-256 checksum How to use checksums	`876b87604301831c888de6b34c62b2a452777de8f8013450752e986dd8f7a17c`
Upload date	Aug 27, 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/a3e8c06b7b086badf9737fc1d0663ce433fedf66

Workflow

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

Artifact

Subject: zmqruntime-0.2.19.tar.gz
SHA-256 checksum: 0c7bb659ae6b3c95b68cb939d913567d74ff7dde4849525f5ee974ee1b129e7c Verifying attestations

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

Download URL	zmqruntime-0.2.19-py3-none-any.whl
Size	81.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`955dddc1911f33eac542148ce85b098122e42094e4fa4c95e9d91ca4a0e3c9b7`
BLAKE2b-256 checksum How to use checksums	`b7196d13e31a1fd2cacec2a3b1016f7fd4b73ebb3d3fbc70da3481a71fbcaad0`
Upload date	Aug 27, 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/a3e8c06b7b086badf9737fc1d0663ce433fedf66

Workflow

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

Artifact

Subject: zmqruntime-0.2.19-py3-none-any.whl
SHA-256 checksum: 955dddc1911f33eac542148ce85b098122e42094e4fa4c95e9d91ca4a0e3c9b7 Verifying attestations