Skip to content
This repository has been archived by the owner on Oct 11, 2021. It is now read-only.

Commit

Permalink
Add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
markpasc committed May 10, 2011
1 parent 855f755 commit 28d0515
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 0 deletions.
20 changes: 20 additions & 0 deletions LICENSE
@@ -0,0 +1,20 @@
Copyright 2011 Mark Paschal.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
52 changes: 52 additions & 0 deletions README.markdown
@@ -0,0 +1,52 @@
# rdio-cli #

`rdio-cli` is a command line application for controlling some Rdio API functions.

Currently it supports listing your playlists and shuffling a playlist.


## Installation ##

Install it as any other Python program:

$ python setup.py install

If you don't want to install its dependencies to your system, try installing it in a [virtual environment](http://www.virtualenv.org/). As the Rdio client library is distributed as an egg, installing it with `pip` doesn't work. You can manually install [the `rdio` dependency from github](https://github.com/rdio/rdio-python) if you must use `pip`.


## Configuring ##

First, you'll need a Rdio API key. You can [register and create a key at developer.rdio.com](http://developer.rdio.com/). Once you have a key, run the `configure` command:

$ rdio configure
Consumer token: urjECXo8luFeEKw1NrjioUbd
Consumer secret: b0PZPLO9hb
Open this URL in your web browser to get an API PIN:

https://www.rdio.com/oauth/authorize?oauth_token=FGTgBlc5lLylBrOgWA37l4zP

PIN: 7496
Configured!

This saves an OAuth access token to your home directory in an `.rdio` file, so take care with it! Subsequent commands then use that access token to authenticate, so you need only configure the keys once.


## Usage ##

See `rdio --help` for supported commands.

$ rdio playlists
+--------------------------------------------------------------+--------------------+--------------+---------+
| Name | Owner | Relationship | Key |
+--------------------------------------------------------------+--------------------+--------------+---------+
| ska | Mark Paschal | Owner | p113050 |
| Minimix: Cervidae and their predators | Mark Paschal | Owner | p47494 |
| Minimix: BBC Sound of 2009 | Mark Paschal | Owner | p18363 |
| Like! | Masayoshi Sekimura | Subscriber | p66901 |
| 2010 | Andre Torrez | Subscriber | p6557 |
+--------------------------------------------------------------+--------------------+--------------+---------+

$ rdio shuffle p113050
100% |#######################################################################################################|

$

0 comments on commit 28d0515

Please sign in to comment.