simono41/pyicloud
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updating documentation to reflect new API additions.

Browse source
This commit is contained in:
Adam Coddington 2013-05-18 19:32:54 -07:00
parent 8b5e907896
commit 5d3b2e3e9b
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -15,6 +15,36 @@ Authentication is as simple as passing your username and password to the `PyiClo
In the event that the username/password combination is invalid, a `PyiCloudFailedLoginException` exception is thrown.
### Devices
You can list which devices associated with your account by using the `devices` property:
```python
>>> api.devices
{
u'i9vbKRGIcLYqJnXMd1b257kUWnoyEBcEh6yM+IfmiMLh7BmOpALS+w==': <AppleDevice(iPhone 4S: Johnny Appleseed's iPhone)>,
u'reGYDh9XwqNWTGIhNBuEwP1ds0F/Lg5t/fxNbI4V939hhXawByErk+HYVNSUzmWV': <AppleDevice(MacBook Air 11": Johnny Appleseed's MacBook Air)>
}
```
and you can access individual devices by either their index, or their ID:
```python
>>> api.devices[0]
<AppleDevice(iPhone 4S: Johnny Appleseed's iPhone)>
>>> api.devices['i9vbKRGIcLYqJnXMd1b257kUWnoyEBcEh6yM+IfmiMLh7BmOpALS+w==']
<AppleDevice(iPhone 4S: Johnny Appleseed's iPhone)>
```
or, as a shorthand if you have only one associated apple device, you can simply use the `iphone` property to access the first device associated with your account:
```python
>>> api.iphone
<AppleDevice(iPhone 4S: Johnny Appleseed's iPhone)>
```
Note: the first device associated with your account may not necessarily be your iPhone.
### Find My iPhone
Once you have successfully authenticated, you can start querying your data!