Skip to content

Latest commit

 

History

History
110 lines (63 loc) · 5.59 KB

README.md

File metadata and controls

110 lines (63 loc) · 5.59 KB
Raw

#gmusicapi: an unofficial Python API for Google Play Music

This project allows control of Google Music from Python. It is not supported nor endorsed by Google.

Respect Google in your use of the API. Use common sense (protocol compliance, reasonable load, etc) and don't ruin the fun for everyone else.

For those looking to use the api, see the installation and usage sections below. Documentation is hosted at Read the Docs: documentation.

For those looking to port or contribute, see the porting section below. There's also a code overview on the wiki: wiki.

For bugs reports, feature requests, and contributions, go ahead and open an issue.

Also, check out these nifty projects that use gmusicapi:

##Features

New in version 2013.01.05

  • compatibility update for playlist modification
  • note that there are various problems related to uploading at the moment - they'll be addressed in a future release

Feature Overview:

  • Getting library information:

    • all song metadata
    • all user playlist titles and ids
    • songs from a specific playlist

  • Song streaming and downloading

  • Song uploading of all Google-supported file formats (currently flaky)

  • Playlist manipulation:

    • creation
    • name modification
    • song deletion, addition, and reordering

  • Song manipulation:

    • metadata modification (be sure to read the documentation)
    • removal from library

  • Searching for songs, artists, and albums.

Coming soon:

  • album art manipulation
  • better upload support
  • better documentation

##Usage

The API has been tested on Python 2.7.2 on Linux and Windows.

###Installation

If you're not comfortable installing from source:

  • Linux users: use pip install gmusicapi to get the most recent version and dependencies.

  • Windows users: there is an installation binary on PyPI.

To upload filetypes other than mp3, you're going to need FFmpeg installed and in your system path. For Ubuntu users: sudo apt-get install ffmpeg ubuntu-restricted-extras. Windows users, get the most recent static binaries and then edit your path to include the directory that contains ffmpeg.exe.

To check that everything is set up correctly, you can run the test suite: python -m gmusicapi.test.integration_test_api. If something goes wrong during testing, there is the chance that you'll end up with an extra playlist or test song in your library, but it should never destructively modify your library. If there is an error during testing, please open an issue to let me know about it. You should also submit your gmusicapi.log.

###Getting Started

gmusicapi.api.Api is the user-facing interface. The provided example.py should be enough to get you started. For complete information, see the documentation. The testing code might also be useful.

##Ports

Here are the ports I'm currently aware of:

###Porting Information for Developers

Get in touch if you're working on a port. Even if I can't contribute, I might know people who'd like to.

The current implementation uses the same interface that a web browser does, and a code overview can be found on the wiki. Darryl Pogue is worked on a more durable implementation by emulating Google's Android app. His work is here, and may easier to port. More information this alternative protocol is here.

Either way, you'll probably want to ignore anything related to Music Manager; that's just for uploading. If uploading interests you, more information is here.

Lastly, keep the license in mind, and, again, be sure to respect Google.

##Notes

Debug logging is enabled by default. All logging is done to gmusicapi.log in your working directory, with warnings and above printed to the console. Nothing related to authenticated gets logged aside from "logged in" and "logged out" messages.

Copyright 2012 Simon Weber.
Licensed under the 3-clause BSD. See COPYING.

githalytics.com alpha