pyqttier 0.1.0__tar.gz

pyqttier-0.1.0/.github/workflows/mypy.yml

@@ -0,0 +1,27 @@
+name: Mypy Type Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  mypy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install paho-mqtt mypy
+      - name: Run mypy
+        run: |
+          PYTHONPATH=src mypy --check-untyped-defs ./src/

pyqttier-0.1.0/.github/workflows/python-tests.yml

@@ -0,0 +1,30 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install paho-mqtt
+      - name: Run unit tests
+        run: |
+          PYTHONPATH=src python -m unittest discover tests
+      - name: Run mock example
+        run: |
+          PYTHONPATH=src python examples/mock_example.py

pyqttier-0.1.0/.gitignore

@@ -0,0 +1,151 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# poetry
+poetry.lock
+
+# pdm
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Project specific
+uv.lock
+check_py37_compat.py
+PYTHON37_COMPAT.md

pyqttier-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jacob Brunson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyqttier-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: pyqttier
+Version: 0.1.0
+Summary: Add your description here
+Author-email: Jacob Brunson <github@jacobbrunson.com>
+License-File: LICENSE
+Requires-Python: >=3.7
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pydantic>=2.5.3
+Description-Content-Type: text/markdown
+
+# PyQTTier
+
+A Python MQTT client library providing a clean, type-safe wrapper around paho-mqtt with support for MQTT 5.0 features.
+
+## Features
+
+- **MQTT 5.0 Support** - Full support for MQTT 5.0 protocol features including message properties, correlation data, and response topics
+- **Type Safety** - Strongly typed with mypy-checked type hints for reliability
+- **Multiple Transports** - Supports TCP, WebSocket, and Unix socket connections
+- **Mock Implementation** - Built-in `MockConnection` for easy testing without a broker
+- **Python 3.7+** - Compatible with Python 3.7 through 3.12
+
+## Installation
+
+```bash
+pip install pyqttier
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from pyqttier.connection import Mqtt5Connection
+from pyqttier.transport import MqttTransport, MqttTransportType
+from pyqttier.message import Message
+
+# Connect to broker
+transport = MqttTransport(MqttTransportType.TCP, host="localhost", port=1883)
+conn = Mqtt5Connection(transport=transport, client_id="my-client")
+
+# Subscribe to a topic
+def on_message(msg: Message):
+    print(f"Received: {msg.payload.decode()}")
+
+conn.subscribe("sensors/temperature", callback=on_message)
+
+# Publish a message
+msg = Message(topic="sensors/temperature", payload=b"23.5", qos=1)
+conn.publish(msg)
+```
+
+### Testing with MockConnection
+
+```python
+from pyqttier.mock import MockConnection
+from pyqttier.message import Message
+
+# Create mock connection for testing
+conn = MockConnection()
+
+# Publish and verify
+conn.publish(Message(topic="test", payload=b"data", qos=1))
+assert len(conn.published_messages) == 1
+assert conn.published_messages[0].topic == "test"
+```
+
+## Examples
+
+See the [examples/](examples/) directory for more detailed usage examples:
+
+- `usage_example.py` - Real broker connections, wildcards, request-response patterns
+- `mock_example.py` - Testing with MockConnection
+
+## Development
+
+```bash
+# Type checking
+uv run mypy --check-untyped-defs ./src/
+
+# Unit tests
+uv run pytest
+```
+
+## License
+
+See [LICENSE](LICENSE) file for details.

pyqttier-0.1.0/README.md

@@ -0,0 +1,77 @@
+# PyQTTier
+
+A Python MQTT client library providing a clean, type-safe wrapper around paho-mqtt with support for MQTT 5.0 features.
+
+## Features
+
+- **MQTT 5.0 Support** - Full support for MQTT 5.0 protocol features including message properties, correlation data, and response topics
+- **Type Safety** - Strongly typed with mypy-checked type hints for reliability
+- **Multiple Transports** - Supports TCP, WebSocket, and Unix socket connections
+- **Mock Implementation** - Built-in `MockConnection` for easy testing without a broker
+- **Python 3.7+** - Compatible with Python 3.7 through 3.12
+
+## Installation
+
+```bash
+pip install pyqttier
+```
+
+## Quick Start
+
+### Basic Usage
+
+```python
+from pyqttier.connection import Mqtt5Connection
+from pyqttier.transport import MqttTransport, MqttTransportType
+from pyqttier.message import Message
+
+# Connect to broker
+transport = MqttTransport(MqttTransportType.TCP, host="localhost", port=1883)
+conn = Mqtt5Connection(transport=transport, client_id="my-client")
+
+# Subscribe to a topic
+def on_message(msg: Message):
+    print(f"Received: {msg.payload.decode()}")
+
+conn.subscribe("sensors/temperature", callback=on_message)
+
+# Publish a message
+msg = Message(topic="sensors/temperature", payload=b"23.5", qos=1)
+conn.publish(msg)
+```
+
+### Testing with MockConnection
+
+```python
+from pyqttier.mock import MockConnection
+from pyqttier.message import Message
+
+# Create mock connection for testing
+conn = MockConnection()
+
+# Publish and verify
+conn.publish(Message(topic="test", payload=b"data", qos=1))
+assert len(conn.published_messages) == 1
+assert conn.published_messages[0].topic == "test"
+```
+
+## Examples
+
+See the [examples/](examples/) directory for more detailed usage examples:
+
+- `usage_example.py` - Real broker connections, wildcards, request-response patterns
+- `mock_example.py` - Testing with MockConnection
+
+## Development
+
+```bash
+# Type checking
+uv run mypy --check-untyped-defs ./src/
+
+# Unit tests
+uv run pytest
+```
+
+## License
+
+See [LICENSE](LICENSE) file for details.

