High level flask-like MQTT framework.
Project description
Gourd - An MQTT framework
Gourd is an opinionated framework for writing MQTT applications.
Simple example
from gourd import Gourd
mqtt = Gourd(app_name='my_app', mqtt_host='localhost', mqtt_port=1883, username='mqtt', password='my_password')
@mqtt.subscribe('#')
def print_all_messages(message):
print(f'{message.topic}: {message.payload}')
if __name__ == '__main__':
mqtt.run_forever()
Features
- Create a fully-functional MQTT app in minutes
- Status published to
<app_name>/<hostname>/status
with a Last Will and Testament - Debug logs published to
<app_name>/<hostname>/debug
- Use decorators to associate topics with one or more functions
Installation
Gourd is available on pypi, you can use pip to install it:
python3 -m pip install gourd
Documentation
WIP
Reporting Bugs and Requesting Features
Please let us know about any bugs and/or feature requests you have: <>
Contributing
Contributions are welcome! You don't need to open an issue first, if you've developed a new feature or fixed a bug in Gourd simply open a PR and we'll review it.
Please follow this checklist before submitting a PR:
- Format your code:
yapf -i -r .
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gourd-0.0.3.tar.gz
(5.9 kB
view hashes)
Built Distribution
Close
Hashes for gourd-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2e71726021d3b596ad2b5111bcb2ae523dd5c368c13f52f9a3e091b0efae7b8 |
|
MD5 | 62f9df7747b7ad8d01f00ca3260168bf |
|
BLAKE2b-256 | 16b7f6c5b46f99e1013dd6d573b9816163ae4b87f1704387643cf460cb6bdfa6 |