No description
Find a file
Andrew Dunai c8ab0672c2
Merge pull request #2 from sjkingo/fix-setuptools-requires
Fixed typo in setuptools install_requires
2018-01-31 11:12:58 +02:00
clay Added CLAY_DEBUG that writes all Google Play Music traffic to /tmp/clay-api-log.json 2018-01-30 20:54:57 +02:00
docs Docs 2018-01-09 20:49:50 +02:00
images Initial 2017-12-28 15:09:40 +02:00
.flake8 Cleanups 2018-01-02 11:26:55 +02:00
.gitignore Docs 2018-01-06 14:01:57 +02:00
.pylintrc Cleanup & refactoring. 2018-01-08 21:54:25 +02:00
.travis.yml Linting 2018-01-06 01:58:53 +02:00
activate.sh Initial 2017-12-28 15:09:40 +02:00
LICENSE Initial commit 2017-12-28 15:06:14 +02:00
Makefile Docs 2018-01-06 14:01:57 +02:00
README.md Readme update. 2018-01-29 13:53:10 +02:00
requirements.txt Added codename. 2018-01-30 16:26:20 +02:00
setup.py Fixed typo in setuptools install_requires 2018-01-31 18:50:36 +10:00
tox.ini Linting 2018-01-06 01:58:53 +02:00

Clay [alpha]

Build Status Documentation Status

Standalone command line player for Google Play Music.

This app wouldn't be possible without the wonderful gmusicapi and VLC libraries.

This project is neither affiliated nor endorsed by Google.

It's being actively developed, but is still in the early alpha version, so many features are missing and/or may be bugged.

(Click the image below to see the screencast.)

asciicast

Installation

sudo pip install clay-player
clay

Documentation

Documentation is available here.

Requirements

What works

  • Playback
  • Music library browsing & management
  • Playlists
  • Radio stations
  • Song search
  • Filtering results
  • Queue management
  • Notifications
  • Audio equalizer
  • Global hotkeys
  • Configuration UI
  • Token caching for faster authorizations
  • Song operations (add to library, start station etc.)
  • Caching (not for song data, that one is coming soon)
  • PYPI package

What is being developed

  • Like/dislike tracks
  • Playlist editing
  • Artist/album search
  • Other functionality that is supported by gmusicapi

Installation

  1. Install Python 3 and VLC.

Method 1 (automatic)

  1. Source the 'activate.sh' script. It will initialize the Python virtual env and install the dependencies:

    source activate.sh
    
  2. Run the player:

    ./clay/app.py
    

Method 2 (manual)

  1. Create & activate virtualenv:

    virtualenv .env
    source .env/bin/activate
    
  2. Install the requirements:

    pip install -r requirements.txt
    
  3. Run the player:

    ./clay/app.py
    

Configuration

In order to use this app, you need to know your Device ID. Typically gmusicapi should display possible IDs once you type a wrong one. Also be aware that this app has not been tested with 2FA yet.

Controls

General

  • <UP|DOWN|LEFT|RIGHT> - nagivate around
  • <ALT> + 1..9 - switch active tab

Songs

  • <ENTER> - play highlighted track
  • <CTRL> w - play/pause
  • <CTRL> e - play next song
  • <CTRL> a - append highlighted song to the queue
  • <CTRL> u - remove highlighted song from the queue
  • <CTRL> p - start station from highlighted song
  • <ALT> m - show context menu for this song

Playback

  • <CTRL> s - toggle shuffle
  • <CTRL> r - toggle song repeat
  • <SHIFT> <LEFT|RIGHT> - seek backward/forward by 5% of the song duration
  • <CTRL> q - seek to song beginning

Misc

  • <ESC> or <CTRL> / or _ - close most recent notification
  • <CTRL> x - exit app

Credits

Made by Andrew Dunai.

Regards to gmusicapi and VLC who made this possible.