Docs warning about requests dependency (#1136)

This commit is contained in:
Adrian Sampson 2014-12-11 16:00:35 -08:00
parent 7d07c2d947
commit 7ff956d492
2 changed files with 12 additions and 0 deletions

View file

@ -4,6 +4,10 @@ Changelog
1.3.10 (in development)
-----------------------
One backwards-compatibility note: the :doc:`/plugins/lyrics` now requires the
`requests`_ library. If you use this plugin, you will need to install the
library by typing ``pip install requests`` or the equivalent for your OS.
New:
* A new :doc:`/plugins/permissions` makes it easy to fix permissions on music

View file

@ -14,11 +14,19 @@ Fetch Lyrics During Import
To automatically fetch lyrics for songs you import, enable the ``lyrics``
plugin in your configuration (see :ref:`using-plugins`).
Then, install the `requests`_ library by typing::
pip install requests
The plugin uses `requests`_ to download lyrics.
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.
.. _requests: http://docs.python-requests.org/en/latest/
Configuration
-------------