amqtt

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

Go to file

mi3z 47e37404fd TLS connections can be established by default with system certificates to publish domains (for example to 'mqtts://iot.eclipse.org') - the client only requires cafiles if the broker provides self signed certificates		2017-11-22 10:40:20 +01:00
docs	Fix the Client doc	2017-10-18 17:54:19 +07:00
hbmqtt	TLS connections can be established by default with system certificates to publish domains (for example to 'mqtts://iot.eclipse.org') - the client only requires cafiles if the broker provides self signed certificates	2017-11-22 10:40:20 +01:00
samples	flake8: Fix all F841 unused local variable warnings	2017-08-07 01:23:21 +02:00
scripts	flake8: Fix all Wxxx whitespace and newline warnings	2017-08-07 01:23:21 +02:00
tests	changed localhost to 127.0.0.1 to fix Travis CI test	2017-11-17 10:11:26 +01:00
.gitignore	Include all files in the PyPI releases	2017-07-26 15:08:58 +02:00
.travis.yml	travis: Run tests on trusty to get newer Python 3.4	2017-08-07 01:29:14 +02:00
MANIFEST.in	Include all files in the PyPI releases	2017-07-26 15:08:58 +02:00
license.txt	initial commit	2015-05-26 22:06:59 +02:00
readme.rst	Update documentation	2017-06-02 21:55:58 +02:00
setup.cfg	Update configuration	2016-03-12 22:25:25 +01:00
setup.py	flake8: Fix all E1xx indentation warnings	2017-08-07 01:23:21 +02:00
tox.ini	Merge pull request #84 from jodal/test-on-py-34-35-36	2017-08-31 20:49:59 +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