amqtt

aMQTT is an open source MQTT client and broker implementation in python

Go to file

Schneider 0ceadbff86 replaced tabs with spaces		2018-12-05 15:55:30 +01:00
docs	improved documentation and script integration of extra_headers	2018-12-05 15:39:31 +01:00
hbmqtt	replaced tabs with spaces	2018-12-05 15:55:30 +01:00
samples	Added topic filtering Plugin	2018-03-19 10:58:56 +01:00
scripts	improved documentation and script integration of extra_headers	2018-12-05 15:39:31 +01:00
tests	Only setting session username/password if it is not already set. This is to prevent failures when the broker is reconnecting without username/password	2018-10-29 13:55:09 +11:00
.gitignore	Include all files in the PyPI releases	2017-07-26 15:08:58 +02:00
.travis.yml	Update .travis.yml	2018-07-07 12:32:00 +02:00
MANIFEST.in	Include all files in the PyPI releases	2017-07-26 15:08:58 +02:00
license.txt	…
readme.rst	Update documentation	2017-06-02 21:55:58 +02:00
setup.cfg	…
setup.py	Fix #123	2018-04-19 13:30:31 +02:00
tox.ini	Add py37 in tox	2018-07-06 09:58:55 +02:00

readme.rst

HBMQTT
======

``HBMQTT`` is an open source `MQTT`_ client and broker implementation.

Built on top of `asyncio`_, Python's standard asynchronous I/O framework, HBMQTT provides a straightforward API
based on coroutines, making it easy to write highly concurrent applications.

.. _asyncio: https://docs.python.org/3/library/asyncio.html

Features
--------

HBMQTT implements the full set of `MQTT 3.1.1`_ protocol specifications and provides the following features:

- Support QoS 0, QoS 1 and QoS 2 messages flow
- Client auto-reconnection on network lost
- Authentication through password file (more methods can be added through a plugin system)
- Basic ``$SYS`` topics
- TCP and websocket support
- SSL support over TCP and websocket
- Plugin system

Build status
------------

.. image:: https://travis-ci.org/beerfactory/hbmqtt.svg?branch=master
    :target: https://travis-ci.org/beerfactory/hbmqtt

.. image:: https://coveralls.io/repos/beerfactory/hbmqtt/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/beerfactory/hbmqtt?branch=master

Project status
--------------

.. image:: https://readthedocs.org/projects/hbmqtt/badge/?version=latest
    :target: http://hbmqtt.readthedocs.org/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://badge.fury.io/py/hbmqtt.svg
    :target: https://badge.fury.io/py/hbmqtt

Getting started
---------------

hbmqtt is available on `Pypi <https://pypi.python.org/pypi/hbmqtt>`_ and can installed simply using ``pip`` :
::

    $ pip install hbmqtt

Documentation is available on `Read the Docs`_.

Bug reports, patches and suggestions welcome! Just `open an issue`_ or join the `gitter channel`_.

.. image:: https://badges.gitter.im/Join%20Chat.svg
    :target: https://gitter.im/beerfactory/hbmqtt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
    :alt: 'Join the chat at https://gitter.im/beerfactory/hbmqtt'

.. _MQTT: http://www.mqtt.org
.. _MQTT 3.1.1: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html
.. _Read the Docs: http://hbmqtt.readthedocs.org/
.. _open an issue: https://github.com/beerfactory/hbmqtt/issues/new
.. _gitter channel: https://gitter.im/beerfactory/hbmqtt