diff options
author | Filipp Lepalaan <filipp@mac.com> | 2014-12-23 12:29:29 +0200 |
---|---|---|
committer | Filipp Lepalaan <filipp@mac.com> | 2014-12-23 12:29:29 +0200 |
commit | fc8a24c1efec73e0a5097411c676feed3dd4aec8 (patch) | |
tree | b9b8efd55fee1c38bea9c3478d2b5ee7d9f785a2 /README.rst | |
parent | c7582871f9beb1b29dfc594f2d6607486da321eb (diff) | |
download | py-gsxws-fc8a24c1efec73e0a5097411c676feed3dd4aec8.tar.gz py-gsxws-fc8a24c1efec73e0a5097411c676feed3dd4aec8.tar.bz2 py-gsxws-fc8a24c1efec73e0a5097411c676feed3dd4aec8.zip |
Updated readme
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 36 |
1 files changed, 23 insertions, 13 deletions
@@ -2,14 +2,33 @@ py-gsxws ******** -py-gsxws is a Python library designed to work with Apple's GSX Web Services API. -The goal is for it to support all the features of the API. -Currently it supports most of them. +gsxws is a Python library designed to work with Apple's GSX Web Services API. +The goal is for it to support all the features of the API. Currently it supports most of them. + +Please consult the `GSXWS API documentation <https://gsxwsut.apple.com/apidocs/ut/html/WSHome.html>`_ for more details. + + +************ +Requirements +************ + +- Python 2.7 or later +- lxml +- PyYAML +- A valid Apple ID with access to GSX Web Services. Installation:: - pip install -U -e git+git://github.com/filipp/py-gsxws.git#egg=gsxws + pip install gsxws + +... or grab the latest dev version:: + pip install -U -e git+git://github.com/filipp/py-gsxws.git#egg=gsxws + + +***** +Usage +***** It goes a little something like this:: @@ -24,12 +43,3 @@ It goes a little something like this:: Check the tests-folder for more examples. - - -************ -Requirements -************ - -- Python 2.7 or later -- lxml -- PyYAML |