-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Tiny code and docs fixes for gmusic (#2586)
- Loading branch information
Showing
2 changed files
with
29 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,48 +1,49 @@ | ||
Gmusic Plugin | ||
============= | ||
|
||
This plugin allows you to manage your Google Play Music library with beets. | ||
The ``gmusic`` plugin lets you upload songs to Google Play Music and query | ||
songs in your library. | ||
|
||
|
||
Installation | ||
------------ | ||
|
||
The plugin requires `gmusic`_. You can install it using `pip`:: | ||
The plugin requires `gmusicapi`_. You can install it using `pip`:: | ||
|
||
pip install gmusicapi | ||
|
||
.. _gmusic: https://github.com/simon-weber/gmusicapi/ | ||
.. _gmusicapi: https://github.com/simon-weber/gmusicapi/ | ||
|
||
Usage | ||
----- | ||
Then, you can enable the ``gmusic`` plugin in your configuration (see | ||
:ref:`using-plugins`). | ||
|
||
To use the ``gmusic`` plugin, enable it in your configuration file. | ||
|
||
Then, add your Google email and password to configuration file under a ``gmusic`` section, if you want to be able to search for songs in your library. | ||
It's not necessary if you only upload files. :: | ||
|
||
gmusic: | ||
email: email | ||
password: password | ||
Usage | ||
----- | ||
|
||
To upload tracks to Google Play Music, use the ``gmusic-upload`` command:: | ||
|
||
If you want to upload your tracks use ``gmusic-upload`` command:: | ||
beet gmusic-upload [QUERY] | ||
|
||
beet gmusic-upload [ARGS...] | ||
If you don't include a query, the plugin will upload your entire collection. | ||
|
||
If no arguments are provided, it will upload your entire beet collection. | ||
To query the songs in your collection, you will need to add your Google | ||
credentials to your beets configuration file. Put your Google username and | ||
password under a section called ``gmusic``, like so:: | ||
|
||
In case you want to search for songs in your Google Music library just use:: | ||
gmusic: | ||
email: user@example.com | ||
password: seekrit | ||
|
||
beet gmusic-songs [OPTS...] [ARGS...] | ||
Then, use the ``gmusic-songs`` command to list music:: | ||
|
||
Options: | ||
-a, --artist search by artist name | ||
-t, --track search by track | ||
beet gmusic-songs [-at] [ARGS] | ||
|
||
For example:: | ||
Use the ``-a`` option to search by artist and ``-t`` to search by track. For | ||
example:: | ||
|
||
beet gmusic-songs -a John Frusciante | ||
beet gmusic-songs -t Black Hole Sun | ||
|
||
If you want a list of all songs simply leave it without arguments and options. | ||
For a list of all songs in your library, run ``beet gmusic-songs`` without any | ||
arguments. |