mqtt5 0.4.0

The MQTTv5 protocol for Python written in Rust

mqtt5

A sans-I/O implementation of the MQTTv5 protocol for Python, written in Rust. Serialization is ~5x faster and deserialization ~20x faster than comparable Python code (benchmarked against mqttproto).

Reading/Writing a QoS=1 Publish packet with 256 bytes payload.

Serialize a packet to bytes

import mqtt5

packet = mqtt5.ConnectPacket(client_id="Bulbasaur")
data = packet.write()

Deserialize a packet from bytes

import mqtt5

buffer = memoryview(b"\x20\x03\x00\x00\x00")
packet, nbytes = mqtt5.read(buffer)

Key features

• Complete MQTTv5 support (user properties, QoS, topic aliases, flow control, ...)
• Packets are serialized to minimal wire format
• Strict validation on both outgoing and incoming packets
• Fully type-annotated

Installation

pip install mqtt5

Note that mqtt5 implements only the low-level packet de/serialization. If you're looking for a complete MQTT client, check out aiomqtt.

Documentation

See the stub file for an API reference and the MQTTv5 specification for details about the de/serialization.

Versioning

This project adheres to Semantic Versioning.

Changelog

See CHANGELOG.md, which follows the principles of Keep a Changelog.

Acknowledgments

I've learned a lot from Alex Grönholm's mqttproto, which is an excellent pure-Python MQTTv5 protocol implementation.