adafruit-mirror/Adafruit_IO_Python
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
117 commits 22 branches 34 tags 615 KiB
Python 99.7%
Makefile 0.3%
Find a file
brentrubell 8d44f82b21
Update README.rst 
added back installation instructions
2018-07-09 17:14:58 -04:00
.github Add GitHub pull request template 2016-05-27 13:23:47 -07:00
Adafruit_IO MQTT/REST Time Helpers (#54) 2018-07-06 15:47:59 -04:00
docs Adding Documentation and Travis to Library (#50) 2018-07-05 12:20:39 -04:00
examples Merge branch 'api-v2' into v2-examples 2018-07-09 15:53:45 -04:00
tests drop retain in on_message 2017-06-29 11:48:25 -05:00
.gitignore update gitignore 2018-05-10 12:46:35 -04:00
.python-version add default .python-version file 2018-05-10 12:46:54 -04:00
.travis.yml Adding Documentation and Travis to Library (#50) 2018-07-05 12:20:39 -04:00
CHANGELOG.md update changelog for error updates 2017-06-29 11:49:22 -05:00
CODE_OF_CONDUCT.md Adding Documentation and Travis to Library (#50) 2018-07-05 12:20:39 -04:00
ez_setup.py Major update: 2015-02-01 12:22:03 -08:00
LICENSE.md added requirement for python3 to setup, updated license 2018-07-02 16:33:31 -04:00
Makefile initial working library 2014-05-27 11:23:53 -05:00
MANIFEST.in Adding Documentation and Travis to Library (#50) 2018-07-05 12:20:39 -04:00
README.rst Update README.rst 2018-07-09 17:14:58 -04:00
requirements.txt Adding Documentation and Travis to Library (#50) 2018-07-05 12:20:39 -04:00
setup.py MQTT/REST Time Helpers (#54) 2018-07-06 15:47:59 -04:00

README.rst 

Adafruit IO Python
==================

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

.. image:: https://img.shields.io/discord/327254708534116352.svg
   :target: https://discord.gg/nBQh6qu
   :alt: Chat

.. image:: https://travis-ci.org/adafruit/io-client-python.svg?branch=master
    :target: https://travis-ci.org/adafruit/io-client-python
    :alt: Build Status

.. image:: https://cdn-learn.adafruit.com/assets/assets/000/057/153/original/adafruit_io_iopython.png?1530802073

A Python client and examples for use with `io.adafruit.com <https://io.adafruit.com>`_. 

Compatible with Python 3.6+

Installation
================

Easy Installation
~~~~~~~~~~~~~~~~~
If you have `PIP <https://pip.pypa.io/en/stable/installing/>`_ installed (typically with apt-get install python-pip on a Debian/Ubuntu-based system) then run:

.. code-block:: shell

   pip install adafruit-io

This will automatically install the Adafruit IO Python client code for your Python scripts to use. You might want to examine the examples folder in this GitHub repository to see examples of usage.


Manual Installation
~~~~~~~~~~~~~~~~~~~

Clone or download the contents of this repository. Then navigate to the folder in a terminal and run the following command:


.. code-block:: shell

   python setup.py install




Usage 
=====

Documentation for this project is `available on the ReadTheDocs <https://adafruit-io-python-client.readthedocs.io/en/latest/>`_.


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

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