Add default config yaml to each data source docs

This commit is contained in:
Šarūnas Nejus 2025-10-05 21:19:27 +01:00
parent 203c2176d9
commit 01e2eb4665
No known key found for this signature in database
4 changed files with 59 additions and 36 deletions

View file

@ -27,14 +27,17 @@ Configuration
-------------
This plugin can be configured like other metadata source plugins as described in
:ref:`metadata-source-plugin-configuration`. In addition, the following
configuration options are provided.
:ref:`metadata-source-plugin-configuration`.
- **search_limit**: The maximum number of results to return from Deezer for each
search query. Default: ``5``.
Default
~~~~~~~
The default options should work as-is, but there are some options you can put in
config.yaml under the ``deezer:`` section:
.. code-block:: yaml
deezer:
data_source_mismatch_penalty: 0.0
search_limit: 5
search_query_ascii: no
- **search_query_ascii**: If set to ``yes``, the search query will be converted
to ASCII before being sent to Deezer. Converting searches to ASCII can enhance

View file

@ -65,38 +65,45 @@ Configuration
This plugin can be configured like other metadata source plugins as described in
:ref:`metadata-source-plugin-configuration`.
There is one additional option in the ``discogs:`` section, ``index_tracks``.
Index tracks (see the `Discogs guidelines`_) along with headers, mark divisions
between distinct works on the same release or within works. When
``index_tracks`` is enabled:
Default
~~~~~~~
.. code-block:: yaml
discogs:
index_tracks: yes
data_source_mismatch_penalty: 0.0
search_limit: 5
apikey: REDACTED
apisecret: REDACTED
tokenfile: discogs_token.json
user_token: REDACTED
index_tracks: no
append_style_genre: no
separator: ', '
strip_disambiguation: yes
beets will incorporate the names of the divisions containing each track into the
imported track's title. Default: ``no``.
- **index_tracks**: Index tracks (see the `Discogs guidelines`_) along with
headers, mark divisions between distinct works on the same release or within
works. When enabled, beets will incorporate the names of the divisions
containing each track into the imported track's title. Default: ``no``.
For example, importing `divisions album`_ would result in track names like:
For example, importing `divisions album`_ would result in track names like:
.. code-block:: text
.. code-block:: text
Messiah, Part I: No.1: Sinfony
Messiah, Part II: No.22: Chorus- Behold The Lamb Of God
Athalia, Act I, Scene I: Sinfonia
Messiah, Part I: No.1: Sinfony
Messiah, Part II: No.22: Chorus- Behold The Lamb Of God
Athalia, Act I, Scene I: Sinfonia
whereas with ``index_tracks`` disabled you'd get:
whereas with ``index_tracks`` disabled you'd get:
.. code-block:: text
.. code-block:: text
No.1: Sinfony
No.22: Chorus- Behold The Lamb Of God
Sinfonia
No.1: Sinfony
No.22: Chorus- Behold The Lamb Of God
Sinfonia
This option is useful when importing classical music.
Other configurations available under ``discogs:`` are:
This option is useful when importing classical music.
- **append_style_genre**: Appends the Discogs style (if found) to the genre tag.
This can be useful if you want more granular genres to categorize your music.
@ -106,9 +113,6 @@ Other configurations available under ``discogs:`` are:
"Electronic". Default: ``False``
- **separator**: How to join multiple genre and style values from Discogs into a
string. Default: ``", "``
- **search_limit**: The maximum number of results to return from Discogs. This
is useful if you want to limit the number of results returned to speed up
searches. Default: ``5``
- **strip_disambiguation**: Discogs uses strings like ``"(4)"`` to mark distinct
artists and labels with the same name. If you'd like to use the discogs
disambiguation in your tags, you can disable it. Default: ``True``

View file

@ -17,17 +17,21 @@ To use the ``musicbrainz`` plugin, enable it in your configuration (see
Configuration
-------------
This plugin can be configured like other metadata source plugins as described in
:ref:`metadata-source-plugin-configuration`.
Default
~~~~~~~
.. code-block:: yaml
musicbrainz:
data_source_mismatch_penalty: 0.0
search_limit: 5
host: musicbrainz.org
https: no
ratelimit: 1
ratelimit_interval: 1.0
search_limit: 5
extra_tags: []
genres: no
external_ids:

View file

@ -65,11 +65,25 @@ Configuration
-------------
This plugin can be configured like other metadata source plugins as described in
:ref:`metadata-source-plugin-configuration`. In addition, the following
configuration options are provided.
:ref:`metadata-source-plugin-configuration`.
The default options should work as-is, but there are some options you can put in
config.yaml under the ``spotify:`` section:
Default
~~~~~~~
.. code-block:: yaml
spotify:
data_source_mismatch_penalty: 0.0
search_limit: 5
mode: list
region_filter:
show_failures: no
tiebreak: popularity
regex: []
search_query_ascii: no
client_id: REDACTED
client_secret: REDACTED
tokenfile: spotify_token.json
- **mode**: One of the following:
@ -98,8 +112,6 @@ config.yaml under the ``spotify:`` section:
enhance search results in some cases, but in general, it is not recommended.
For instance ``artist:deadmau5 album:4×4`` will be converted to
``artist:deadmau5 album:4x4`` (notice ``×!=x``). Default: ``no``.
- **search_limit**: The maximum number of results to return from Spotify for
each search query. Default: ``5``.
Here's an example: