@@ -2,22 +2,25 @@ MetaSync Plugin
2
2
===============
3
3
4
4
This plugin provides the ``metasync `` command, which lets you fetch certain
5
- metadata from other local or remote sources, for example your favorite audio
6
- player.
5
+ metadata from other sources: for example, your favorite audio player.
7
6
8
- Currently we support the following list of metadata sources:
9
- - **amarok **: This syncs rating, score, first played, last played, playcount and uid from amarok.
7
+ Currently, the plugin supports synchronizing with the `Amarok `_ music player.
8
+ It can fetch the rating, score, first-played date, last-played date, play
9
+ count, and track uid from Amarok.
10
10
11
+ .. _Amarok : https://amarok.kde.org/
11
12
12
- Installing Dependencies
13
- -----------------------
14
13
15
- Fetching metadata from amarok requires the dbus-python library.
14
+ Installation
15
+ ------------
16
16
17
- There are packages for most major linux distributions, or you can download the
18
- library from its _website.
17
+ Enable the ``metasync `` plugin in your configuration (see
18
+ :ref: `using-plugins `).
19
+
20
+ To synchronize with Amarok, you'll need the `dbus-python `_ library. There are
21
+ packages for most major Linux distributions.
19
22
20
- _website : http://dbus.freedesktop.org/releases/dbus-python/
23
+ .. _ dbus-python : http://dbus.freedesktop.org/releases/dbus-python/
21
24
22
25
23
26
Configuration
@@ -26,16 +29,16 @@ Configuration
26
29
To configure the plugin, make a ``metasync: `` section in your configuration
27
30
file. The available options are:
28
31
29
- - **source **: A list of sources to fetch metadata from.
32
+ - **source **: A list of sources to fetch metadata from. Set this to "amarok"
33
+ to enable synchronization with that player.
30
34
Default: empty
31
35
32
36
33
37
Usage
34
38
-----
35
39
36
- Enable the ``metasync `` plugin in your configuration (see
37
- :ref: `using-plugins `) then run ``beet metasync QUERY `` to fetch updated
38
- metadata from the configured list of sources.
40
+ Run ``beet metasync QUERY `` to fetch metadata from the configured list of
41
+ sources.
39
42
40
43
The command has a few command-line options:
41
44
0 commit comments