Skip to main content

A lightweight Python MQTT client implemented as a thin wrapper around libmosquitto

Project description

PyMosquitto

A lightweight Python MQTT client implemented as a thin wrapper around libmosquitto.

It provides an efficient synchronous client (client.Client) and two variants of asynchronous clients:

  • aio.AsyncClient - async interface to libmosquitto loop running in its own thread. It's faster, but consumes a little bit more memory.
  • aio.TrueAsyncClient - manages all events in asyncio loop by utilizing mosquitto_loop_{read,write,misc} functions.

Dependencies

  • python3.8+
  • libmosquitto1

Installation

  • pip install pymosquitto

TODO

  • add v5 support

Usage

from pymosquitto import Client


def on_message(client, userdata, msg):
    print(msg)


client = Client()
client.on_connect = lambda *_: client.subscribe("#", 1)
client.on_message = on_message
client.connect_async("localhost", 1883)
client.loop_forever()

Async client example:

import asyncio

from pymosquitto.aio import AsyncClient


async def main():
    async with AsyncClient() as client:
        await client.connect("localhost", 1883)
        await client.subscribe("#", 1)
        async for msg in client.read_messages():
            print(msg)


asyncio.run(main())

Check out more examples in tests directory.

Benchmarks

Receiving one million messages with QoS 0.

*The memory plots exclude the Python interpreter overhead (~8.7 MB).

benchmark-results

Losers excluded:

benchmark-results-fast

benchmark.csv

Module;Time;RSS
pymosq;0:04.30;18452
pymosq_async;0:07.29;25068
pymosq_true_async;0:09.73;24940
paho;0:08.97;22860
gmqtt;0:04.56;24508
mqttools;0:06.13;28084
aiomqtt;0:54.05;578104
amqtt;0:59.41;715416

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymosquitto-0.3.4.tar.gz (87.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pymosquitto-0.3.4-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file pymosquitto-0.3.4.tar.gz.

File metadata

  • Download URL: pymosquitto-0.3.4.tar.gz
  • Upload date:
  • Size: 87.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pymosquitto-0.3.4.tar.gz
Algorithm Hash digest
SHA256 3392e569f57dcf2300c025710f14d4b77fd1add7122cb4d59759b814b66319ed
MD5 a08f0b76cfca817f7803da2573232ca2
BLAKE2b-256 00379f6f696da497687e99f25eb4daab33b678463eca5aeb0c33148456f96515

See more details on using hashes here.

File details

Details for the file pymosquitto-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: pymosquitto-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for pymosquitto-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7fc0d0127ef9025f6c59edd1547a928cebf4f521d1ac0df43af046ed5aa68a3
MD5 572ac72614ff6e42612c58d240664455
BLAKE2b-256 462b3d9c1b2ddb6e1d9c68877b139db8969d2befe55139fde49dc71bcc0f93b3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page