amqtt

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

Go to file

Stein Magnus Jodal 00c40e8935 Include all files in the PyPI releases - Included tests, examples, etc in MANIFEST.in. - Made git ignore files that should not be included in the package. - Added tox test environment which runs check-manifest to validate the MANIFEST.in file. Downstreams like Debian prefer the PyPI packages to include everything from the Git repo, especially changelogs and test suites. To make the installation with pip as lightweight as possible, it is encouraged to build and upload Python wheels in addition to the sdist tarball.		2017-07-26 15:08:58 +02:00
docs	Update documentation	2017-06-02 21:46:54 +02:00
hbmqtt	Fix delicious exception so it is properly eaten	2017-07-06 17:37:24 -07:00
samples	#50	2016-07-31 18:29:41 +02:00
scripts	Refactor scripts utils location	2016-05-04 21:32:22 +02:00
tests	Fix #75 .	2017-06-02 21:17:05 +02:00
.gitignore	Include all files in the PyPI releases	2017-07-26 15:08:58 +02:00
.travis.yml	Fix tests	2017-03-30 12:47:06 +03: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
requirements.txt	Update websockets, use local broker for testing	2017-06-02 16:53:58 +02:00
setup.cfg	Update configuration	2016-03-12 22:25:25 +01:00
setup.py	Support python 3.6	2017-06-02 21:40:33 +02:00
tox.ini	Include all files in the PyPI releases	2017-07-26 15:08:58 +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