aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorFilipp Lepalaan <filipp@mac.com>2014-12-23 11:37:58 +0200
committerFilipp Lepalaan <filipp@mac.com>2014-12-23 11:37:58 +0200
commit3cfc3e7de1b14273924ceb95d9e7b5e0c971ff77 (patch)
tree224417bfdee59b35965037da338bbde1145c127b /README.rst
parentc1d744de2e3f59a18bd0943f29911ccafba7c1b5 (diff)
downloadpy-gsxws-3cfc3e7de1b14273924ceb95d9e7b5e0c971ff77.tar.gz
py-gsxws-3cfc3e7de1b14273924ceb95d9e7b5e0c971ff77.tar.bz2
py-gsxws-3cfc3e7de1b14273924ceb95d9e7b5e0c971ff77.zip
PyPI-compatibility changes
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3c77d40
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,35 @@
+********
+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.
+
+Installation:
+
+ pip install -U -e git+git://github.com/filipp/py-gsxws.git#egg=gsxws
+
+
+It goes a little something like this:
+
+ # check warranty status
+ import gsxws
+ gsxws.connect(apple_id, password, sold_to)
+ mac = gsxws.Product('70033CDFA4S')
+ mac.warranty()
+
+ # get available parts for this machine
+ mac.parts()
+
+
+Check the tests-folder for more examples.
+
+
+************
+Requirements
+************
+
+- Python 2.7 or later
+- lxml
+- PyYAML