Metadata-Version: 2.1
Name: asyncio-mqtt
Version: 0.8.0
Summary: Idomatic asyncio wrapper around paho-mqtt.
Home-page: https://github.com/sbtinstruments/asyncio-mqtt
Author: Frederik Aalund
Author-email: fpa@sbtinstruments.com
License: BSD 3-clause License
Description: ![license](https://img.shields.io/github/license/sbtinstruments/asyncio-mqtt)
        ![semver](https://img.shields.io/github/v/tag/sbtinstruments/asyncio-mqtt?sort=semver)
        
        # MQTT client with idiomatic asyncio interface 🙌
        
        Write code like this:
        
        ```python
        async with Client("test.mosquitto.org") as client:
            async with client.filtered_messages("floors/+/humidity") as messages:
                await client.subscribe("floors/#")
                async for message in messages:
                    print(message.payload.decode())
        ```
        
        asyncio-mqtt combines the stability of the time-proven [paho-mqtt](https://github.com/eclipse/paho.mqtt.python) library with a modern, asyncio-based interface.
        
        * No more callbacks! 👍
        * No more return codes (welcome to the `MqttError`)
        * Graceful disconnection (forget about `on_unsubscribe`, `on_disconnect`, etc.)
        * Compatible with `async` code
        * Did we mention no more callbacks?
        
        The whole thing is less than [400 lines of code](https://github.com/sbtinstruments/asyncio-mqtt/blob/master/asyncio_mqtt/client.py).
        
        ## Installation 📚
        
        `pip install asyncio-mqtt`
        
        ## Advanced use ⚡
        
        Let's make the example from before more interesting:
        
        ```python
        import asyncio
        from contextlib import AsyncExitStack, asynccontextmanager
        from random import randrange
        from asyncio_mqtt import Client, MqttError
        
        
        async def advanced_example():
            # We 💛 context managers. Let's create a stack to help
            # us manage them.
            async with AsyncExitStack() as stack:
                # Keep track of the asyncio tasks that we create, so that
                # we can cancel them on exit
                tasks = set()
                stack.push_async_callback(cancel_tasks, tasks)
        
                # Connect to the MQTT broker
                client = Client("test.mosquitto.org")
                await stack.enter_async_context(client)
        
                # You can create any number of topic filters
                topic_filters = (
                    "floors/+/humidity",
                    "floors/rooftop/#"
                    # 👉 Try to add more filters!
                )
                for topic_filter in topic_filters:
                    # Log all messages that matches the filter
                    manager = client.filtered_messages(topic_filter)
                    messages = await stack.enter_async_context(manager)
                    template = f'[topic_filter="{topic_filter}"] {{}}'
                    task = asyncio.create_task(log_messages(messages, template))
                    tasks.add(task)
        
                # Messages that doesn't match a filter will get logged here
                messages = await stack.enter_async_context(client.unfiltered_messages())
                task = asyncio.create_task(log_messages(messages, "[unfiltered] {}"))
                tasks.add(task)
        
                # Subscribe to topic(s)
                # 🤔 Note that we subscribe *after* starting the message
                # loggers. Otherwise, we may miss retained messages.
                await client.subscribe("floors/#")
        
                # Publish a random value to each of these topics
                topics = (
                    "floors/basement/humidity",
                    "floors/rooftop/humidity",
                    "floors/rooftop/illuminance",
                    # 👉 Try to add more topics!
                )
                task = asyncio.create_task(post_to_topics(client, topics))
                tasks.add(task)
        
                # Wait for everything to complete (or fail due to, e.g., network
                # errors)
                await asyncio.gather(*tasks)
        
        async def post_to_topics(client, topics):
            while True:
                for topic in topics:
                    message = randrange(100)
                    print(f'[topic="{topic}"] Publishing message={message}')
                    await client.publish(topic, message, qos=1)
                    await asyncio.sleep(2)
        
        async def log_messages(messages, template):
            async for message in messages:
                # 🤔 Note that we assume that the message paylod is an
                # UTF8-encoded string (hence the `bytes.decode` call).
                print(template.format(message.payload.decode()))
        
        async def cancel_tasks(tasks):
            for task in tasks:
                if task.done():
                    continue
                task.cancel()
                try:
                    await task
                except asyncio.CancelledError:
                    pass
        
        async def main():
            # Run the advanced_example indefinitely. Reconnect automatically
            # if the connection is lost.
            reconnect_interval = 3  # [seconds]
            while True:
                try:
                    await advanced_example()
                except MqttError as error:
                    print(f'Error "{error}". Reconnecting in {reconnect_interval} seconds.')
                finally:
                    await asyncio.sleep(reconnect_interval)
        
        
        asyncio.run(main())
        ```
        
        ## Alternative asyncio-based MQTT clients
        
        Is asyncio-mqtt not what you are looking for? Try another client:
        
         * [hbmqtt](https://github.com/beerfactory/hbmqtt) - Own protocol implementation. Includes a broker.  
           ![GitHub stars](https://img.shields.io/github/stars/beerfactory/hbmqtt)
           ![license](https://img.shields.io/github/license/beerfactory/hbmqtt)
         * [gmqtt](https://github.com/wialon/gmqtt) - Own protocol implementation. No dependencies.  
           ![GitHub stars](https://img.shields.io/github/stars/wialon/gmqtt)
           ![license](https://img.shields.io/github/license/wialon/gmqtt)
         * [aiomqtt](https://github.com/mossblaser/aiomqtt) - Wrapper around paho-mqtt.  
           ![GitHub stars](https://img.shields.io/github/stars/mossblaser/aiomqtt)
           ![license](https://img.shields.io/github/license/mossblaser/aiomqtt)
         * [mqttools](https://github.com/eerimoq/mqttools) - Own protocol implementation. No dependencies.  
           ![GitHub stars](https://img.shields.io/github/stars/eerimoq/mqttools)
           ![license](https://img.shields.io/github/license/eerimoq/mqttools)
         * [aio-mqtt](https://github.com/NotJustAToy/aio-mqtt) - Own protocol implementation. No dependencies.  
           ![GitHub stars](https://img.shields.io/github/stars/NotJustAToy/aio-mqtt)
           ![license](https://img.shields.io/github/license/NotJustAToy/aio-mqtt)
        
        This is not an exhaustive list.
        
        ### Honorable mentions
        
         * [trio-paho-mqtt](https://github.com/bkanuka/trio-paho-mqtt) - Trio-based. Wrapper around paho-mqtt.  
           ![GitHub stars](https://img.shields.io/github/stars/bkanuka/trio-paho-mqtt)
           ![license](https://img.shields.io/github/license/bkanuka/trio-paho-mqtt)
        
        ## Requirements
        
        Python 3.7 or later.
        
        There is only a single dependency:
        
         * [paho-mqtt](https://github.com/eclipse/paho.mqtt.python)  
           ![GitHub stars](https://img.shields.io/github/stars/eclipse/paho.mqtt.python) ![license](https://img.shields.io/github/license/eclipse/paho.mqtt.python)
        
        ## Note for Windows Users
        
        Since Python 3.8, the default asyncio event loop is the `ProactorEventLoop`. Said loop [doesn't support the `add_reader` method](https://docs.python.org/3/library/asyncio-platforms.html#windows) that is required by asyncio-mqtt. To use asyncio-mqtt, please switch to an event loop that supports the `add_reader` method such as the built-in `SelectorEventLoop`. E.g:
        ```
        # Change to the "Selector" event loop
        asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
        # Run your async application as usual
        asyncio.run(main())
        ```
        
        ## Changelog
        
        Please refer to the [CHANGELOG](https://github.com/sbtinstruments/asyncio-mqtt/blob/master/CHANGELOG.md) document. It adheres to the principles of [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
        
        ## Versioning
        
        ![semver](https://img.shields.io/github/v/tag/sbtinstruments/asyncio-mqtt?sort=semver)
        
        This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
        
        Expect API changes until we reach version `1.0.0`. After `1.0.0`, breaking changes will only occur in major release (e.g., `2.0.0`, `3.0.0`, etc.).
        
        ## License
        
        ![license](https://img.shields.io/github/license/sbtinstruments/asyncio-mqtt)
        
        Note that the underlying paho-mqtt library is dual-licensed. One of the licenses is the so-called [Eclipse Distribution License v1.0](https://www.eclipse.org/org/documents/edl-v10.php). It is almost word-for-word identical to the [BSD 3-clause License](https://opensource.org/licenses/BSD-3-Clause). The only differences are:
         * One use of "COPYRIGHT OWNER" (EDL) instead of "COPYRIGHT HOLDER" (BSD)
         * One use of "Eclipse Foundation, Inc." (EDL) instead of "copyright holder" (BSD)
        
Keywords: mqtt async asyncio paho-mqtt wrapper
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
