From 7ff956d492d67ff14b99de6b8cf538e35f877a97 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Thu, 11 Dec 2014 16:00:35 -0800 Subject: [PATCH] Docs warning about requests dependency (#1136) --- docs/changelog.rst | 4 ++++ docs/plugins/lyrics.rst | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 24109f756..c5f366f28 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -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 diff --git a/docs/plugins/lyrics.rst b/docs/plugins/lyrics.rst index 643c5e61e..46b40e17f 100644 --- a/docs/plugins/lyrics.rst +++ b/docs/plugins/lyrics.rst @@ -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 -------------