zigmq 0.1.0

A tiny, pythonic SDK for the ZigMQ text protocol.

zigMQ Python SDK

zigmq is a tiny, pythonic SDK for the ZigMQ text protocol.

By default, the SDK connects to 127.0.0.1:8388.

The goal of this SDK is deliberately narrow:

• one small sync client for queue/admin commands
• one dedicated subscriber client for pub/sub delivery
• no dependency, no ORM-style abstraction, no magic reconnect layer
• protocol-compatible with the current ZigMQ server behavior

Install

pip install zigmq

Local development:

cd zigMQ-python-SDK
pip install -e .
python -m unittest -v

Quick Start

from zigmq import Client

with Client() as mq:
    mq.send("jobs", "hello world")
    print(mq.recv("jobs"))

Pub/Sub:

from zigmq import Client, Subscriber

with Subscriber() as sub:
    sub.subscribe("news")

    with Client() as mq:
        delivered = mq.publish("news", "shipped")
        print(delivered)

    event = sub.get()
    print(event.topic, event.message)

API

Client

• ping() -> str
• info() -> Info
• send(queue, message) -> None
• recv(queue) -> str
• recv_bytes(queue) -> bytes
• peek(queue) -> str
• peek_bytes(queue) -> bytes
• queue_length(queue) -> int
• create_queue(queue) -> None
• list_queues() -> list[str]
• publish(topic, message) -> int
• list_topics() -> dict[str, int]
• subscriber(*topics) -> Subscriber

Short protocol-style aliases are also available: mq, len, queues, pub, topics.

Subscriber

• subscribe(*topics) -> None
• unsubscribe(*topics) -> None
• get(timeout=None) -> Event
• iteration support: for event in sub: ...

Design Notes

• This SDK is text-first, because ZigMQ itself is a line-based text protocol.
• The default connection target is 127.0.0.1:8388.
• Queue/topic names cannot contain whitespace or line breaks.
• Message bodies can contain spaces, but cannot contain \\r or \\n.
• queues, topics, and info follow the current ZigMQ server behavior and are parsed from multi-line responses.

Publish To PyPI

Update version in pyproject.toml, then:

cd zigMQ-python-SDK
python -m build
twine upload dist/*