mirror of
https://github.com/beetbox/beets.git
synced 2026-02-22 23:33:50 +01:00
Update gmusic.rst
This commit is contained in:
parent
b1d5cc1485
commit
2b031be99c
1 changed files with 44 additions and 21 deletions
|
|
@ -20,14 +20,7 @@ Then, you can enable the ``gmusic`` plugin in your configuration (see
|
|||
|
||||
Usage
|
||||
-----
|
||||
|
||||
To automatically upload all tracks to Google Play Music, add the ``auto: yes``
|
||||
parameter to your configuration file like the example below::
|
||||
|
||||
gmusic:
|
||||
auto: yes
|
||||
email: user@example.com
|
||||
password: seekrit
|
||||
**Configuration required before use.**
|
||||
|
||||
To upload tracks to Google Play Music, use the ``gmusic-upload`` command::
|
||||
|
||||
|
|
@ -35,19 +28,7 @@ To upload tracks to Google Play Music, use the ``gmusic-upload`` command::
|
|||
|
||||
If you don't include a query, the plugin will upload your entire 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::
|
||||
|
||||
gmusic:
|
||||
email: user@example.com
|
||||
password: seekrit
|
||||
|
||||
If you have enabled two-factor authentication in your Google account, you will
|
||||
need to set up and use an *application-specific password*. You can obtain one
|
||||
from your Google security settings page.
|
||||
|
||||
Then, use the ``gmusic-songs`` command to list music::
|
||||
To list your music collection, use the ``gmusic-songs`` command::
|
||||
|
||||
beet gmusic-songs [-at] [ARGS]
|
||||
|
||||
|
|
@ -59,3 +40,45 @@ example::
|
|||
|
||||
For a list of all songs in your library, run ``beet gmusic-songs`` without any
|
||||
arguments.
|
||||
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
To configure the plugin, make a ``gmusic:`` section in your configuration file.
|
||||
The available options are:
|
||||
|
||||
- **email**: Your Google account email address.
|
||||
Default: none.
|
||||
- **password**: Password to your Google account. Required to query songs in
|
||||
your collection.
|
||||
For accounts with 2-step-verification, an
|
||||
`app password <https://support.google.com/accounts/answer/185833?hl=en>`__
|
||||
will need to be generated. An app password for an account without
|
||||
2-step-verification is not required but is recommended.
|
||||
Default: none.
|
||||
- **auto**: Set to ``yes`` to automatically upload new imports to Google Play
|
||||
Music.
|
||||
Default: ``no``
|
||||
- **uploader_id**: Unique id as a MAC address, eg ``'00:11:22:33:AA:BB'``.
|
||||
This option should be set before the maximum number of authorized devices is
|
||||
reached.
|
||||
If provided, use the same id for all future runs on this, and other, beets
|
||||
installations as to not reach the maximum number of authorized devices.
|
||||
Default: device's MAC address.
|
||||
- **device_id**: Unique device ID for authorized devices.
|
||||
This option only needs to be set if you receive an `InvalidDeviceId`
|
||||
exception. Below the exception will be a list of valid device IDs.
|
||||
Default: none.
|
||||
|
||||
Refer to the `Google Play Music Help
|
||||
<https://support.google.com/googleplaymusic/answer/3139562?hl=en>`__
|
||||
page for more details on authorized devices.
|
||||
|
||||
Below is an example configuration::
|
||||
|
||||
gmusic:
|
||||
email: user@example.com
|
||||
password: seekrit
|
||||
auto: yes
|
||||
uploader_id: 00:11:22:33:AA:BB
|
||||
device_id: F96AE4C643A5
|
||||
|
|
|
|||
Loading…
Reference in a new issue