diff options
| author | Filipp Lepalaan <filipp@mac.com> | 2018-04-02 15:30:00 +0300 |
|---|---|---|
| committer | Filipp Lepalaan <filipp@mac.com> | 2018-04-02 15:30:00 +0300 |
| commit | e9c225e5c227ef89a53c2a04619a4d044d6a9791 (patch) | |
| tree | 3b88fd7e966476a43e8079abca02c06d0d47f86f /README.rst | |
| parent | f85a1af076fa6dd93f711252608f85704e8d2d67 (diff) | |
| download | py-gsxws-e9c225e5c227ef89a53c2a04619a4d044d6a9791.tar.gz py-gsxws-e9c225e5c227ef89a53c2a04619a4d044d6a9791.tar.bz2 py-gsxws-e9c225e5c227ef89a53c2a04619a4d044d6a9791.zip | |
Update doc links, convert to Markdown
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/README.rst b/README.rst deleted file mode 100644 index 65beb57..0000000 --- a/README.rst +++ /dev/null @@ -1,57 +0,0 @@ -******** -py-gsxws -******** - -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 -- contents of requirements.pip -- GSX client certs and valid Apple ID with access to GSX Web Services - -Installation:: - - 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:: - - # check warranty status - import os - import gsxws - os.environ['GSX_CERT'] = '/path/to/gsx/client/cert.pem' - os.environ['GSX_KEY'] = '/path/to/gsx/client/cert_private_key.pem' - gsxws.connect(apple_id, sold_to) - mac = gsxws.Product('70033CDFA4S') - mac.warranty() - - # get available parts for this machine - mac.parts() - -Check the tests-folder for more examples. - - -*** -FAQ -*** - -Q: My script keeps prompting me for the private key passphrase - how could I automate this? -A: One way would be to remove the passphrase from the key: - - $ openssl rsa -in privatekey.pem -out privatekey.nopass.pem - |