<commit_before>
twisted-mqtt
============

MQTT Client protocol for Twisted.

Description
-----------

**twsited-mqtt** is a library using the Twisted framework and implementing
the MQTT protocol (v3.1 & v3.1.1) in these flavours:

* pure subscriber
* pure publisher
* or a mixing of both

Instalation
-----------

Just type:

  `sudo pip install twisted-mqtt`

or from GitHub:

   git clone https://github.com/astrorafael/twisted-mqtt.git
   cd twisted-mqtt
   sudo python setup.py install

Credits
-------

I started writting this software after finding [<NAME>'s MQTT.py code](https://github.com/adamvr/MQTT-For-Twisted-Python). 
Some parts of this library still has hos code. However, I soon began taking my
own direction both in design and scope.

Function/methods docstrings contain quotes of the OASIS [mqtt-v3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html) standard.

MQTT Version 3.1.1. Edited by <NAME> and <NAME>. 29 October 2014. OASIS Standard. 
http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html. 
Latest version: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html.

Usage
-----

The APIs are described in the [library defined interfaces](mqtt/client/interfaces.py)

This library builds `MQTTProtocol` objects and is designed to be *used rather than inherited*.


### Publisher Example ###

    from twisted.logger import Logger, LogLevel
    from twisted.internet import reactor, task<commit_msg>added GItHub installation steps<commit_after>
twisted-mqtt
============

MQTT Client protocol for Twisted.

Description
-----------

**twsited-mqtt** is a library using the Twisted framework and implementing
the MQTT protocol (v3.1 & v3.1.1) in these flavours:

* pure subscriber
* pure publisher
* or a mixing of both

Instalation
-----------

Just type:

  `sudo pip install twisted-mqtt`

or from GitHub:

	git clone https://github.com/astrorafael/twisted-mqtt.git
	cd twisted-mqtt
	sudo python setup.py install

Credits
-------

I started writting this software after finding [Adam Rudd's MQTT.py code](https://github.com/adamvr/MQTT-For-Twisted-Python). 
Some parts of this library still has hos code. However, I soon began taking my
own direction both in design and scope.

Function/methods docstrings contain quotes of the OASIS [mqtt-v3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html) standard.

MQTT Version 3.1.1. Edited by <NAME> and <NAME>. 29 October 2014. OASIS Standard. 
http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html. 
Latest version: http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/mqtt-v3.1.1.html.

Usage
-----

The APIs are described in the [library defined interfaces](mqtt/client/interfaces.py)

This library builds `MQTTProtocol` objects and is designed to be *used rather than inherited*.


### Publisher Example ###

    from twisted.logger import Logger, LogLevel
    from twisted.internet import reactor, task
{'fraction_non_alphanumeric': 0.13315124615909868, 'fraction_numerical': 0.023898941618299762, 'mean_word_length': 3.4732824427480917, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6139095', 'n_tokens_mistral': 1034, 'n_tokens_neox': 982, 'n_words': 301}