Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-aws-iot/badge/?version=latest
:target: https://docs.circuitpython.org/projects/aws_iot/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_AWS_IOT/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT/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
Amazon AWS IoT MQTT Client for CircuitPython.
**Note**: This library requires version **>=1.4.0** of the `Adafruit fork of the Arduino NINA-W102 firmware <https://github.com/adafruit/nina-fw>`_
installed on your ESP32 Airlift/WiFi Co-Processor.
If you do not know how to do this, `visit the Adafruit Learning System guide for this topic... <https://learn.adafruit.com/upgrading-esp32-firmware>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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-aws_iot/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-aws-iot
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-aws-iot
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-aws-iot
Usage Example
=============
Library examples within examples/ folder.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/aws_iot/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_AWS_IOT/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-aws-iot",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,aws_iot,aws,,iot,,amazon,,mqtt,,client",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/78/6b/b1d287f21ce4a3a3acdf147cfcfcdedc1bb8e79b25ae818317c42be093d0/adafruit-circuitpython-aws-iot-2.0.17.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/circuitpython-aws-iot/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/aws_iot/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_AWS_IOT/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT/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\nAmazon AWS IoT MQTT Client for CircuitPython.\n\n\n**Note**: This library requires version **>=1.4.0** of the `Adafruit fork of the Arduino NINA-W102 firmware <https://github.com/adafruit/nina-fw>`_\n installed on your ESP32 Airlift/WiFi Co-Processor.\n\nIf you do not know how to do this, `visit the Adafruit Learning System guide for this topic... <https://learn.adafruit.com/upgrading-esp32-firmware>`_\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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-aws_iot/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-aws-iot\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-aws-iot\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-aws-iot\n\nUsage Example\n=============\n\nLibrary examples within examples/ folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/aws_iot/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_AWS_IOT/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Amazon AWS IoT MQTT Client for CircuitPython",
"version": "2.0.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"aws_iot",
"aws",
"",
"iot",
"",
"amazon",
"",
"mqtt",
"",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2077d2b8b5a0a02bd36f48e19a08401847ba459a61857a1d977625bdd182f39f",
"md5": "6a46e61f4e595aa1718eaf224f8aaa3e",
"sha256": "aa2210a1ecbb0d5c00858423a293373cd2908dcd3fdc1721c6cf7247fdd19af0"
},
"downloads": -1,
"filename": "adafruit_circuitpython_aws_iot-2.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a46e61f4e595aa1718eaf224f8aaa3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6539,
"upload_time": "2023-12-09T17:37:02",
"upload_time_iso_8601": "2023-12-09T17:37:02.815385Z",
"url": "https://files.pythonhosted.org/packages/20/77/d2b8b5a0a02bd36f48e19a08401847ba459a61857a1d977625bdd182f39f/adafruit_circuitpython_aws_iot-2.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "786bb1d287f21ce4a3a3acdf147cfcfcdedc1bb8e79b25ae818317c42be093d0",
"md5": "b8aeeb914dbe5d82665873e91540b9ee",
"sha256": "54e97479450b41d0f35a11d663d721fc66a3ad7b6336c110a2f0b9035d72cf0e"
},
"downloads": -1,
"filename": "adafruit-circuitpython-aws-iot-2.0.17.tar.gz",
"has_sig": false,
"md5_digest": "b8aeeb914dbe5d82665873e91540b9ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30014,
"upload_time": "2023-12-09T17:37:04",
"upload_time_iso_8601": "2023-12-09T17:37:04.080734Z",
"url": "https://files.pythonhosted.org/packages/78/6b/b1d287f21ce4a3a3acdf147cfcfcdedc1bb8e79b25ae818317c42be093d0/adafruit-circuitpython-aws-iot-2.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:37:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_AWS_IOT",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-aws-iot"
}
JSON
