| Name | masterpiece-pahomqtt JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Paho MQTT broker plugin for `masterpiece` applications |
| upload_time | 2025-01-20 18:13:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License =========== Copyright (c) 2024, Juha Meskanen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| keywords |
mqtt
paho
broker
iot
masterpiece
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Paho MQTT Broker Plugin for MasterPiece
=======================================
This project adds MQTT broker functionality to `MasterPiece` applications.
Usage
-----
To install the module:
.. code-block:: bash
pip install masterpiece_pahomqtt
Once installed, you can create `~/.yourapp/config/PahoMqtt.json` configuration file to specify
the server, port and other attributes Paho MQTT broker needs to run.
.. code-block:: text
{"host": "your host",
"port": 1883,
}
To import and instantiate PahoMqtt for use:
.. code-block:: python
from masterpiece_pahomqtt import PahoMqtt
mqtt = PahoMqtt()
An example to write and read data:
.. code-block:: python
mqtt.subscribe("your/topic")
mqtt.publish("your/topic", your_msg)
Note
----
The `masterpiece_pahomqtt.PahoMqtt` class is an implementation of the abstract `masterpiece.mqtt.Mqtt`
base class. By using the Mqtt interface your application remain implementation-independent.
License
-------
This project is licensed under the MIT License - see the `LICENSE` file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "masterpiece-pahomqtt",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"J. Meskanen\" <juham.api@gmail.com>",
"keywords": "MQTT, paho, broker, IOT, masterpiece",
"author": null,
"author_email": "J Meskanen <juham.api@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/2a/35/f47af2a059d8c49fe874733b9cf276760529153ded53b28b255eac004a3a/masterpiece_pahomqtt-0.1.1.tar.gz",
"platform": null,
"description": "Paho MQTT Broker Plugin for MasterPiece\n=======================================\n\nThis project adds MQTT broker functionality to `MasterPiece` applications.\n\n\nUsage\n-----\n\nTo install the module:\n\n.. code-block:: bash\n\n pip install masterpiece_pahomqtt\n\nOnce installed, you can create `~/.yourapp/config/PahoMqtt.json` configuration file to specify\nthe server, port and other attributes Paho MQTT broker needs to run.\n\n.. code-block:: text\n\n {\"host\": \"your host\",\n \"port\": 1883,\n }\n\n\nTo import and instantiate PahoMqtt for use:\n\n.. code-block:: python\n\n from masterpiece_pahomqtt import PahoMqtt\n\n mqtt = PahoMqtt()\n\n\nAn example to write and read data:\n\n.. code-block:: python\n\n mqtt.subscribe(\"your/topic\")\n mqtt.publish(\"your/topic\", your_msg)\n\n\nNote\n----\n\nThe `masterpiece_pahomqtt.PahoMqtt` class is an implementation of the abstract `masterpiece.mqtt.Mqtt` \nbase class. By using the Mqtt interface your application remain implementation-independent.\n\n\n\nLicense\n-------\n\nThis project is licensed under the MIT License - see the `LICENSE` file for details.\n",
"bugtrack_url": null,
"license": "MIT License =========== Copyright (c) 2024, Juha Meskanen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE ",
"summary": "Paho MQTT broker plugin for `masterpiece` applications",
"version": "0.1.1",
"project_urls": {
"Bug Reports": "https://gitlab.com/juham/masterpiece",
"Homepage": "https://gitlab.com/juham/masterpiece_pahomqtt",
"Say Thanks!": "http://meskanen.com",
"Source": "https://gitlab.com/juham/masterpiece_pahomqtt"
},
"split_keywords": [
"mqtt",
" paho",
" broker",
" iot",
" masterpiece"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0477db3767e0146a6389a31ce82ac5971e07f8849937649673cd8ce05c326f99",
"md5": "577ca2ad2fdcbd2d29dbe71a8dcf2e6c",
"sha256": "de6b7c47ac371495a44e1cd18cea4871694fcf0cac59984c7a134de303c6c70f"
},
"downloads": -1,
"filename": "masterpiece_pahomqtt-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "577ca2ad2fdcbd2d29dbe71a8dcf2e6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5886,
"upload_time": "2025-01-20T18:13:54",
"upload_time_iso_8601": "2025-01-20T18:13:54.803703Z",
"url": "https://files.pythonhosted.org/packages/04/77/db3767e0146a6389a31ce82ac5971e07f8849937649673cd8ce05c326f99/masterpiece_pahomqtt-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a35f47af2a059d8c49fe874733b9cf276760529153ded53b28b255eac004a3a",
"md5": "5e9fe4b8aad2d18d1ad177284782ceb3",
"sha256": "0da4b68e3a3e670d77a4c1a7e76463d08cdf5110bf895f431bb14f2aebc15af1"
},
"downloads": -1,
"filename": "masterpiece_pahomqtt-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "5e9fe4b8aad2d18d1ad177284782ceb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5503,
"upload_time": "2025-01-20T18:13:55",
"upload_time_iso_8601": "2025-01-20T18:13:55.820207Z",
"url": "https://files.pythonhosted.org/packages/2a/35/f47af2a059d8c49fe874733b9cf276760529153ded53b28b255eac004a3a/masterpiece_pahomqtt-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-20 18:13:55",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "juham",
"gitlab_project": "masterpiece",
"lcname": "masterpiece-pahomqtt"
}
