Update Documentation for fanart.tv

This commit is contained in:
wordofglass 2016-04-15 02:23:22 +02:00
parent ecc6e1c3d6
commit 8a8b8f832a

View file

@ -50,13 +50,15 @@ file. The available options are:
- **sources**: List of sources to search for images. An asterisk `*` expands
to all available sources.
Default: ``coverart itunes amazon albumart``, i.e., everything but
``wikipedia`` and ``google``. Enable those two sources for more matches at
the cost of some speed.
``wikipedia``, ``google`` and ``fanarttv``. Enable those sources for more
matches at the cost of some speed.
- **google_key**: Your Google API key (to enable the Google Custom Search
backend).
Default: None.
- **google_engine**: The custom search engine to use.
Default: The `beets custom search engine`_, which searches the entire web.
**fanarttv_personal_key**: The personal API key for requesting art from
fanart.tv. See below.
Note: ``minwidth`` and ``enforce_ratio`` options require either `ImageMagick`_
or `Pillow`_.
@ -162,6 +164,21 @@ default engine searches the entire web for cover art.
Note that the Google custom search API is limited to 100 queries per day.
After that, the fetchart plugin will fall back on other declared data sources.
Fanart.tv
.........
Although not strictly necesarry right now, you might think about
`registering a personal fanart.tv API key`_. Set the ``fanarttv_personal_key``
configurati option to your key, then add ``fanarttv`` to the list of sources in
your configuration.
.. _registering a personal fanart.tv API key: https://fanart.tv/get-an-api-key/
More detailed information can be found `on their blog`_. Specifically, the
personal key will give you earlier access to new art.
.. _on their blog: https://fanart.tv/2015/01/personal-api-keys/
Embedding Album Art
-------------------