Skip to content
Adafruit IO for CircuitPython
Python
Branch: master
Clone or download
Latest commit 5a7e3bd Jul 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_io fix autodoc in file Jul 17, 2019
docs fixup sphinx Jul 17, 2019
examples drop log from example Jul 17, 2019
.gitignore
.pylintrc add files from pyportal board Feb 19, 2019
.readthedocs.yml add files from pyportal board Feb 19, 2019
.travis.yml add new travis location, remove unnecessary simpletest Jul 17, 2019
CODE_OF_CONDUCT.md
LICENSE add files from pyportal board Feb 19, 2019
README.rst there isnt a dep for esp32spi, drop it. add new examples to readme Jul 17, 2019
requirements.txt add files from pyportal board Feb 19, 2019
setup.py update readme, setup, lib Feb 21, 2019

README.rst

Adafruit_CircuitPython_AdafruitIO

Documentation Status Discord Build Status

CircuitPython wrapper library for communicating with Adafruit IO.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

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 before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-adafruit_io --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.