Skip to content

Commit 65320a3

Browse files
committed
Merge pull request #7 from gblanchard4/readme-cleanup
Readme cleanup
2 parents 6903a36 + b5eb9e4 commit 65320a3

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# adafruit-io
22

3-
A [Python](https://www.python.org/) client for use with with [io.adafruit.com](https://io.adafruit.com). Compatible with both Python 2.7+ and Python 3.3+.
3+
A [Python](https://www.python.org/) client for use with [io.adafruit.com](https://io.adafruit.com). Compatible with both Python 2.7+ and Python 3.3+.
44

55
## Installation
66

77
### Easy Installation
88

99
**NOTE: MODULE IS NOT YET ON PYPA SO THIS DOES NOT WORK YET. SKIP TO MANUAL INSTALL BELOW.**
1010

11-
If you have [pip installed](https://pip.pypa.io/en/latest/installing.html)
12-
(typically with ````apt-get install python-pip```` on a Debian/Ubuntu-based
11+
If you have [pip installed](https://pip.pypa.io/en/latest/installing.html)
12+
(typically with ````apt-get install python-pip```` on a Debian/Ubuntu-based
1313
system) then run:
1414

1515
sudo pip install adafruit-io
@@ -25,7 +25,7 @@ in a terminal and run the following command:
2525

2626
### Raspberry Pi SSL Note
2727

28-
Note on a Raspberry Pi with Python 2.7.3 you might see warnings like:
28+
On a Raspberry Pi with Python 2.7.3 you might see warnings like:
2929

3030
InsecurePlatformWarning: A true SSLContext object is not available. This prevents urllib3 from configuring SSL appropriately and may cause certain SSL connections to fail. For more information, see https://urllib3.readthedocs.org/en/latest/security.html#insecureplatformwarning.
3131

@@ -42,7 +42,7 @@ Restart the Pi and you should see the warnings disappear.
4242
## Usage
4343

4444
You must have an [Adafruit IO key](https://learn.adafruit.com/adafruit-io/api-key) to use this library and the Adafruit IO service.
45-
Your API key will be provided to the python library so it can authenticate your
45+
Your API key will be provided to the python library so it can authenticate your
4646
requests against the Adafruit IO service.
4747

4848
At a high level the Adafruit IO python client provides two interfaces to the
@@ -51,7 +51,7 @@ service:
5151
* A thin wrapper around the REST-based API. This is good for simple request and
5252
response applications like logging data.
5353

54-
* A MQTT client (based on [paho-mqtt](https://pypi.python.org/pypi/paho-mqtt))
54+
* A MQTT client (based on [paho-mqtt](https://pypi.python.org/pypi/paho-mqtt))
5555
which can publish and subscribe to feeds so it is immediately alerted of changes.
5656
This is good for applications which need to know when something has changed as
5757
quickly as possible.
@@ -79,7 +79,7 @@ mqtt = MQTTClient('xxxxxxxxxxxx')
7979

8080
Again where 'xxxxxxxxxxxx' is your Adafruit IO API key.
8181

82-
Your program can use either or both the REST API client and MQTT client,
82+
Your program can use either or both the REST API client and MQTT client,
8383
depending on your needs.
8484

8585
### Error Handling
@@ -91,7 +91,7 @@ generally are children of the base exception type `AdafruitIOError`.
9191

9292
### Quickstart
9393

94-
Here's a short example of how to send a new value to a feed (creating the feed
94+
Here's a short example of how to send a new value to a feed (creating the feed
9595
if it doesn't exist), and how to read the most recent value from the feed. This
9696
example uses the REST API.
9797

@@ -154,7 +154,7 @@ pydoc Adafruit_IO.errors
154154
### Feeds
155155

156156
[Feeds](https://learn.adafruit.com/adafruit-io/feeds) are the core of the Adafruit IO system. The feed holds metadata about data
157-
that gets pushed, and you will have one feed for each type of data you send to
157+
that gets pushed, and you will have one feed for each type of data you send to
158158
the system. You can have separate feeds for each sensor in a project, or you can
159159
use one feed to contain JSON encoded data for all of your sensors.
160160

@@ -176,8 +176,8 @@ feed = Feed(name='Foo')
176176
result = aio.create_feed(feed)
177177
```
178178

179-
Note that you can use the [send](#send) function to create a feed and send it a
180-
new value in a single call. It's recommended that you use send instead of
179+
Note that you can use the [send](#send) function to create a feed and send it a
180+
new value in a single call. It's recommended that you use send instead of
181181
manually constructing feed instances.
182182

183183
#### Feed Retrieval
@@ -198,7 +198,7 @@ for f in feeds:
198198
print('Feed: {0}'.format(f.name))
199199
```
200200

201-
Alternatively you can retrieve the metadata for a single feed by calling
201+
Alternatively you can retrieve the metadata for a single feed by calling
202202
`feeds(feed)` and passing the name, ID, or key of a feed to retrieve:
203203

204204
```python
@@ -234,8 +234,8 @@ aio.delete_feed('Test')
234234

235235
### Data
236236

237-
Data represents the data contained in feeds. You can read, add, modify, and
238-
delete data. There are also a few convienient methods for sending data to feeds
237+
Data represents the data contained in feeds. You can read, add, modify, and
238+
delete data. There are also a few convenient methods for sending data to feeds
239239
and selecting certain pieces of data.
240240

241241
#### Data Creation
@@ -371,7 +371,7 @@ print('Data value: {0}'.format(data.value))
371371

372372
##### Previous
373373

374-
You can get the the last record that has been processed (read) by using the
374+
You can get the last record that has been processed (read) by using the
375375
`receive_previous(feed)` method.
376376

377377
```python
@@ -395,7 +395,7 @@ TBD: Document using the MQTT client. For now see the [examples\mqtt_client.py](
395395

396396
### Groups
397397

398-
[Groups](https://learn.adafruit.com/adafruit-io/groups) allow you to update and retrieve multiple feeds with one request. You can
398+
[Groups](https://learn.adafruit.com/adafruit-io/groups) allow you to update and retrieve multiple feeds with one request. You can
399399
add feeds to multiple groups.
400400

401401
#### Group Creation
@@ -422,7 +422,7 @@ for g in groups:
422422
print('Group {0} has {1} feed(s).'.format(g.name, len(g.feeds)))
423423
```
424424

425-
You can also get a specific group by ID, key, or name by using the
425+
You can also get a specific group by ID, key, or name by using the
426426
`groups(group)` method:
427427

428428
```python

0 commit comments

Comments
 (0)