diff options
author | Mike Crute <mike@crute.us> | 2019-04-07 17:28:03 +0000 |
---|---|---|
committer | Mike Crute <mike@crute.us> | 2019-04-07 17:28:03 +0000 |
commit | beb84513a899afe6d37036aed73191c7dbcae12c (patch) | |
tree | ca3c79619f2a828f0499a8d1672ac40b69f90ffa | |
parent | 33abda0ed3c72da4cee7a4e59669a72a830e0370 (diff) | |
download | pydora-beb84513a899afe6d37036aed73191c7dbcae12c.tar.bz2 pydora-beb84513a899afe6d37036aed73191c7dbcae12c.tar.xz pydora-beb84513a899afe6d37036aed73191c7dbcae12c.zip |
Cleanups to README
-rw-r--r-- | README.rst | 74 |
1 files changed, 37 insertions, 37 deletions
@@ -10,23 +10,23 @@ Pandora API Client | |||
10 | 10 | ||
11 | This code is licensed under the MIT license. | 11 | This code is licensed under the MIT license. |
12 | 12 | ||
13 | This is a reasonably complete implementation of the Pandora API that supports | 13 | This is a reasonably complete implementation of the Pandora API in pure Python |
14 | Python 2 and 3. It does not implement any of the undocumented features and does | 14 | that supports Python 3.5+. It contains a complete implementation of the core |
15 | not implement most of the account management features as they are not terribly | 15 | radio features but does not implement account management or Pandora Plus |
16 | useful. | 16 | functionality; pull requests adding that functionality are welcomed from anyone |
17 | needing those features. | ||
17 | 18 | ||
18 | Keys or passwords for Pandora are **not** provided in this repo, you'll have to | 19 | Keys or passwords for Pandora are **not** provided in this repo, you'll have to |
19 | `go get those <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_ | 20 | `go get those <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_ |
20 | for yourself. Make something awesome with this library, don't abuse Pandora, | 21 | for yourself. Make something awesome with this library, don't abuse Pandora, |
21 | that's not cool. | 22 | that's not cool. |
22 | 23 | ||
23 | As of 1.11.0 users of Python 3.4+ no longer require a native dependency and can | 24 | This is the ``2.x`` series which supports only Python 3.5+. For older versions |
24 | use this package in its pure Python form. Users of older versions of Python | 25 | of Python please use the ``1.x`` series. The ``1.x`` series is no longer |
25 | will require `cryptography <https://pypi.python.org/pypi/cryptography>`_. This | 26 | maintained but pull requests to fix bugs are still welcomed. |
26 | is configured automatically when pydora is installed. | ||
27 | 27 | ||
28 | Programatic Use | 28 | Programmatic Use |
29 | =============== | 29 | ================ |
30 | The pydora distribution contains two python packages. The ``pandora`` package | 30 | The pydora distribution contains two python packages. The ``pandora`` package |
31 | is the API for interacting with the Pandora service. The ``pydora`` package is | 31 | is the API for interacting with the Pandora service. The ``pydora`` package is |
32 | a very small reference implementation of using the API to drive a command line | 32 | a very small reference implementation of using the API to drive a command line |
@@ -35,10 +35,10 @@ Installing below to get started. | |||
35 | 35 | ||
36 | **NOTE:** This package uses semantic versioning. The API is stable within a | 36 | **NOTE:** This package uses semantic versioning. The API is stable within a |
37 | major version release. Please constrain your dependencies to major versions. | 37 | major version release. Please constrain your dependencies to major versions. |
38 | For example, to depend on version 1.x use this line in your setup.py | 38 | For example, to depend on version ``2.x`` use this line in your setup.py |
39 | ``install_requires``:: | 39 | ``install_requires``:: |
40 | 40 | ||
41 | pydora>=1,<2 | 41 | pydora>=2,<3 |
42 | 42 | ||
43 | The easiest way to get started is by using the ``pandora.clientbuilder`` | 43 | The easiest way to get started is by using the ``pandora.clientbuilder`` |
44 | package. This package contains a set of factories that can be used to build a | 44 | package. This package contains a set of factories that can be used to build a |
@@ -73,7 +73,7 @@ Installing | |||
73 | ========== | 73 | ========== |
74 | Installing is as simple as using pip and running the built-in configuration | 74 | Installing is as simple as using pip and running the built-in configuration |
75 | command to create a ``~/.pydora.cfg`` file. If you already have a `PianoBar | 75 | command to create a ``~/.pydora.cfg`` file. If you already have a `PianoBar |
76 | <http://6xq.net/projects/pianobar/>`_ config file pydora will automatically use | 76 | <http://6xq.net/projects/pianobar/>`_ config file Pydora will automatically use |
77 | that. :: | 77 | that. :: |
78 | 78 | ||
79 | $ pip install pydora | 79 | $ pip install pydora |
@@ -85,22 +85,22 @@ On Ubuntu install `vlc` or `vlc`:: | |||
85 | 85 | ||
86 | To install VLC on Mac OS X visit the `VLC site | 86 | To install VLC on Mac OS X visit the `VLC site |
87 | <https://www.videolan.org/vlc/>`_ to download ``VLC.app``, then drag-and-drop | 87 | <https://www.videolan.org/vlc/>`_ to download ``VLC.app``, then drag-and-drop |
88 | the bundle into your ``/Applications`` folder. pydora will auto-detect this. | 88 | the bundle into your ``/Applications`` folder. Pydora will auto-detect this. |
89 | 89 | ||
90 | Audio Output Backend | 90 | Audio Output Back-end |
91 | ==================== | 91 | ===================== |
92 | The ``pydora`` player does not directly support audio output but instead relies | 92 | The ``pydora`` player does not directly support audio output but instead relies |
93 | upon external audio output backends. The two supported backends are VLC and | 93 | upon external audio output back-ends. The two supported back-ends are VLC and |
94 | mpg123. The main difference between the two backends is the supported file | 94 | mpg123. The main difference between the two back-ends is the supported file |
95 | formats. VLC supports a vast array of codecs, including MP3 and AAC, the two | 95 | formats. VLC supports a vast array of codecs, including MP3 and AAC, the two |
96 | formats that Pandora uses. mpg123 on the other hand supports only MP3. As of | 96 | formats that Pandora uses. mpg123 on the other hand supports only MP3. As of |
97 | 2017 Pandora has started to prefer AAC files over MP3 which necessitates VLC. | 97 | 2017 Pandora has started to prefer AAC files over MP3 which necessitates VLC. |
98 | The ``pydora`` player will try to auto-detect whatever player exists on your | 98 | The ``pydora`` player will try to auto-detect whatever player exists on your |
99 | system, prefering VLC, and will use that audio output backend. If you notice a | 99 | system, preferring VLC, and will use that audio output back-end. If you notice |
100 | lot of skipping in a playlist consider installing VLC. | 100 | a lot of skipping in a playlist consider installing VLC. |
101 | 101 | ||
102 | Remote VLC Backend | 102 | Remote VLC Back-end |
103 | ------------------ | 103 | ------------------- |
104 | It is also possible to remotely control a copy of VLC running on another | 104 | It is also possible to remotely control a copy of VLC running on another |
105 | machine if you're unable or unwilling to install Pydora on your playback | 105 | machine if you're unable or unwilling to install Pydora on your playback |
106 | machine. To do this start VLC on the remote machine with the ``rc-host`` option | 106 | machine. To do this start VLC on the remote machine with the ``rc-host`` option |
@@ -115,7 +115,7 @@ remote host and port that VLC is listening on. For example:: | |||
115 | 115 | ||
116 | Pydora will now send all audio playback requests to the remote VLC. It does | 116 | Pydora will now send all audio playback requests to the remote VLC. It does |
117 | this using a text control protocol; all audio data is streamed directly from | 117 | this using a text control protocol; all audio data is streamed directly from |
118 | the internet to VLC and is not passed over the pydora control channel. Because | 118 | the internet to VLC and is not passed over the Pydora control channel. Because |
119 | of this it is possible for the control channel to run over a very low bandwidth | 119 | of this it is possible for the control channel to run over a very low bandwidth |
120 | connection. | 120 | connection. |
121 | 121 | ||
@@ -132,25 +132,25 @@ a settings file (example below) located in ``~/.pydora.cfg``. Alternatively an | |||
132 | environment variable ``PYDORA_CFG`` can point to the path of the config file. | 132 | environment variable ``PYDORA_CFG`` can point to the path of the config file. |
133 | 133 | ||
134 | The player only supports basic functionality for now. It will display a station | 134 | The player only supports basic functionality for now. It will display a station |
135 | list, allow listening to any station, basic feeback and bookmarking are also | 135 | list, allow listening to any station, basic feedback and bookmarking are also |
136 | supported. The player starts an mpg123 or VLC process in remote control mode | 136 | supported. The player starts an mpg123 or VLC process in remote control mode |
137 | and feeds commands to it. It does not download any music but rather streams | 137 | and feeds commands to it. It does not download any music but rather streams |
138 | them directly from Pandora. | 138 | them directly from Pandora. |
139 | 139 | ||
140 | When playing the following keys work (press enter afterwards): | 140 | When playing the following keys work (press enter afterwards): |
141 | 141 | ||
142 | * n - next song | 142 | * ``n`` - next song |
143 | * p - pause or resume song | 143 | * ``p`` - pause or resume song |
144 | * s - station list (stops song) | 144 | * ``s`` - station list (stops song) |
145 | * d - thumbs down track | 145 | * ``d`` - thumbs down track |
146 | * u - thumbs up track | 146 | * ``u`` - thumbs up track |
147 | * b - bookmark song | 147 | * ``b`` - bookmark song |
148 | * a - bookmark artist | 148 | * ``a`` - bookmark artist |
149 | * S - sleep song | 149 | * ``S`` - sleep song |
150 | * Q - quit program | 150 | * ``Q`` - quit program |
151 | * vu - volume up | 151 | * ``vu`` - volume up |
152 | * vd - volume down | 152 | * ``vd`` - volume down |
153 | * ? - display help | 153 | * ``?`` - display help |
154 | 154 | ||
155 | Note that volume control is currently only supported with the VLC back-end. | 155 | Note that volume control is currently only supported with the VLC back-end. |
156 | 156 | ||
@@ -174,7 +174,7 @@ Sample Config File | |||
174 | **default_audio_quality** | 174 | **default_audio_quality** |
175 | Default audio quality to request from the API; can be one of `lowQuality`, | 175 | Default audio quality to request from the API; can be one of `lowQuality`, |
176 | `mediumQuality` (default), or `highQuality`. If the preferred audio quality | 176 | `mediumQuality` (default), or `highQuality`. If the preferred audio quality |
177 | is not available for the device specified, then the next-highest bitrate | 177 | is not available for the device specified, then the next-highest bit-rate |
178 | stream that Pandora supports for the chosen device will be used. | 178 | stream that Pandora supports for the chosen device will be used. |
179 | 179 | ||
180 | Pandora API Spec and Partner Keys | 180 | Pandora API Spec and Partner Keys |