PySpeak

A ThingSpeak API wrapper for Python


License
MIT
Install
pip install PySpeak==0.1.5

Documentation

PySpeak

PySpeak is an interface to the ThingSpeak API for use with the Python Language.

Installation

pip install PySpeak

Create a new object with

obj = pyspeak.Channel(id, [url], [read_key], [write_key])
  • The default url for a new channel is api.thingspeak.com

Object methods are provided for reading a channel, reading a field, and updating.

get_channel_feed(self, last_entry=False, fmt='json', opts={})

  • last_entry (bool) - If True, only the most recent value will be returned
  • fmt (str) - json, csv, or xml. Returns the data as on object of the given type
  • opts (dict) - A dict of optional values to be passed via url params

get_field_feed(self, field_id, last_entry=False, fmt='json', opts={})

  • field_id (int or str) - The id of the field to be retrieved
  • last_entry (bool) - If True, only the most recent value will be returned
  • fmt (str) - json, csv, or xml. Returns the data as on object of the given type
  • opts (dict) - A dict of optional values to be passed via url params

update_channel(self, opts)

  • opts (dict) - A dict of values to be passed vie url params

Testing

If you want to run the test for PySpeak, be sure to run pip install -r requirements.txt to download the requirements first. You'll also need to take a look at the config.sample.py file, fill it with your channel info, and rename it to config.py. Make sure you create a channel for testing only or else these tests will store trash data in your channel.