Metadata-Version: 2.4
Name: philiprehberger-mqtt-client
Version: 0.2.1
Summary: Simplified MQTT pub/sub wrapper with auto-reconnect
Project-URL: Homepage, https://github.com/philiprehberger/py-mqtt-client#readme
Project-URL: Repository, https://github.com/philiprehberger/py-mqtt-client
Project-URL: Issues, https://github.com/philiprehberger/py-mqtt-client/issues
Project-URL: Changelog, https://github.com/philiprehberger/py-mqtt-client/blob/main/CHANGELOG.md
Author: Philip Rehberger
License-Expression: MIT
License-File: LICENSE
Keywords: broker,iot,messaging,mqtt,pubsub
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: paho-mqtt>=2.0
Description-Content-Type: text/markdown

# philiprehberger-mqtt-client

[![Tests](https://github.com/philiprehberger/py-mqtt-client/actions/workflows/publish.yml/badge.svg)](https://github.com/philiprehberger/py-mqtt-client/actions/workflows/publish.yml)
[![PyPI version](https://img.shields.io/pypi/v/philiprehberger-mqtt-client.svg)](https://pypi.org/project/philiprehberger-mqtt-client/)
[![Last updated](https://img.shields.io/github/last-commit/philiprehberger/py-mqtt-client)](https://github.com/philiprehberger/py-mqtt-client/commits/main)

Simplified MQTT pub/sub wrapper with auto-reconnect.

## Installation

```bash
pip install philiprehberger-mqtt-client
```

## Usage

### Basic Pub/Sub

```python
from philiprehberger_mqtt_client import MQTTClient

client = MQTTClient("mqtt://localhost:1883", client_id="my-app")

@client.on("home/temperature")
def on_temperature(topic, payload):
    print(f"Temperature: {float(payload)}C")

@client.on("home/+/status")  # wildcard
def on_device_status(topic, payload):
    device = topic.split("/")[1]
    print(f"{device}: {payload}")

# Publish
client.publish("home/lights/living", "on")
client.publish_json("home/sensors/data", {"temp": 22.5, "humidity": 45})

# Connect (blocks with auto-reconnect)
client.connect()

# Or background mode
client.connect(background=True)
```

### Offline Message Queue

Messages published while disconnected are automatically queued and sent when the connection is re-established.

```python
client = MQTTClient("mqtt://localhost:1883", offline_queue_size=500)

# These are queued if not yet connected
client.publish("sensors/temp", "22.5")
client.publish_json("sensors/data", {"humidity": 45})

# Check queue status
print(f"Pending messages: {client.pending_count()}")

# Connect — queued messages are flushed automatically
client.connect(background=True)

# Discard queued messages if needed
client.clear_queue()
```

## API

| Function / Class | Description |
|------------------|-------------|
| `MQTTClient(broker_url, client_id, ...)` | Simplified MQTT client with auto-reconnect and offline queue |
| `.on(topic, qos)` | Decorator to subscribe to a topic (supports MQTT wildcards) |
| `.subscribe(topic, callback, qos)` | Programmatically subscribe to a topic |
| `.publish(topic, payload, qos, retain)` | Publish a message (queues if disconnected) |
| `.publish_json(topic, data, qos, retain)` | Publish a JSON-serialized message |
| `.connect(background)` | Connect to the broker and start listening |
| `.disconnect()` | Disconnect from the broker |
| `.pending_count()` | Return number of messages in the offline queue |
| `.clear_queue()` | Discard all queued messages |
| `.is_connected` | Whether the client is currently connected |

## Development

```bash
pip install -e .
python -m pytest tests/ -v
```

## Support

If you find this project useful:

⭐ [Star the repo](https://github.com/philiprehberger/py-mqtt-client)

🐛 [Report issues](https://github.com/philiprehberger/py-mqtt-client/issues?q=is%3Aissue+is%3Aopen+label%3Abug)

💡 [Suggest features](https://github.com/philiprehberger/py-mqtt-client/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)

❤️ [Sponsor development](https://github.com/sponsors/philiprehberger)

🌐 [All Open Source Projects](https://philiprehberger.com/open-source-packages)

💻 [GitHub Profile](https://github.com/philiprehberger)

🔗 [LinkedIn Profile](https://www.linkedin.com/in/philiprehberger)

## License

[MIT](LICENSE)
