diff options
| author | Mike Crute <mcrute@gmail.com> | 2015-07-10 20:02:15 -0700 |
|---|---|---|
| committer | Mike Crute <mcrute@gmail.com> | 2015-07-10 20:02:15 -0700 |
| commit | 7d2f463b324bc302c3cef9521090cb12ca7a3962 (patch) | |
| tree | 062247f134c8171f9cf1f75877832caffc9cc216 /README.rst | |
| parent | 0f0a029ec14c033166eac9413ebd516c9bc2fd40 (diff) | |
| download | pydora-7d2f463b324bc302c3cef9521090cb12ca7a3962.tar.bz2 pydora-7d2f463b324bc302c3cef9521090cb12ca7a3962.tar.xz pydora-7d2f463b324bc302c3cef9521090cb12ca7a3962.zip | |
Update readme
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 30 |
1 files changed, 28 insertions, 2 deletions
| @@ -2,6 +2,15 @@ | |||
| 2 | Pandora API Client | 2 | Pandora API Client |
| 3 | ================== | 3 | ================== |
| 4 | 4 | ||
| 5 | .. image:: https://img.shields.io/pypi/v/pydora.svg | ||
| 6 | :target: https://pypi.python.org/pypi/pydora | ||
| 7 | |||
| 8 | .. image:: https://img.shields.io/travis/mcrute/pydora.svg | ||
| 9 | :target: https://travis-ci.org/mcrute/pydora | ||
| 10 | |||
| 11 | .. image:: https://img.shields.io/pypi/dm/pydora.svg | ||
| 12 | :target: https://pypi.python.org/pypi/pydora | ||
| 13 | |||
| 5 | This code is licensed under the MIT license. | 14 | This code is licensed under the MIT license. |
| 6 | 15 | ||
| 7 | This is a reasonably complete implementation of the Pandora API. It does not | 16 | This is a reasonably complete implementation of the Pandora API. It does not |
| @@ -12,8 +21,15 @@ I don't provide any keys or passwords for Pandora in this repo, you'll have to | |||
| 12 | go get those for yourself. Make something awesome with this library, don't | 21 | go get those for yourself. Make something awesome with this library, don't |
| 13 | abuse Pandora, that's not cool. | 22 | abuse Pandora, that's not cool. |
| 14 | 23 | ||
| 15 | * API Spec from: http://6xq.net/playground/pandora-apidoc/ | 24 | Installing |
| 16 | * Keys at: http://6xq.net/playground/pandora-apidoc/json/partners/#partners | 25 | ========== |
| 26 | Installing is as simple as using pip and running the built-in configuration | ||
| 27 | command to create a ``~/.pydora.cfg`` file. If you already have a `PianoBar | ||
| 28 | <http://6xq.net/projects/pianobar/>`_ config file pydora will automatically use | ||
| 29 | that. :: | ||
| 30 | |||
| 31 | $ pip install pydora | ||
| 32 | $ pydora-configure | ||
| 17 | 33 | ||
| 18 | Simple Player | 34 | Simple Player |
| 19 | ============= | 35 | ============= |
| @@ -61,3 +77,13 @@ sample config:: | |||
| 61 | `mediumQuality` (default), or `highQuality`. If the preferred audio quality | 77 | `mediumQuality` (default), or `highQuality`. If the preferred audio quality |
| 62 | is not available for the device specified, then the next-highest bitrate | 78 | is not available for the device specified, then the next-highest bitrate |
| 63 | stream that Pandora supports for the chosen device will be used. | 79 | stream that Pandora supports for the chosen device will be used. |
| 80 | |||
| 81 | Pandora API Spec and Partner Keys | ||
| 82 | ================================= | ||
| 83 | The built-in ``pydora-configure`` script can be run to create a configuration | ||
| 84 | file if you don't already have one. This will download the keys from the link | ||
| 85 | below and pick a suitable one. If you're interested in the underlying API or | ||
| 86 | need to download the keys yourself you can find them at the link below. | ||
| 87 | |||
| 88 | * `API Spec <http://6xq.net/playground/pandora-apidoc/>`_ | ||
| 89 | * `Partner Keys <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_ | ||