amqtt

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

Go to file

njouanin 414acc49f3 Merge branch 'release/0.6.3' into develop		2016-03-12 21:57:55 +01:00
docs	Update changelog	2016-03-06 21:51:00 +01:00
hbmqtt	Bump version	2016-03-12 21:54:58 +01:00
samples	Improve samples	2015-11-11 22:03:32 +01:00
scripts	Fix client id pattern	2015-11-06 21:33:39 +01:00
tests	Randomize packet ID	2015-11-01 21:55:24 +01:00
.gitignore	Add gitignore	2015-08-12 18:55:33 +02:00
.travis.yml	Disable python 3.4 environment (until 3.4.4 release which should fix the problem with Queue)	2015-09-22 23:06:36 +02:00
MANIFEST.in	Include default yaml files in scripts directory	2015-11-12 16:01:21 +11:00
license.txt	initial commit	2015-05-26 22:06:59 +02:00
readme.rst	Add gitter channel link	2016-03-07 15:41:00 +01:00
requirements.txt	Fix typo	2016-03-06 21:46:57 +01:00
setup.cfg	Add tox integration	2015-08-13 18:04:53 +02:00
setup.py	Add python 3.5 classifier	2015-11-13 22:24:59 +01:00
tox.ini	Revert	2015-11-01 22:35:47 +01: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=develop
    :target: https://travis-ci.org/beerfactory/hbmqtt

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

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

.. image:: https://badge.waffle.io/beerfactory/hbmqtt.svg?label=ready&title=Ready
    :target: https://waffle.io/beerfactory/hbmqtt
    :alt: 'Stories in Ready'

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