Updated documents and changelog.

This commit is contained in:
Alok Saboo 2022-05-17 15:30:51 -04:00
parent 9420cf4c6c
commit 19e2a11ea0
2 changed files with 22 additions and 1 deletions

View file

@ -8,6 +8,10 @@ Changelog goes here!
New features:
* :doc:`/plugins/spotify`: The plugin now provides an additional command
`spotifysync` that allows getting track popularity and audio features
information from Spotify.
:bug:`4094`
* :doc:`/plugins/spotify`: The plugin now records Spotify-specific IDs in the
`spotify_album_id`, `spotify_artist_id`, and `spotify_track_id` fields.
:bug:`4348`

View file

@ -19,6 +19,7 @@ Why Use This Plugin?
* You have playlists or albums you'd like to make available in Spotify from Beets without having to search for each artist/album/track.
* You want to check which tracks in your library are available on Spotify.
* You want to autotag music with metadata from the Spotify API.
* You want to obtain track popularity and audio features (e.g., danceability)
Basic Usage
-----------
@ -58,7 +59,7 @@ configuration options are provided.
The default options should work as-is, but there are some options you can put
in config.yaml under the ``spotify:`` section:
- **mode**: One of the following:
- **mode**: One of the following:
- ``list``: Print out the playlist as a list of links. This list can then
be pasted in to a new or existing Spotify playlist.
@ -105,3 +106,19 @@ Here's an example::
}
]
Obtaining Track Popularity and Audio Features from Spotify
----------------------------------------------------------
Spotify provides track `popularity`_ and audio `features`_ that be used to
create better playlists.
.. _popularity: https://developer.spotify.com/documentation/web-api/reference/#/operations/get-track
.. _features: https://developer.spotify.com/documentation/web-api/reference/#/operations/get-audio-features
The ``spotify`` plugin provides an additional command ``spotifysync`` to obtain
these track attributes from Spotify:
* ``beet spotifysync [-f]``: obtain popularity and audio features information
for every track in the library. By default, ``spotifysync`` will skip tracks
that already have this information populated. Using the ``-f`` or ``-force``
option will download the data even for tracks that already have it.