pyqttier-0.1.0/examples/README.md

@@ -0,0 +1,24 @@
+# PyQTTier Examples
+
+This directory contains concise examples for using PyQTTier.
+
+## Usage Example (`usage_example.py`)
+
+Demonstrates connecting to an MQTT broker, publishing/subscribing, retained messages, wildcards, and request-response. Requires a broker on `localhost:1883`:
+
+```bash
+docker run -p 1883:1883 eclipse-mosquitto
+```
+
+Run the examples:
+```bash
+uv run examples/usage_example.py
+```
+
+## Mock Connection Example (`mock_example.py`)
+
+Shows how to use `MockConnection` for testing without a real broker. Run with:
+
+```bash
+uv run examples/mock_example.py
+```

pyqttier-0.1.0/examples/mock_example.py

@@ -0,0 +1,132 @@
+#!/usr/bin/env python3
+"""
+Example demonstrating how to use MockConnection for testing MQTT-based applications.
+
+This example shows:
+1. Publishing messages
+2. Subscribing to topics with callbacks
+3. Using global message callbacks
+4. Topic wildcard matching
+5. Simulating received messages
+6. Verifying published messages
+"""
+
+import sys
+from pathlib import Path
+
+# Add src to path for standalone execution
+sys.path.insert(0, str(Path(__file__).parent.parent / 'src'))
+
+from pyqttier.mock import MockConnection
+from pyqttier.message import Message
+
+
+def example_basic_publish_subscribe():
+    """Example 1: Basic publish and subscribe with callbacks."""
+    print("=" * 60)
+    print("Example 1: Basic Publish and Subscribe")
+    print("=" * 60)
+    
+    # Create a mock connection
+    conn = MockConnection().set_connected(True)
+
+    # Publish a message
+    msg = Message(
+        topic="sensors/temperature",
+        payload=b"23.5",
+        qos=1,
+        retain=False
+    )
+    fut = conn.publish(msg)
+    print(f"📤 Published temperature reading: {msg.payload.decode()}°C")
+    
+    assert len(conn.published_messages) == 1, "Should have one published message"
+
+    # Verify the message was received
+    print(f"✓ Published {len(conn.published_messages)} message.\n")
+
+def example_basic_subscribe():
+    """Example 2: Basic subscribe with topic filter and callback."""
+    print("=" * 60)
+    print("Example 2: Basic Subscribe with Callback")
+    print("=" * 60)
+    
+    # Create a mock connection
+    conn = MockConnection().set_connected(True)
+
+    received_count = 0
+
+    # Define a callback for received messages
+    def message_callback(msg: Message):
+        nonlocal received_count
+        print(f"📥 Received message on topic '{msg.topic}': {msg.payload.decode()}")
+        received_count += 1
+
+    # Subscribe to a topic
+    sub_id = conn.subscribe("sensors/+", message_callback)
+    print(f"🔔 Subscribed to 'sensors/+' with subscription ID {sub_id}")
+
+    # Simulate receiving a message
+    incoming_msg = Message(
+        topic="sensors/humidity",
+        payload=b"45%",
+        qos=1,
+        retain=False
+    )
+    conn.simulate_message(incoming_msg)
+
+    assert received_count == 1, "Should have received one message"
+    print(f"✓ Received {received_count} message(s) via subscription.\n")
+
+def example_request_response():
+    """Example 3: Request-Response pattern using response topics."""
+    print("=" * 60)
+    print("Example 3: Request-Response Pattern")
+    print("=" * 60)
+    
+    # Create a mock connection
+    conn = MockConnection().set_connected(True)
+
+    responses_received = 0
+
+    # Define a callback for responses
+    def response_callback(msg: Message):
+        nonlocal responses_received
+        responses_received += 1
+        print(f"📥 Received response on topic '{msg.topic}': {msg.payload.decode()}")
+
+    # Subscribe to the response topic
+    response_topic = "responses/device123"
+    conn.subscribe(response_topic, response_callback)
+    print(f"🔔 Subscribed to response topic '{response_topic}'")
+
+    # Simulate sending a request
+    request_msg = Message(
+        topic="requests/device123",
+        payload=b"GetStatus",
+        qos=1,
+        retain=False,
+        response_topic=response_topic
+    )
+    conn.publish(request_msg)
+    print(f"📤 Sent request: {request_msg.payload.decode()}")
+
+    assert len(conn.published_messages) == 1, "Should have one published request message"
+
+    # Simulate receiving a response
+    response_msg = Message(
+        topic=response_topic,
+        payload=b"Status: OK",
+        qos=1,
+        retain=False
+    )
+    conn.simulate_message(response_msg)
+
+    assert responses_received == 1, "Should have received one response"
+
+    print("✓ Completed request-response simulation.\n")
+
+if __name__ == "__main__":
+    example_basic_publish_subscribe()
+    example_basic_subscribe()
+    example_request_response()