Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-minimqtt/badge/?version=latest
:target: https://docs.circuitpython.org/projects/minimqtt/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
MQTT Client library for CircuitPython.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython ConnectionManager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-minimqtt/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-minimqtt
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-minimqtt
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-minimqtt
Usage Example
=============
Please check the `examples folder <https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/tree/main/examples>`_
for usage examples for this library.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/minimqtt/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-minimqtt",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, minimqtt, mqtt, , client, , socket",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/78/0e/53ca41cda2be7863e873f184fd6d307b6a7464cf053044d50f59518b7616/adafruit_circuitpython_minimqtt-7.10.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-minimqtt/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/minimqtt/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nMQTT Client library for CircuitPython.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython ConnectionManager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-minimqtt/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-minimqtt\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-minimqtt\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-minimqtt\n\nUsage Example\n=============\n\nPlease check the `examples folder <https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/tree/main/examples>`_\nfor usage examples for this library.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/minimqtt/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MQTT client library for CircuitPython",
"version": "7.10.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" minimqtt",
" mqtt",
" ",
" client",
" ",
" socket"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8498cc9a14f1088330861997a26c40e5f40c4ee5a28f49363ca7003d16914d7e",
"md5": "4bda10c96f798e0870f5b2c9c8b0b8f0",
"sha256": "57580ebb216b56017aeb5845e7bbf5a2449a8bdfae147097b57a5b3cd9d93ed9"
},
"downloads": -1,
"filename": "adafruit_circuitpython_minimqtt-7.10.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bda10c96f798e0870f5b2c9c8b0b8f0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15937,
"upload_time": "2024-09-09T13:42:42",
"upload_time_iso_8601": "2024-09-09T13:42:42.346373Z",
"url": "https://files.pythonhosted.org/packages/84/98/cc9a14f1088330861997a26c40e5f40c4ee5a28f49363ca7003d16914d7e/adafruit_circuitpython_minimqtt-7.10.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "780e53ca41cda2be7863e873f184fd6d307b6a7464cf053044d50f59518b7616",
"md5": "f40f5570dd34d586947bb1f56d99b269",
"sha256": "fdb6d73fc99491eb2a76308cc7a5f8de5e19d781326c021dc3a3fa5d151b6efd"
},
"downloads": -1,
"filename": "adafruit_circuitpython_minimqtt-7.10.2.tar.gz",
"has_sig": false,
"md5_digest": "f40f5570dd34d586947bb1f56d99b269",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 49280,
"upload_time": "2024-09-09T13:42:44",
"upload_time_iso_8601": "2024-09-09T13:42:44.029419Z",
"url": "https://files.pythonhosted.org/packages/78/0e/53ca41cda2be7863e873f184fd6d307b6a7464cf053044d50f59518b7616/adafruit_circuitpython_minimqtt-7.10.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-09 13:42:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MiniMQTT",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "Adafruit-Circuitpython-ConnectionManager",
"specs": []
},
{
"name": "adafruit-circuitpython-ticks",
"specs": []
}
],
"tox": true,
"lcname": "adafruit-circuitpython-minimqtt"
}
JSON
