adafruit-circuitpython-minimqtt


Nameadafruit-circuitpython-minimqtt JSON
Version 7.10.4 PyPI version JSON
download
home_pageNone
SummaryMQTT client library for CircuitPython
upload_time2024-10-14 13:32:36
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython minimqtt mqtt client socket
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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/e0/22/04c36a2b0d565703c7598242d712cece6e2058504fac6e75f887c0b4a42a/adafruit_circuitpython_minimqtt-7.10.4.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.4",
    "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": "e26b60b9d8f63fedafaaba56cd5833bfefe2c2b94c9bdf555729272f0fd81890",
                "md5": "ecbf1e6eda71b9d3b570b662b2be2b99",
                "sha256": "104690d81a8839f348a50de3721fca559f89a785fed5a04e4e9be12741164f64"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_minimqtt-7.10.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ecbf1e6eda71b9d3b570b662b2be2b99",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15930,
            "upload_time": "2024-10-14T13:32:35",
            "upload_time_iso_8601": "2024-10-14T13:32:35.162374Z",
            "url": "https://files.pythonhosted.org/packages/e2/6b/60b9d8f63fedafaaba56cd5833bfefe2c2b94c9bdf555729272f0fd81890/adafruit_circuitpython_minimqtt-7.10.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e02204c36a2b0d565703c7598242d712cece6e2058504fac6e75f887c0b4a42a",
                "md5": "ab87ef7d1e871a1409be61d3c2752db0",
                "sha256": "74704b4b842f587cf326a483ac4fef2259e0d939e69b26f8971dde2646e0869b"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_minimqtt-7.10.4.tar.gz",
            "has_sig": false,
            "md5_digest": "ab87ef7d1e871a1409be61d3c2752db0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 49266,
            "upload_time": "2024-10-14T13:32:36",
            "upload_time_iso_8601": "2024-10-14T13:32:36.577572Z",
            "url": "https://files.pythonhosted.org/packages/e0/22/04c36a2b0d565703c7598242d712cece6e2058504fac6e75f887c0b4a42a/adafruit_circuitpython_minimqtt-7.10.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-14 13:32:36",
    "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": [],
    "tox": true,
    "lcname": "adafruit-circuitpython-minimqtt"
}
        
Elapsed time: 0.37472s