diff options
author | Mike Crute <mike@crute.us> | 2019-04-07 17:53:37 +0000 |
---|---|---|
committer | Mike Crute <mike@crute.us> | 2019-04-07 17:53:59 +0000 |
commit | f304b4ce0d654c224cf9b8bad379e630d740a9b9 (patch) | |
tree | 06921e8eb9e624d597d09595b4f0aa71fde80af8 /README.rst | |
parent | beb84513a899afe6d37036aed73191c7dbcae12c (diff) | |
download | pydora-f304b4ce0d654c224cf9b8bad379e630d740a9b9.tar.bz2 pydora-f304b4ce0d654c224cf9b8bad379e630d740a9b9.tar.xz pydora-f304b4ce0d654c224cf9b8bad379e630d740a9b9.zip |
Add links to APIs
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 40 |
1 files changed, 31 insertions, 9 deletions
@@ -8,7 +8,8 @@ Pandora API Client | |||
8 | .. image:: https://img.shields.io/travis/mcrute/pydora.svg | 8 | .. image:: https://img.shields.io/travis/mcrute/pydora.svg |
9 | :target: https://travis-ci.org/mcrute/pydora | 9 | :target: https://travis-ci.org/mcrute/pydora |
10 | 10 | ||
11 | This code is licensed under the MIT license. | 11 | This code is licensed under the MIT license. The code is maintained on `GitHub |
12 | <https://github.com/mcrute/pydora>`_. | ||
12 | 13 | ||
13 | This is a reasonably complete implementation of the Pandora API in pure Python | 14 | This is a reasonably complete implementation of the Pandora API in pure Python |
14 | that supports Python 3.5+. It contains a complete implementation of the core | 15 | that supports Python 3.5+. It contains a complete implementation of the core |
@@ -22,7 +23,7 @@ for yourself. Make something awesome with this library, don't abuse Pandora, | |||
22 | that's not cool. | 23 | that's not cool. |
23 | 24 | ||
24 | This is the ``2.x`` series which supports only Python 3.5+. For older versions | 25 | This is the ``2.x`` series which supports only Python 3.5+. For older versions |
25 | of Python please use the ``1.x`` series. The ``1.x`` series is no longer | 26 | of Python please use the |1.x|_ series. The |1.x|_ series is no longer |
26 | maintained but pull requests to fix bugs are still welcomed. | 27 | maintained but pull requests to fix bugs are still welcomed. |
27 | 28 | ||
28 | Programmatic Use | 29 | Programmatic Use |
@@ -40,16 +41,16 @@ For example, to depend on version ``2.x`` use this line in your setup.py | |||
40 | 41 | ||
41 | pydora>=2,<3 | 42 | pydora>=2,<3 |
42 | 43 | ||
43 | The easiest way to get started is by using the ``pandora.clientbuilder`` | 44 | 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 | 45 | package. This package contains a set of factories that can be used to build a |
45 | Pandora client with some configuration. The classes in the package that end in | 46 | Pandora client with some configuration. The classes in the package that end in |
46 | ``Builder`` are the factories and the rest of the classes are implementation | 47 | ``Builder`` are the factories and the rest of the classes are implementation |
47 | details. All of the builders will return an instance of | 48 | details. All of the builders will return an instance of |
48 | ``pandora.client.APIClient`` that is completely configured and ready for use in | 49 | |pandora.client.APIClient|_ that is completely configured and ready for use in |
49 | your program. | 50 | your program. |
50 | 51 | ||
51 | If you have an existing program and would like to connect to Pandora the | 52 | If you have an existing program and would like to connect to Pandora the |
52 | easiest way is to use the ``SettingsDictBuilder`` class like so:: | 53 | easiest way is to use the |SettingsDictBuilder|_ class like so:: |
53 | 54 | ||
54 | client = SettingsDictBuilder({ | 55 | client = SettingsDictBuilder({ |
55 | "DECRYPTION_KEY": "see_link_above", | 56 | "DECRYPTION_KEY": "see_link_above", |
@@ -61,12 +62,12 @@ easiest way is to use the ``SettingsDictBuilder`` class like so:: | |||
61 | 62 | ||
62 | client.login("username", "password") | 63 | client.login("username", "password") |
63 | 64 | ||
64 | At this point the client is ready for use, see ``pandora.client.APIClient`` for | 65 | At this point the client is ready for use, see |pandora.client.APIClient|_ for |
65 | a list of methods that can be called. All responses from the API will return | 66 | a list of methods that can be called. All responses from the API will return |
66 | Python objects from the ``pandora.models.pandora`` package or raise exceptions | 67 | Python objects from the |pandora.models.pandora|_ package or raise exceptions |
67 | from ``pandora.errors`` | 68 | from |pandora.errors|_ |
68 | 69 | ||
69 | For a more functional example look at the file ``pydora/player.py`` which shows | 70 | For a more functional example look at the file |pydora/player.py|_ which shows |
70 | how to use the API in a simple command line application. | 71 | how to use the API in a simple command line application. |
71 | 72 | ||
72 | Installing | 73 | Installing |
@@ -198,3 +199,24 @@ Contributors | |||
198 | * Thomas Weißschuh (`@t-8c <https://github.com/t-8ch>`_) | 199 | * Thomas Weißschuh (`@t-8c <https://github.com/t-8ch>`_) |
199 | * Skybound1 (`@Skybound1 <https://github.com/Skybound1>`_) | 200 | * Skybound1 (`@Skybound1 <https://github.com/Skybound1>`_) |
200 | * Hugo (`@hugovk <https://github.com/hugovk>`_) | 201 | * Hugo (`@hugovk <https://github.com/hugovk>`_) |
202 | |||
203 | .. |1.x| replace:: ``1.x`` | ||
204 | .. _1.x: https://github.com/mcrute/pydora/tree/1.x | ||
205 | |||
206 | .. |pandora.clientbuilder| replace:: ``pandora.clientbuilder`` | ||
207 | .. _pandora.clientbuilder: https://github.com/mcrute/pydora/blob/master/pandora/clientbuilder.py | ||
208 | |||
209 | .. |pandora.client.APIClient| replace:: ``pandora.client.APIClient`` | ||
210 | .. _pandora.client.APIClient: https://github.com/mcrute/pydora/blob/master/pandora/client.py#L98 | ||
211 | |||
212 | .. |SettingsDictBuilder| replace:: ``SettingsDictBuilder`` | ||
213 | .. _SettingsDictBuilder: https://github.com/mcrute/pydora/blob/master/pandora/clientbuilder.py#L136 | ||
214 | |||
215 | .. |pandora.models.pandora| replace:: ``pandora.models.pandora`` | ||
216 | .. _pandora.models.pandora: https://github.com/mcrute/pydora/tree/master/pandora/models | ||
217 | |||
218 | .. |pandora.errors| replace:: ``pandora.errors`` | ||
219 | .. _pandora.errors: https://github.com/mcrute/pydora/blob/master/pandora/errors.py | ||
220 | |||
221 | .. |pydora/player.py| replace:: ``pydora/player.py`` | ||
222 | .. _pydora/player.py: https://github.com/mcrute/pydora/blob/master/pydora/player.py | ||