jepler/Adafruit_CircuitPython_AdafruitIO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
184 commits 3 branches 22 tags 302 KiB
Python 100%
Find a file
Kattni Rembor c2b262e73b Add correct libname to folders.
2020-04-10 13:31:41 -04:00
.github/workflows build.yml: add black formatting check 2020-04-07 16:10:10 -05:00
adafruit_io Black reformatting with Python 3 target. 2020-04-09 16:19:54 -04:00
docs Update examples.rst to use new simpletest. 2020-04-10 13:29:17 -04:00
examples Add correct libname to folders. 2020-04-10 13:31:41 -04:00
.gitignore Switched from Travis to GitHub Actions 2020-01-09 09:19:18 -05:00
.pylintrc update pylintrc for black 2020-03-08 19:08:39 -05:00
.readthedocs.yml add files from pyportal board 2019-02-19 17:00:05 -05:00
CODE_OF_CONDUCT.md update code of coduct: discord moderation contact section 2020-03-15 18:29:37 -05:00
LICENSE add files from pyportal board 2019-02-19 17:00:05 -05:00
README.rst Tiny change to re-bump 2020-03-20 12:50:30 -04:00
requirements.txt add files from pyportal board 2019-02-19 17:00:05 -05:00
setup.py Ran black, updated to pylint 2.x 2020-03-12 19:36:35 -04:00

README.rst 

Adafruit_CircuitPython_AdafruitIO
=================================

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-adafruitio/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/adafruitio/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :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

CircuitPython wrapper library for communicating with `Adafruit IO <http://io.adafruit.com>`_.


Dependencies
============

This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

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 .env
    source .env/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.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Adafruit_IO/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

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>`_.