zigmq 0.1.0__tar.gz

zigmq-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

zigmq-0.1.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: zigmq
+Version: 0.1.0
+Summary: A tiny, pythonic SDK for the ZigMQ text protocol.
+Author: reasonz
+Project-URL: Homepage, https://github.com/reasonz/zigMQ-python-SDK
+Project-URL: Repository, https://github.com/reasonz/zigMQ-python-SDK
+Keywords: zigmq,queue,pubsub,messaging
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# zigMQ Python SDK
+
+`zigmq` is a tiny, pythonic SDK for the [ZigMQ](https://github.com/reasonz/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
+
+```bash
+pip install zigmq
+```
+
+Local development:
+
+```bash
+cd zigMQ-python-SDK
+pip install -e .
+python -m unittest -v
+```
+
+## Quick Start
+
+```python
+from zigmq import Client
+
+with Client() as mq:
+    mq.send("jobs", "hello world")
+    print(mq.recv("jobs"))
+```
+
+Pub/Sub:
+
+```python
+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](./pyproject.toml), then:
+
+```bash
+cd zigMQ-python-SDK
+python -m build
+twine upload dist/*
+```

zigmq-0.1.0/README.md

@@ -0,0 +1,97 @@
+# zigMQ Python SDK
+
+`zigmq` is a tiny, pythonic SDK for the [ZigMQ](https://github.com/reasonz/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
+
+```bash
+pip install zigmq
+```
+
+Local development:
+
+```bash
+cd zigMQ-python-SDK
+pip install -e .
+python -m unittest -v
+```
+
+## Quick Start
+
+```python
+from zigmq import Client
+
+with Client() as mq:
+    mq.send("jobs", "hello world")
+    print(mq.recv("jobs"))
+```
+
+Pub/Sub:
+
+```python
+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](./pyproject.toml), then:
+
+```bash
+cd zigMQ-python-SDK
+python -m build
+twine upload dist/*
+```

zigmq-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "zigmq"
+version = "0.1.0"
+description = "A tiny, pythonic SDK for the ZigMQ text protocol."
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+  { name = "reasonz" },
+]
+keywords = ["zigmq", "queue", "pubsub", "messaging"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Communications",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/reasonz/zigMQ-python-SDK"
+Repository = "https://github.com/reasonz/zigMQ-python-SDK"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

zigmq-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

zigmq-0.1.0/src/zigmq/__init__.py

@@ -0,0 +1,28 @@
+from .client import Client, Subscriber
+from .errors import (
+    ConnectionClosedError,
+    EmptyError,
+    ProtocolError,
+    QueueFullError,
+    QueueNotFoundError,
+    ServerError,
+    TimeoutError,
+    ZigMQError,
+)
+from .models import Event, Info
+
+__all__ = [
+    "Client",
+    "ConnectionClosedError",
+    "EmptyError",
+    "Event",
+    "Info",
+    "ProtocolError",
+    "QueueFullError",
+    "QueueNotFoundError",
+    "ServerError",
+    "Subscriber",
+    "TimeoutError",
+    "ZigMQError",
+]
+

zigmq-0.1.0/src/zigmq/client.py

@@ -0,0 +1,452 @@
+from __future__ import annotations
+
+import socket
+import time
+from collections import deque
+from typing import Deque, Iterator
+
+from .errors import (
+    ConnectionClosedError,
+    EmptyError,
+    ProtocolError,
+    QueueFullError,
+    QueueNotFoundError,
+    ServerError,
+    TimeoutError,
+)
+from .models import Event, Info
+
+
+class _SocketProtocol:
+    def __init__(
+        self,
+        host: str,
+        port: int,
+        *,
+        timeout: float = 1.0,
+        idle_timeout: float = 0.08,
+        encoding: str = "utf-8",
+    ) -> None:
+        self.host = host
+        self.port = port
+        self.timeout = timeout
+        self.idle_timeout = idle_timeout
+        self.encoding = encoding
+        self.sock = socket.create_connection((host, port), timeout=timeout)
+        self.sock.settimeout(timeout)
+        self._buffer = bytearray()
+
+    def close(self) -> None:
+        try:
+            self.sock.close()
+        except OSError:
+            pass
+
+    def _send_command(self, op: str, name: str | None = None, body: str | bytes | None = None) -> None:
+        parts = [_encode_name(op)]
+        if name is not None:
+            parts.append(_encode_name(name))
+        payload = b" ".join(parts)
+        if body is not None:
+            payload += b" " + _encode_body(body, self.encoding)
+        self.sock.sendall(payload + b"\r\n")
+
+    def _read_line(self, timeout: float | None = None) -> bytes:
+        timeout = self.timeout if timeout is None else timeout
+        self.sock.settimeout(timeout)
+
+        while True:
+            index = self._buffer.find(b"\r\n")
+            if index != -1:
+                line = bytes(self._buffer[:index])
+                del self._buffer[: index + 2]
+                return line
+
+            try:
+                chunk = self.sock.recv(4096)
+            except socket.timeout as exc:
+                raise TimeoutError("timed out waiting for server response") from exc
+
+            if not chunk:
+                raise ConnectionClosedError("server closed the connection")
+
+            self._buffer.extend(chunk)
+
+    def _read_exact(self, size: int) -> bytes:
+        while len(self._buffer) < size:
+            try:
+                chunk = self.sock.recv(4096)
+            except socket.timeout as exc:
+                raise TimeoutError("timed out waiting for server response") from exc
+
+            if not chunk:
+                raise ConnectionClosedError("server closed the connection")
+
+            self._buffer.extend(chunk)
+
+        data = bytes(self._buffer[:size])
+        del self._buffer[:size]
+        return data
+
+    def _read_one(self, timeout: float | None = None) -> tuple[str, object]:
+        line = self._read_line(timeout=timeout)
+        if not line:
+            raise ProtocolError("empty server response")
+
+        prefix = line[:1]
+        payload = line[1:]
+
+        if prefix == b"$":
+            try:
+                length = int(payload.decode("ascii"))
+            except ValueError as exc:
+                raise ProtocolError(f"invalid bulk header: {line!r}") from exc
+
+            body = self._read_exact(length)
+            trailer = self._read_exact(2)
+            if trailer != b"\r\n":
+                raise ProtocolError("bulk response missing CRLF trailer")
+            return ("bulk", body)
+
+        if prefix == b"-":
+            message = _decode_text(payload, self.encoding)
+            if message.startswith("ERR "):
+                message = message[4:]
+            return ("error", message)
+
+        if prefix == b"+":
+            if b":" in payload and not payload.startswith(b"OK ") and not payload.startswith(b"ZigMQ "):
+                topic, _, body = payload.partition(b":")
+                return (
+                    "event",
+                    Event(
+                        topic=_decode_text(topic, self.encoding),
+                        message=_decode_text(body, self.encoding),
+                        data=bytes(body),
+                    ),
+                )
+            return ("status", _decode_text(payload, self.encoding))
+
+        raise ProtocolError(f"unknown response prefix: {line!r}")
+
+    def _read_until_idle(self) -> bytes:
+        chunks: list[bytes] = []
+
+        if self._buffer:
+            chunks.append(bytes(self._buffer))
+            self._buffer.clear()
+
+        deadline = time.monotonic() + self.timeout
+        while not chunks:
+            if time.monotonic() > deadline:
+                raise TimeoutError("timed out waiting for server response")
+
+            try:
+                chunk = self.sock.recv(4096)
+            except socket.timeout:
+                continue
+
+            if not chunk:
+                raise ConnectionClosedError("server closed the connection")
+
+            chunks.append(chunk)
+
+        self.sock.settimeout(self.idle_timeout)
+        while True:
+            try:
+                chunk = self.sock.recv(4096)
+            except socket.timeout:
+                break
+
+            if not chunk:
+                break
+
+            chunks.append(chunk)
+
+        self.sock.settimeout(self.timeout)
+        return b"".join(chunks)
+
+    def _request_status(self, op: str, name: str | None = None, body: str | bytes | None = None) -> str:
+        self._send_command(op, name, body)
+        kind, value = self._read_one()
+        if kind == "error":
+            _raise_server_error(str(value))
+        if kind != "status":
+            raise ProtocolError(f"expected status response, got {kind}")
+        return str(value)
+
+    def _request_bulk(self, op: str, name: str) -> bytes:
+        self._send_command(op, name)
+        kind, value = self._read_one()
+        if kind == "error":
+            _raise_server_error(str(value))
+        if kind != "bulk":
+            raise ProtocolError(f"expected bulk response, got {kind}")
+        return bytes(value)
+
+    def _request_multiline(self, op: str) -> bytes:
+        self._send_command(op)
+        return self._read_until_idle()
+
+
+class Client:
+    def __init__(
+        self,
+        host: str = "127.0.0.1",
+        port: int = 8388,
+        *,
+        timeout: float = 1.0,
+        idle_timeout: float = 0.08,
+        encoding: str = "utf-8",
+    ) -> None:
+        self._conn = _SocketProtocol(
+            host,
+            port,
+            timeout=timeout,
+            idle_timeout=idle_timeout,
+            encoding=encoding,
+        )
+        self.host = host
+        self.port = port
+        self.timeout = timeout
+        self.idle_timeout = idle_timeout
+        self.encoding = encoding
+
+    def close(self) -> None:
+        self._conn.close()
+
+    def __enter__(self) -> Client:
+        return self
+
+    def __exit__(self, exc_type: object, exc: object, tb: object) -> None:
+        self.close()
+
+    def ping(self) -> str:
+        status = self._conn._request_status("ping")
+        if status != "PONG":
+            raise ProtocolError(f"unexpected ping response: {status!r}")
+        return status
+
+    def info(self) -> Info:
+        raw = self._conn._request_multiline("info")
+        lines = _parse_listing_lines(raw)
+        if not lines or not lines[0].startswith("ZigMQ "):
+            raise ProtocolError(f"invalid info response: {raw!r}")
+
+        fields = {}
+        for line in lines[1:]:
+            key, sep, value = line.partition(":")
+            if sep != ":":
+                raise ProtocolError(f"invalid info field: {line!r}")
+            fields[key] = value
+
+        return Info(
+            banner=lines[0],
+            version=lines[0].split(" ", 1)[1],
+            queues=int(fields["queues"]),
+            topics=int(fields["topics"]),
+            initial_capacity=int(fields["initial_capacity"]),
+            max_capacity=int(fields["max_capacity"]),
+        )
+
+    def send(self, queue: str, message: str | bytes) -> None:
+        status = self._conn._request_status("send", queue, message)
+        if status != "OK":
+            raise ProtocolError(f"unexpected send response: {status!r}")
+
+    def recv_bytes(self, queue: str) -> bytes:
+        return self._conn._request_bulk("recv", queue)
+
+    def recv(self, queue: str) -> str:
+        return _decode_text(self.recv_bytes(queue), self.encoding)
+
+    def peek_bytes(self, queue: str) -> bytes:
+        return self._conn._request_bulk("peek", queue)
+
+    def peek(self, queue: str) -> str:
+        return _decode_text(self.peek_bytes(queue), self.encoding)
+
+    def queue_length(self, queue: str) -> int:
+        status = self._conn._request_status("len", queue)
+        try:
+            return int(status)
+        except ValueError as exc:
+            raise ProtocolError(f"invalid len response: {status!r}") from exc
+
+    def len(self, queue: str) -> int:
+        return self.queue_length(queue)
+
+    def create_queue(self, queue: str) -> None:
+        status = self._conn._request_status("mq", queue)
+        if status != "OK":
+            raise ProtocolError(f"unexpected mq response: {status!r}")
+
+    def mq(self, queue: str) -> None:
+        self.create_queue(queue)
+
+    def list_queues(self) -> list[str]:
+        return _parse_listing_lines(self._conn._request_multiline("queues"))
+
+    def queues(self) -> list[str]:
+        return self.list_queues()
+
+    def publish(self, topic: str, message: str | bytes) -> int:
+        status = self._conn._request_status("pub", topic, message)
+        if not status.startswith("OK "):
+            raise ProtocolError(f"unexpected pub response: {status!r}")
+        try:
+            return int(status.split(" ", 1)[1])
+        except ValueError as exc:
+            raise ProtocolError(f"invalid pub response: {status!r}") from exc
+
+    def pub(self, topic: str, message: str | bytes) -> int:
+        return self.publish(topic, message)
+
+    def list_topics(self) -> dict[str, int]:
+        items = _parse_listing_lines(self._conn._request_multiline("topics"))
+        result: dict[str, int] = {}
+        for item in items:
+            name, left, count = item.rpartition("(")
+            if not left or not count.endswith(")"):
+                raise ProtocolError(f"invalid topic listing item: {item!r}")
+            result[name] = int(count[:-1])
+        return result
+
+    def topics(self) -> dict[str, int]:
+        return self.list_topics()
+
+    def subscriber(self, *topics: str) -> Subscriber:
+        sub = Subscriber(
+            self.host,
+            self.port,
+            timeout=self.timeout,
+            idle_timeout=self.idle_timeout,
+            encoding=self.encoding,
+        )
+        if topics:
+            sub.subscribe(*topics)
+        return sub
+
+
+class Subscriber:
+    def __init__(
+        self,
+        host: str = "127.0.0.1",
+        port: int = 8388,
+        *,
+        timeout: float = 1.0,
+        idle_timeout: float = 0.08,
+        encoding: str = "utf-8",
+    ) -> None:
+        self._conn = _SocketProtocol(
+            host,
+            port,
+            timeout=timeout,
+            idle_timeout=idle_timeout,
+            encoding=encoding,
+        )
+        self._events: Deque[Event] = deque()
+
+    def close(self) -> None:
+        self._conn.close()
+
+    def __enter__(self) -> Subscriber:
+        return self
+
+    def __exit__(self, exc_type: object, exc: object, tb: object) -> None:
+        self.close()
+
+    def __iter__(self) -> Iterator[Event]:
+        while True:
+            yield self.get()
+
+    def _request_status(self, op: str, topic: str | None = None) -> str:
+        self._conn._send_command(op, topic)
+        while True:
+            kind, value = self._conn._read_one()
+            if kind == "event":
+                self._events.append(value)  # type: ignore[arg-type]
+                continue
+            if kind == "error":
+                _raise_server_error(str(value))
+            if kind != "status":
+                raise ProtocolError(f"expected status response, got {kind}")
+            return str(value)
+
+    def subscribe(self, *topics: str) -> None:
+        for topic in topics:
+            status = self._request_status("sub", topic)
+            if status != "OK":
+                raise ProtocolError(f"unexpected sub response: {status!r}")
+
+    def sub(self, *topics: str) -> None:
+        self.subscribe(*topics)
+
+    def unsubscribe(self, *topics: str) -> None:
+        if not topics:
+            status = self._request_status("unsub")
+            if status != "OK":
+                raise ProtocolError(f"unexpected unsub response: {status!r}")
+            return
+
+        for topic in topics:
+            status = self._request_status("unsub", topic)
+            if status != "OK":
+                raise ProtocolError(f"unexpected unsub response: {status!r}")
+
+    def unsub(self, *topics: str) -> None:
+        self.unsubscribe(*topics)
+
+    def get(self, timeout: float | None = None) -> Event:
+        if self._events:
+            return self._events.popleft()
+
+        while True:
+            kind, value = self._conn._read_one(timeout=timeout)
+            if kind == "event":
+                return value  # type: ignore[return-value]
+            if kind == "error":
+                _raise_server_error(str(value))
+            raise ProtocolError(f"expected event response, got {kind}")
+
+
+def _encode_name(value: str) -> bytes:
+    encoded = value.encode("utf-8")
+    if not encoded:
+        raise ValueError("queue/topic names cannot be empty")
+    if any(byte in encoded for byte in b" \t\r\n"):
+        raise ValueError("queue/topic names cannot contain whitespace or line breaks")
+    return encoded
+
+
+def _encode_body(value: str | bytes, encoding: str) -> bytes:
+    encoded = value.encode(encoding) if isinstance(value, str) else bytes(value)
+    if b"\r" in encoded or b"\n" in encoded:
+        raise ValueError("message bodies cannot contain CR or LF")
+    return encoded
+
+
+def _decode_text(value: bytes, encoding: str) -> str:
+    return value.decode(encoding)
+
+
+def _parse_listing_lines(raw: bytes) -> list[str]:
+    text = raw.decode("utf-8")
+    if not text.startswith("+"):
+        raise ProtocolError(f"invalid listing response: {text!r}")
+
+    body = text[1:]
+    if body == "\r\n":
+        return []
+
+    return [line for line in body.rstrip("\r\n").split("\r\n") if line]
+
+
+def _raise_server_error(message: str) -> None:
+    mapping = {
+        "empty": EmptyError,
+        "queue not found": QueueNotFoundError,
+        "queue full": QueueFullError,
+    }
+    exc_type = mapping.get(message, ServerError)
+    raise exc_type(message)

zigmq-0.1.0/src/zigmq/errors.py

@@ -0,0 +1,31 @@
+class ZigMQError(Exception):
+    """Base exception for the ZigMQ SDK."""
+
+
+class ProtocolError(ZigMQError):
+    """Raised when the server response does not match the ZigMQ protocol."""
+
+
+class ServerError(ZigMQError):
+    """Raised when the server returns `-ERR`."""
+
+
+class QueueNotFoundError(ServerError):
+    """Raised when a queue does not exist."""
+
+
+class EmptyError(ServerError):
+    """Raised when a queue exists but has no available messages."""
+
+
+class QueueFullError(ServerError):
+    """Raised when a queue is full and cannot grow anymore."""
+
+
+class TimeoutError(ZigMQError):
+    """Raised when the client times out waiting for a response."""
+
+
+class ConnectionClosedError(ZigMQError):
+    """Raised when the server closes the connection."""
+

zigmq-0.1.0/src/zigmq/models.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Info:
+    banner: str
+    version: str
+    queues: int
+    topics: int
+    initial_capacity: int
+    max_capacity: int
+
+
+@dataclass(frozen=True)
+class Event:
+    topic: str
+    message: str
+    data: bytes

zigmq-0.1.0/src/zigmq.egg-info/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: zigmq
+Version: 0.1.0
+Summary: A tiny, pythonic SDK for the ZigMQ text protocol.
+Author: reasonz
+Project-URL: Homepage, https://github.com/reasonz/zigMQ-python-SDK
+Project-URL: Repository, https://github.com/reasonz/zigMQ-python-SDK
+Keywords: zigmq,queue,pubsub,messaging
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# zigMQ Python SDK
+
+`zigmq` is a tiny, pythonic SDK for the [ZigMQ](https://github.com/reasonz/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
+
+```bash
+pip install zigmq
+```
+
+Local development:
+
+```bash
+cd zigMQ-python-SDK
+pip install -e .
+python -m unittest -v
+```
+
+## Quick Start
+
+```python
+from zigmq import Client
+
+with Client() as mq:
+    mq.send("jobs", "hello world")
+    print(mq.recv("jobs"))
+```
+
+Pub/Sub:
+
+```python
+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](./pyproject.toml), then:
+
+```bash
+cd zigMQ-python-SDK
+python -m build
+twine upload dist/*
+```

zigmq-0.1.0/src/zigmq.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/zigmq/__init__.py
+src/zigmq/client.py
+src/zigmq/errors.py
+src/zigmq/models.py
+src/zigmq.egg-info/PKG-INFO
+src/zigmq.egg-info/SOURCES.txt
+src/zigmq.egg-info/dependency_links.txt
+src/zigmq.egg-info/top_level.txt
+tests/test_client.py

zigmq-0.1.0/src/zigmq.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

zigmq-0.1.0/src/zigmq.egg-info/top_level.txt

@@ -0,0 +1 @@
+zigmq

zigmq-0.1.0/tests/test_client.py

@@ -0,0 +1,130 @@
+from __future__ import annotations
+
+import contextlib
+import signal
+import socket
+import subprocess
+import sys
+import time
+import unittest
+from pathlib import Path
+
+
+PROJECT_DIR = Path(__file__).resolve().parents[1]
+WORKSPACE_ROOT = PROJECT_DIR.parent
+SERVER_REPO = WORKSPACE_ROOT / "zigMQ"
+SERVER_VERSION = (SERVER_REPO / "VERSION").read_text(encoding="utf-8").strip()
+sys.path.insert(0, str(PROJECT_DIR / "src"))
+
+from zigmq import Client, EmptyError, QueueNotFoundError, Subscriber  # noqa: E402
+
+
+def _find_server_exe() -> Path:
+    candidates = [
+        SERVER_REPO / "zig-out" / "bin" / "zigmq",
+        SERVER_REPO / "dist" / "release" / f"zigmq-v{SERVER_VERSION}-macos-aarch64" / "zigmq",
+        SERVER_REPO / "dist" / "release" / f"zigmq-v{SERVER_VERSION}-linux-x86_64" / "zigmq",
+    ]
+    for candidate in candidates:
+        if candidate.exists():
+            return candidate
+    raise FileNotFoundError("could not find a ZigMQ executable for tests")
+
+
+def _free_port() -> int:
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        sock.bind(("127.0.0.1", 0))
+        return int(sock.getsockname()[1])
+
+
+@contextlib.contextmanager
+def running_server(*extra_args: str):
+    exe = _find_server_exe()
+    port = _free_port()
+    command = [str(exe), "--port", str(port), *extra_args]
+    process = subprocess.Popen(
+        command,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True,
+    )
+
+    deadline = time.monotonic() + 5.0
+    while time.monotonic() < deadline:
+        if process.poll() is not None:
+            stdout, stderr = process.communicate(timeout=0.2)
+            raise RuntimeError(
+                f"server exited during startup\ncommand: {' '.join(command)}\nstdout:\n{stdout}\nstderr:\n{stderr}"
+            )
+
+        try:
+            probe = socket.create_connection(("127.0.0.1", port), timeout=0.2)
+        except OSError:
+            time.sleep(0.05)
+            continue
+
+        probe.close()
+        break
+    else:
+        process.kill()
+        stdout, stderr = process.communicate(timeout=0.2)
+        raise RuntimeError(
+            f"server did not start\ncommand: {' '.join(command)}\nstdout:\n{stdout}\nstderr:\n{stderr}"
+        )
+
+    try:
+        yield port
+    finally:
+        if process.poll() is None:
+            with contextlib.suppress(ProcessLookupError):
+                process.send_signal(signal.SIGINT)
+        try:
+            process.communicate(timeout=2.0)
+        except subprocess.TimeoutExpired:
+            process.kill()
+            process.communicate(timeout=2.0)
+
+
+class ClientTests(unittest.TestCase):
+    def test_queue_roundtrip_and_info(self) -> None:
+        with running_server("--capacity", "2", "--max-capacity", "4") as port:
+            with Client(port=port) as mq:
+                self.assertEqual(mq.ping(), "PONG")
+
+                info = mq.info()
+                self.assertEqual(info.initial_capacity, 2)
+                self.assertEqual(info.max_capacity, 4)
+
+                mq.send("jobs", "hello world")
+                self.assertEqual(mq.queue_length("jobs"), 1)
+                self.assertEqual(mq.peek("jobs"), "hello world")
+                self.assertEqual(mq.recv("jobs"), "hello world")
+                self.assertIn("jobs", mq.list_queues())
+
+    def test_error_mapping(self) -> None:
+        with running_server("--capacity", "2", "--max-capacity", "4") as port:
+            with Client(port=port) as mq:
+                with self.assertRaises(QueueNotFoundError):
+                    mq.recv("missing")
+
+                mq.create_queue("jobs")
+                with self.assertRaises(EmptyError):
+                    mq.recv("jobs")
+
+    def test_topics_and_publish(self) -> None:
+        with running_server("--capacity", "2", "--max-capacity", "4") as port:
+            with Subscriber(port=port) as sub:
+                sub.subscribe("news")
+
+                with Client(port=port) as mq:
+                    self.assertEqual(mq.publish("news", "shipped"), 1)
+                    self.assertEqual(mq.list_topics(), {"news": 1})
+
+                event = sub.get(timeout=1.0)
+                self.assertEqual(event.topic, "news")
+                self.assertEqual(event.message, "shipped")
+                self.assertEqual(event.data, b"shipped")
+
+
+if __name__ == "__main__":
+    unittest.main()