remove tokenfile doc, use active voice

This commit is contained in:
Rahul Ahuja 2019-01-20 14:40:32 -08:00
parent 7b1e64a61f
commit f61aacf04b

View file

@ -2,14 +2,10 @@ Spotify Plugin
==============
The ``spotify`` plugin generates `Spotify`_ playlists from tracks in your
library with the ``beet spotify`` command. Using the `Spotify Search API`_,
any tracks that can be matched with a Spotify ID are returned, and the
results can be either pasted in to a playlist or opened directly in the
Spotify app.
library with the ``beet spotify`` command using the `Spotify Search API`_.
Spotify URLs and IDs may also be provided to the ``Enter release ID:`` prompt
during ``beet import`` to autotag music with data from the Spotify
`Album`_ and `Track`_ APIs.
Also, the plugin can use the Spotify `Album`_ and `Track`_ APIs to provide
metadata matches for the importer.
.. _Spotify: https://www.spotify.com/
.. _Spotify Search API: https://developer.spotify.com/documentation/web-api/reference/search/search/
@ -58,23 +54,11 @@ Command-line options include:
* ``--show-failures`` or ``-f``: List the tracks that did not match a Spotify
ID.
A Spotify ID or URL may also be provided to the ``Enter release ID:``
You can enter the URL for an album or song on Spotify at the ``enter Id``
prompt during import::
Enter search, enter Id, aBort, eDit, edit Candidates, plaY? i
Enter release ID: https://open.spotify.com/album/2rFYTHFBLQN3AYlrymBPPA
Tagging:
Bear Hands - Blue Lips / Ignoring the Truth / Back Seat Driver (Spirit Guide) / 2AM
URL:
https://open.spotify.com/album/2rFYTHFBLQN3AYlrymBPPA
(Similarity: 88.2%) (source, tracks) (Spotify, 2019, Spensive Sounds)
* Blue Lips (feat. Ursula Rose) -> Blue Lips (feat. Ursula Rose) (source)
* Ignoring the Truth -> Ignoring the Truth (source)
* Back Seat Driver (Spirit Guide) -> Back Seat Driver (Spirit Guide) (source)
* 2AM -> 2AM (source)
[A]pply, More candidates, Skip, Use as-is, as Tracks, Group albums,
Enter search, enter Id, aBort, eDit, edit Candidates, plaY?
Configuration
-------------
@ -106,9 +90,6 @@ in config.yaml under the ``spotify:`` section:
track/album/artist fields before sending them to Spotify. Can be useful for
changing certain abbreviations, like ft. -> feat. See the examples below.
Default: None.
- **tokenfile**: Filename of the JSON file stored in the beets configuration
directory to use for caching the OAuth access token.
Default: ``spotify_token.json``.
- **source_weight**: Penalty applied to Spotify matches during import. Set to
0.0 to disable.
Default: ``0.5``.
@ -119,7 +100,6 @@ Here's an example::
client_id: N3dliiOOTBEEFqCH5NDDUmF5Eo8bl7AN
client_secret: 6DRS7k66h4643yQEbepPxOuxeVW0yZpk
source_weight: 0.7
tokenfile: my_spotify_token.json
mode: open
region_filter: US
show_failures: on