Project

walkman

0.0
No commit activity in last 3 years
No release in over 3 years
Control your music
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 10.1

Runtime

~> 4.0.2
~> 1.0
~> 0.1.0
~> 1.4.4
~> 0.18.1
~> 1.3.0
 Project Readme

Walkman

Build Status Code Climate Coverage Status Dependency Status

Walkman puts you in control if your music.

Install

gem install walkman

Dependencies

Walkman relies on a few external services to do its magic. Currently, the canonical source for music data comes from Echo Nest who provides artist/album/song information as well as playlist generation and seeding. Actual music streams are currently provided via Rdio with support for Spotify and local file playback via MPD in the works.

Echo Nest

  1. Sign up for an Echo Nest developer account
  2. Grab the api_key, consumer_key, and shared_secret
  3. Create a catalog (taste profile) to use as your base library and grab its id to use as catalog_id:
curl -F "api_key=<api_key>" -F "format=json" -F "type=general" -F "name=base_profile" "http://developer.echonest.com/api/v4/tasteprofile/create"

Rdio

  1. Sign up for a Rdio developer account
  2. Generate a playback_token after logging in at rdio.com.

Config

Create a Walkman config file at ~/.walkman:

log_level: debug # optional
server:
  host: localhost # optional
  port: 27001 # optional
echonest:
  api_key: APIKEY
  consumer_key: CONSUMERKEY
  shared_secret: SHAREDSECRET
  catalog_id: CATALOGID
rdio:
  player_url: http://localhost:4567/rdio # optional
  playback_token: PLAYBACKTOKEN
  browser_path: /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --no-process-singleton-dialog # optional

Usage

Commands:
  walkman help [COMMAND]            # Describe available commands or one specific command
  walkman like                      # plays more music like the current song
  walkman next                      # plays the next song in the current playlist
  walkman now_playing               # shows the song that's currently playing
  walkman play                      # plays the current playlist
  walkman play_artist ARTIST        # plays songs from the given artist
  walkman play_artist_radio ARTIST  # plays music like the given artist
  walkman shutdown                  # stops the walkman server
  walkman skip COUNT                # skips the given amount of songs
  walkman start                     # starts the walkman server
  walkman stop                      # stops playing music
  walkman up_next                   # shows the next songs on the current playlist