Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 3.12 KB

lyrics.rst

File metadata and controls

91 lines (61 loc) · 3.12 KB
Raw

Lyrics Plugin

The lyrics plugin fetches and stores song lyrics from databases on the Web. Namely, the current version of the plugin uses Lyric Wiki, Lyrics.com, and, optionally, the Google custom search API.

Fetch Lyrics During Import

To automatically fetch lyrics for songs you import, just enable the plugin by putting lyrics on your config file's plugins line (see /plugins/index). When importing new files, beets will now fetch lyrics for files that don't already have them. The lyrics will be stored in the beets database. If the import.write config option is on, then the lyrics will also be written to the files' tags.

This behavior can be disabled with the auto config option (see below).

Fetching Lyrics Manually

The lyrics command provided by this plugin fetches lyrics for items that match a query (see /reference/query). For example, beet lyrics magnetic fields absolutely cuckoo will get the lyrics for the appropriate Magnetic Fields song, beet lyrics magnetic fields will get lyrics for all my tracks by that band, and beet lyrics will get lyrics for my entire library. The lyrics will be added to the beets database and, if import.write is on, embedded into files' metadata.

The -p option to the lyrics command makes it print lyrics out to the console so you can view the fetched (or previously-stored) lyrics.

The -f option forces the command to fetch lyrics, even for tracks that already have lyrics.

Configuring

To disable automatic lyric fetching during import, set the auto option to false, like so:

lyrics:
    auto: no

By default, if no lyrics are found, the file will be left unchanged. To specify a placeholder for the lyrics tag when none are found, use the fallback configuration option:

lyrics:
    fallback: 'No lyrics found'

Activate Google custom search

Using the Google backend requires BeautifulSoup, which you can install using pip by typing:

pip install beautifulsoup4

You also need to register for a Google API key. Set the google_API_key configuration option to your key. This enables the Google backend.

Optionally, you can define a custom search engine. Get your search engine's token and use it for your google_engine_ID configuration option. By default, beets use a list of sources known to be scrapeable.

Here's an example of config.yaml:

lyrics:
  google_API_key: AZERTYUIOPQSDFGHJKLMWXCVBN1234567890_ab
  google_engine_ID: 009217259823014548361:lndtuqkycfu

Note that the Google custom search API is limited to 100 queries per day. After that, the lyrics plugin will fall back on its other data sources.