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

Fixing a few links that were not converted from markdown to RST via #23.

Browse source
This commit is contained in:
Adam Coddington 2014-08-26 23:49:44 -07:00
parent d2bdb86ce6
commit eff8d21a6d
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.rst
View file

@ -1,4 +1,4 @@
PyiCloud is a module which allows pythonistas to interact with iCloud webservices. It's powered by the fantastic [requests](https://github.com/kennethreitz/requests) HTTP library. PyiCloud is a module which allows pythonistas to interact with iCloud webservices. It's powered by the fantastic `requests <https://github.com/kennethreitz/requests>`_ HTTP library.
At its core, PyiCloud connects to iCloud using your username and password, then performs calendar and iPhone queries against their API. At its core, PyiCloud connects to iCloud using your username and password, then performs calendar and iPhone queries against their API.
@ -149,7 +149,7 @@ And when you have a file that you'd like to download, the `open` method will ret
>>> api.files['com~apple~Notes']['Documents']['Some Document'].open().content >>> api.files['com~apple~Notes']['Documents']['Some Document'].open().content
'Hello, these are the file contents' 'Hello, these are the file contents'
Note: the object returned from the above `open` method is a [response object](http://www.python-requests.org/en/latest/api/#classes) and the `open` method can accept any parameters you might normally use in a request using [requests](https://github.com/kennethreitz/requests). Note: the object returned from the above `open` method is a `response object <http://www.python-requests.org/en/latest/api/#classes>`_ and the `open` method can accept any parameters you might normally use in a request using `requests <https://github.com/kennethreitz/requests>`_.
For example, if you know that the file you're opening has JSON content: For example, if you know that the file you're opening has JSON content:
@ -162,4 +162,4 @@ Or, if you're downloading a particularly large file, you may want to use the `st
>>> download = api.files['com~apple~Notes']['Documents']['big_file.zip'].open(stream=True) >>> download = api.files['com~apple~Notes']['Documents']['big_file.zip'].open(stream=True)
>>> with open('downloaded_file.zip', 'wb') as opened_file: >>> with open('downloaded_file.zip', 'wb') as opened_file:
opened_file.write(download.raw.read()) opened_file.write(download.raw.read())