Skip to content

Commit

Permalink
Add documentation for metadata sync plugin.
Browse files Browse the repository at this point in the history
  • Loading branch information
pprkut committed Apr 18, 2015
1 parent c50d59f commit 4c65981
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Each plugin has its own set of options that can be defined in a section bearing
lyrics
mbcollection
mbsync
metasync
missing
mpdstats
mpdupdate
Expand Down Expand Up @@ -104,6 +105,7 @@ Metadata
* :doc:`lastimport`: Collect play counts from Last.fm.
* :doc:`lyrics`: Automatically fetch song lyrics.
* :doc:`mbsync`: Fetch updated metadata from MusicBrainz
* :doc:`metasync`: Fetch metadata from local or remore sources
* :doc:`mpdstats`: Connect to `MPD`_ and update the beets library with play
statistics (last_played, play_count, skip_count, rating).
* :doc:`replaygain`: Calculate volume normalization for players that support it.
Expand Down
45 changes: 45 additions & 0 deletions docs/plugins/metasync.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
MetaSync Plugin
===============

This plugin provides the ``metasync`` command, which lets you fetch certain
metadata from other local or remote sources, for example your favorite audio
player.

Currently we support the following list of metadata sources:
- **amarok**: This syncs rating, score, first played, last played, playcount and uid from amarok.


Installing Dependencies
-----------------------

Fetching metadata from amarok requires the dbus-python library.

There are packages for most major linux distributions, or you can download the
library from its _website.

_website: http://dbus.freedesktop.org/releases/dbus-python/


Configuration
-------------

To configure the plugin, make a ``metasync:`` section in your configuration
file. The available options are:

- **source**: A list of sources to fetch metadata from.
Default: empty


Usage
-----

Enable the ``metasync`` plugin in your configuration (see
:ref:`using-plugins`) then run ``beet metasync QUERY`` to fetch updated
metadata from the configured list of sources.

The command has a few command-line options:

* To preview the changes that would be made without applying them, use the
``-p`` (``--pretend``) flag.
* To specify a temporary source to fetch metadata from, use the ``-s``
(``--source``) flag.

0 comments on commit 4c65981

Please sign in to comment.