Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-04 06:53:27 +01:00
Code Issues Projects Releases Wiki Activity

docs and changelog for #243

Browse source 
Also note that this fixes #162.
This commit is contained in:
Adrian Sampson 2013-04-15 11:08:43 -07:00
parent 2a9afd3908
commit 2a3a12ee0b
2 changed files with 36 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/changelog.rst
View file

@ -7,6 +7,9 @@ Changelog
* :doc:`/plugins/embedart`: The ``embedart`` command now embeds each album's
associated art by default. The ``--file`` option invokes the old behavior,
in which a specific image file is used.
* :doc:`/plugins/lyrics`: A new (optional) Google Custom Search backend was
added for finding lyrics on a wide array of sites. Thanks to Fabrice
Laporte.
* When automatically detecting the filesystem's maximum filename length, never
guess more than 200 characters. This prevents errors on systems where the
maximum length was misreported. You can, of course, override this default
@ -14,6 +17,9 @@ Changelog
* Avoid some error cases in the ``update`` command and the ``embedart`` and
``mbsync`` plugins. Invalid or missing files now cause error logs instead of
crashing beets. Thanks to Lucas Duailibe.
* :doc:`/plugins/lyrics`: Searches now strip "featuring" artists when
searching for lyrics, which should increase the hit rate for these tracks.
Thanks to Fabrice Laporte.
* :doc:`/plugins/web`: Fix an error when specifying the hostname on the
command line.
* :doc:`/plugins/web`: The underlying API was expanded slightly to support

47
docs/plugins/lyrics.rst
View file

@ -2,17 +2,12 @@ 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`_ and `Lyrics.com`_.
Namely, the current version of the plugin uses `Lyric Wiki`_, `Lyrics.com`_,
and, optionally, the Google custom search API.
.. _Lyric Wiki: http://lyrics.wikia.com/
.. _Lyrics.com: http://www.lyrics.com/
:ref:`_activate-google-custom-search` to expand the plugin firepower, by using google search to harvest lyrics from your own websites list.
By default if no lyrics are found, the file will be left unchanged. To specify a placeholder for the lyrics tags when none are found, use the ``fallback`` configuration option.
lyrics:
fallback: 'No lyrics found'
Fetch Lyrics During Import
--------------------------
@ -26,6 +21,7 @@ be written to the files' tags.
This behavior can be disabled with the ``auto`` config option (see below).
Fetching Lyrics Manually
------------------------
@ -40,36 +36,53 @@ 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.
Configuring
-----------
The plugin has one configuration option, ``auto``, which lets you disable
automatic lyrics fetching during import. To do so, add this to your
``config.yaml``::
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:
Activate Google custom search
------------------------------
Using Google backend requires `beautifulsoup`_, which you can install using `pip`_ by typing::
Using the Google backend requires `BeautifulSoup`_, which you can install
using `pip`_ by typing::
pip install beautifulsoup4
To activate google search you must first register an API key on https://code.google.com/apis/console. Then click *API Access* and use that key for the `google_API_key` plugin option.
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 on http://www.google.com/cse/all. Click the *Search engine ID* button to display the token to copy into the `google_engine_ID` option.
By default, beets use a list of sources known to be scrapable.
.. _register for a Google API key: https://code.google.com/apis/console.
Example of ``config.yaml``::
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.
.. _define a custom search engine: http://www.google.com/cse/all
Here's an example 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.
.. _pip: http://www.pip-installer.org/
.. _beautifulsoup: http://www.crummy.com/software/BeautifulSoup/bs4/doc/
.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/bs4/doc/