amqtt/docs/index.rst

HBMQTT
======

``HBMQTT`` is an open source `MQTT`_ client and broker implementation. It implements `MQTT 3.1.1`_ protocol specifications

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

Requirements
------------

``HBMQTT`` is built on Python :mod:`asyncio` library which was introduced in Python 3.4. Tests have shown that HBMQTT run best with Python 3.4.3. Python 3.5.0 is also fully supported and recommended. Make use you use one of these version before installing ``HBMQTT``.

Installation
------------

It is not recommended to install third-party library in Python system packages directory. The preferred way for installing ``HBMQTT`` is to create a virtual environment and then install all the dependencies you need. Refer `PEP 405`_ to learn more.

Once you have a environment setup and ready, ``HBMQTT`` can be installed with the following command ::

  (venv) $ pip install hbmqtt

pip will download and install ``HBMQTT`` and all its dependencies.


User guide
----------


.. _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
.. _PEP 405: https://www.python.org/dev/peps/pep-0405/

.. toctree::
   :maxdepth: 2
   :hidden:
Init documentation 2015-11-01 13:39:46 +00:00			`HBMQTT`
			`======`

			``HBMQTT`` is an open source `MQTT`_ client and broker implementation. It implements `MQTT 3.1.1`_ protocol specifications

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

Add index introduction 2015-11-01 22:01:31 +00:00			`Requirements`
			`------------`
Init documentation 2015-11-01 13:39:46 +00:00
Fix 2015-11-01 22:05:13 +00:00			``HBMQTT`` is built on Python :mod:`asyncio` library which was introduced in Python 3.4. Tests have shown that HBMQTT run best with Python 3.4.3. Python 3.5.0 is also fully supported and recommended. Make use you use one of these version before installing ``HBMQTT``.
Add index introduction 2015-11-01 22:01:31 +00:00
			`Installation`
			`------------`

			It is not recommended to install third-party library in Python system packages directory. The preferred way for installing ``HBMQTT`` is to create a virtual environment and then install all the dependencies you need. Refer `PEP 405`_ to learn more.

			Once you have a environment setup and ready, ``HBMQTT`` can be installed with the following command ::
Init documentation 2015-11-01 13:39:46 +00:00
Add index introduction 2015-11-01 22:01:31 +00:00			`(venv) $ pip install hbmqtt`
Init documentation 2015-11-01 13:39:46 +00:00
Add index introduction 2015-11-01 22:01:31 +00:00			pip will download and install ``HBMQTT`` and all its dependencies.
Init documentation 2015-11-01 13:39:46 +00:00

Add index introduction 2015-11-01 22:01:31 +00:00			`User guide`
			`----------`

Init documentation 2015-11-01 13:39:46 +00:00

			`.. _MQTT: http://www.mqtt.org`
Add index introduction 2015-11-01 22:01:31 +00:00			`.. _MQTT 3.1.1: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html`
			`.. _PEP 405: https://www.python.org/dev/peps/pep-0405/`

			`.. toctree::`
			`:maxdepth: 2`
			`:hidden:`