Adafruit_CircuitPython_AdafruitIO
=================================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adafruitio/badge/?version=latest
:target: https://docs.circuitpython.org/projects/adafruitio/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_AdafruitIO/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython wrapper library for communicating with `Adafruit IO <http://io.adafruit.com>`_.
Dependencies
============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython ConnectionManager <https://github.com/adafruit/Adafruit_CircuitPython_ConnectionManager/>`_
* `Adafruit CircuitPython MiniMQTT <https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT>`_
Please ensure that 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-adafruitio/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-adafruitio
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-adafruitio
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-adafruitio
Usage Example
=============
Usage examples for the Adafruit IO HTTP API are within the examples/http folder.
Usage examples for the Adafruit IO MQTT API are within the examples/mqtt folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adafruitio/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_AdafruitIO/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-adafruitio",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, adafruit_io, adafruit-io, rest, api, iot, wifi",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/a6/9e/4a31f63ac11512c29bd22feb47c65f12f16a68b9e99a47e0655e26f94fdc/adafruit_circuitpython_adafruitio-5.10.0.tar.gz",
"platform": null,
"description": "Adafruit_CircuitPython_AdafruitIO\n=================================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adafruitio/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/adafruitio/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_AdafruitIO/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython wrapper library for communicating with `Adafruit IO <http://io.adafruit.com>`_.\n\n\nDependencies\n============\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* `Adafruit CircuitPython MiniMQTT <https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT>`_\n\nPlease ensure that 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====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-adafruitio/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-adafruitio\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-adafruitio\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-adafruitio\n\nUsage Example\n=============\n\nUsage examples for the Adafruit IO HTTP API are within the examples/http folder.\n\nUsage examples for the Adafruit IO MQTT API are within the examples/mqtt folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/adafruitio/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_AdafruitIO/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Adafruit IO for CircuitPython",
"version": "5.10.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" adafruit_io",
" adafruit-io",
" rest",
" api",
" iot",
" wifi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fec68d6116713b4ff1d45c5667ad848aec2c5aa489ba554ab504c19031f8c883",
"md5": "b9dd1984b32ecccae17cc957c0c78c5e",
"sha256": "d3e0780e2a36f7cb45177de2f5a88cbf36719ddd46bbab9761ef627bce6185c8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_adafruitio-5.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9dd1984b32ecccae17cc957c0c78c5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11509,
"upload_time": "2024-10-04T15:58:24",
"upload_time_iso_8601": "2024-10-04T15:58:24.956578Z",
"url": "https://files.pythonhosted.org/packages/fe/c6/8d6116713b4ff1d45c5667ad848aec2c5aa489ba554ab504c19031f8c883/adafruit_circuitpython_adafruitio-5.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a69e4a31f63ac11512c29bd22feb47c65f12f16a68b9e99a47e0655e26f94fdc",
"md5": "5377560597a44716e1434291d64c438e",
"sha256": "f51e3fb5149720cc41e59264f306e54ae5a588c23f44c98761acf14739ea675f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_adafruitio-5.10.0.tar.gz",
"has_sig": false,
"md5_digest": "5377560597a44716e1434291d64c438e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 42219,
"upload_time": "2024-10-04T15:58:26",
"upload_time_iso_8601": "2024-10-04T15:58:26.201842Z",
"url": "https://files.pythonhosted.org/packages/a6/9e/4a31f63ac11512c29bd22feb47c65f12f16a68b9e99a47e0655e26f94fdc/adafruit_circuitpython_adafruitio-5.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 15:58:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_AdafruitIO",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-adafruitio"
}
JSON
