Skip to content

Commit 0711172

Browse files
committed
Docs fixes for metasync: #1386
1 parent 59b2e41 commit 0711172

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

docs/changelog.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Changelog
55
-----------------------
66

77
This little update makes queries more powerful and removes a performance
8-
bottleneck.
8+
bottleneck. There's an experimental new plugin for synchronizing metadata with
9+
music players.
910

1011
Packagers should also note a new dependency in this version: the `Jellyfish`_
1112
Python library makes our text comparisons (a big part of the auto-tagging
@@ -17,6 +18,8 @@ New features:
1718
query, items and albums will match *either* side of the comma. For example,
1819
``beet ls foo , bar`` will get all the items matching `foo` or matching
1920
`bar`. See :ref:`combiningqueries`. :bug:`1423`
21+
* An experimental new :doc:`/plugins/metasync` lets you get metadata from your
22+
favorite music players, starting with Amarok. :bug:`1386`
2023
* The autotagger's **matching algorithm is faster**. We now use the
2124
`Jellyfish`_ library to compute string similarity, which is better optimized
2225
than our hand-rolled edit distance implementation. :bug:`1389`

docs/plugins/metasync.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@ MetaSync Plugin
22
===============
33

44
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.
76

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.
1010

11+
.. _Amarok: https://amarok.kde.org/
1112

12-
Installing Dependencies
13-
-----------------------
1413

15-
Fetching metadata from amarok requires the dbus-python library.
14+
Installation
15+
------------
1616

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.
1922

20-
_website: http://dbus.freedesktop.org/releases/dbus-python/
23+
.. _dbus-python: http://dbus.freedesktop.org/releases/dbus-python/
2124

2225

2326
Configuration
@@ -26,16 +29,16 @@ Configuration
2629
To configure the plugin, make a ``metasync:`` section in your configuration
2730
file. The available options are:
2831

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.
3034
Default: empty
3135

3236

3337
Usage
3438
-----
3539

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.
3942

4043
The command has a few command-line options:
4144

0 commit comments

Comments
 (0)