Commit graph

1313 commits

Author SHA1 Message Date
Nicholas Boyd Isacsson
913d51af5c Preserve rule order in substitute configuration 2024-10-05 15:51:41 +02:00
Nicholas Boyd Isacsson
65096c425a Update changelog and documentation 2024-10-05 15:51:41 +02:00
Karl-Ludwig Besser
39acba5200
Merge branch 'master' into ftintitle_keep_artist 2024-09-05 12:32:20 +02:00
Karl Besser
aa891d21d4 Add example use case of keep_artist option to docs
Update the documentation of the new `keep_in_artist` option, adding an
example use case.
2024-09-05 12:15:53 +02:00
Šarūnas Nejus
5b5c564a69
autobpm: Add a new beat_track_kwargs configuration option to autobpm 2024-08-19 22:44:16 +01:00
Šarūnas Nejus
03cf567a90
autobpm: Add autobpm extra and update the docs
Given that librosa has been introducing breaking changes like there's no
tomorrow, use '^' version specifier to only allow updating the patch
version.
2024-08-19 22:44:16 +01:00
Karl Besser
a11b557a6d Fix typo in docs 2024-07-10 13:05:58 -04:00
Karl Besser
acb4680c72 Add keep_in_artist option to ftintitle documentation 2024-07-09 23:55:33 -04:00
Šarūnas Nejus
7bbd215efc
Update all docs with Poetry 2024-06-10 13:10:16 +01:00
J0J0 Todos
d510177820
Merge pull request #5121 from mgoltzsche/generate-playlist-item-attributes 2024-04-20 08:04:32 +02:00
Max Goltzsche
2e9308f713
docs: mention autogenre plugin 2024-04-20 05:33:48 +02:00
Max Goltzsche
2821eac973
docs: add smartplaylist example config and m3u 2024-04-20 05:33:20 +02:00
ktetzlaff
b47635dc29 Prefer VISUAL environment variable over EDITOR
When unix tools make use of an external editor, they typically check the
environment variable VISUAL and fall back to EDITOR. This commit adds the
additional check for VISUAL to the existing EDITOR check (where VISUAL is
preferred over EDITOR).
2024-04-14 12:15:30 +02:00
Max Goltzsche
3c6309fe22
docs: mention Beetstream and webrouter plugins
Also, moves the webm3u plugin link from tne interoperability section to the "Other Plugins" section of the documentation.
2024-04-13 04:55:43 +02:00
Max Goltzsche
883bbb3e4b
smartplaylist: rename output format m3u8 to extm3u 2024-04-13 04:55:43 +02:00
Max Goltzsche
c0afd3eb3c
smartplaylist: allow exporting item fields
Allow generating extm3u playlists so that they contain additional item fields such as the `id`.

The feature is required by the mgoltzsche/beets-webm3u plugin (M3U server) to transform playlists using a request based item URI template which may require additional fields such as the `id`, e.g. `beets:library:track;$id`.
2024-04-13 04:55:37 +02:00
Alok Saboo
d5a237912a Add listenbrainz to index 2023-12-21 12:22:12 -05:00
Alok Saboo
4541644961 Updated docs 2023-12-21 11:57:14 -05:00
Max Goltzsche
58e5b02929
smartplaylist: add --uri-format option
Beets web API already allows remote players to access audio files but it doesn't provide a way to expose the playlists defined using the smartplaylist plugin.
Now the smartplaylist plugin provides an option to generate ID-based item URIs/URLs instead of paths.
Once playlists are generated this way, they can be served using a regular HTTP server such as nginx.

To provide sufficient flexibility for various ways of integrating beets remotely (e.g. beets API, beets API with context path, AURA API, mopidy resource URI, etc), the new option has been defined as a template with an `$id` placeholder (assuming each remote integration requires a different path schema but they all rely on using the beets item `id` as identifier/path segment).

To prevent local path-related plugin configuration from leaking into a HTTP URL-based playlist generation (invoked with CLI option in addition to the local playlists generated into another directory), setting the new option makes the plugin ignore the other path-related options `prefix`, `relative_to`, `forward_slash` and `urlencode`.

Usage examples:
* `beet splupdate --uri-format 'http://beets:8337/item/$id/file'` (for beets web API)
* `beet splupdate --uri-format 'http://beets:8337/aura/tracks/$id/audio'` (for AURA API)

(While it was already possible to generate playlists containing HTTP URLs previously using the `prefix` option, it did not allow to generate ID-based URLs pointing to the beets web API but required to expose the audio files using a web server directly and refer to them using their file system `$path`.)

Relates to #5037
2023-12-16 05:37:27 +01:00
Max Goltzsche
385c05f98e
smartplaylist: change option --extm3u to --output
The boolean flags `--extm3u` and `--no-extm3u` are replaced with a string option `--output=m3u|m3u8`.
This reduces the amount of options and allows to evolve the CLI to support more playlist output formats in the future (e.g. JSON) without polluting the CLI at that point.
2023-12-16 00:23:03 +01:00
Maxr1998
6e5bcbc070
advancedrewrite: Add note about quoting issues to docs 2023-12-15 17:14:00 +01:00
Adrian Sampson
1efd67cb82
Merge pull request #5044 from Maxr1998/advancedrewrite-rewrite
advancedrewrite: Support simple syntax and improve advanced syntax
2023-12-15 09:34:25 -05:00
Max Goltzsche
222b3a34f9
smartplaylist: expose config as CLI options
Add CLI options to `splupdate` command:
* `--playlist-dir`, `-d`
* `--relative-to`
* `--prefix`
* `--urlencode`
* `--forward-slash`
* `--pretend-paths`
2023-12-15 03:51:27 +01:00
Max Goltzsche
b07a2e42f4
smartplaylist: add extm3u/extinf/m3u8 support
This is to be able to display meaningful metadata and search a playlist within a player without having to load the linked audio files of a playlist.
2023-12-14 01:46:14 +01:00
Maxr1998
4b1c7dd8be
Specify new advancedrewrite configuration in docs 2023-12-13 11:25:27 +01:00
Doron Behar
9357448bde mbsubmit: document new prompt choices 2023-12-05 19:21:38 +02:00
jeff
7b0f5fb3f3 Add config option to prefer synced lyrics over plain 2023-11-05 11:26:33 -05:00
jeff
e14982cad7 Add LRCLIB as a provider for the lyrics plugin 2023-11-05 11:26:33 -05:00
Adrian Sampson
37f12bfa49
Fix capitalization 2023-10-25 15:11:03 -04:00
Max Goltzsche
9dd0c6cea9
docs: add link to ytimport plugin to docs 2023-10-22 05:06:00 +02:00
Maxr1998
0a4c8e4952
Add advanced rewrite plugin
This plugin allows rewriting fields based on a given library query. This can be helpful, for example, when an artist was renamed but you'd like to keep their older releases under their old name, or if you have a single track from a Various Artists release and want to have it included with the original artist.
2023-10-14 15:00:57 +02:00
AdrienCos
e7105a9763 Fix the error with CAA where the pre-sized thumbs of release groups would be ignored 2023-10-07 21:25:02 +02:00
Adrian Sampson
b822fe0f5c
Merge pull request #4923 from tandy-1000/autobpm
Add autobpm plugin
2023-10-02 15:56:23 -04:00
tandy1000
7961cf3aaa Add autobpm plugin
This plugin uses librosa to automatically calculate the BPM for a track.
It is based on the keyfinder plugin, and rounds the BPM to an int.

Co-authored-by: Adrian Sampson <adrian@radbox.org>
2023-09-30 16:25:06 +01:00
Kian-Meng Ang
873a91c541 Fix typos
Found via `codespell -S ./test/rsrc,genres.txt -L
caf,fo,ue,searchin,crashers,crasher,te,skool,egal,nothin`
2023-09-25 12:52:26 +08:00
Hiroto Kaku
0f770b6dde
Add beets-mpd-utils plugin 2023-09-21 15:56:15 -04:00
J0J0 Todos
c185b4fba5 Final take on rewording rewrite plugin docs
on whether it modifies metadata or not. Let's also leave a link to the issue
here to make it superclear and researchable for anyone stumbling across it.

Also suggest the substitute plugin as an alternative.
2023-09-08 19:24:34 +02:00
J0J0 Todos
6e983d8615 Fix title underline in substitute plugin docs 2023-08-31 08:59:36 +02:00
J0J0 Todos
54efb279ff Try to clarify the bevhavior of the rewrite plugin
in the plugin docs as was discovered in #2786 (Metadata being modified).
2023-08-31 08:45:05 +02:00
J0J0 Todos
442a535b3e Add substitute plugin to the docs' plugins index 2023-08-31 08:27:33 +02:00
Daniele Ferone
20c1a3e8a0 Wording fix in substitute plugin docs 2023-08-31 07:17:37 +02:00
Daniele Ferone
bd568ad817 Changed docs of substitute plugin 2023-08-31 07:09:12 +02:00
Daniele Ferone
249b420b19 Added plugin 2023-08-31 07:07:09 +02:00
Sam Caldwell
fbd179f44a docs[embyupdate]: add docs for userid option 2023-08-24 20:12:04 -07:00
luzpaz
8419149c7a
Fix various typos 2023-08-09 21:26:15 -04:00
J0J0 Todos
c481670f1b Add docs for new importfeeds list format in #4863 2023-07-27 07:56:14 +02:00
J0J0 Todos
09378e122c Add docs for subsonicupdate features in #4862 2023-07-27 07:41:50 +02:00
J0J0 Todos
1e050e2703 Add singleton matching info to Discogs plugin docs
PR #4854
2023-07-20 09:12:42 +02:00
Alok Saboo
edda4a588d Add changelog and docs 2023-07-10 08:32:29 -04:00
Sunny
edd4f9a4f5
Point URL to specific plugin 2023-06-27 15:33:11 +02:00
Sunny
76932962f8
Add beets-more to community plugins 2023-06-27 10:25:26 +02:00
Alok Saboo
b1b31f7fb4 Remove archived plugin 2023-05-21 16:29:35 -04:00
Adrian Sampson
9527a07767
Merge pull request #4786 from arsaboo/youtube
Add Youtube to the community plugins list
2023-05-13 13:35:28 -04:00
Adrian Sampson
eb361af84e
Caps fix 2023-05-13 13:34:10 -04:00
Alok Saboo
f655cd24c2 Add youtube tag source 2023-05-12 09:58:04 -04:00
Alok Saboo
e4c669adcd Address review comments. 2023-05-11 20:12:32 -04:00
Alok Saboo
ec9ab3a045 extend underline 2023-05-02 09:13:54 -04:00
Alok Saboo
141c8247d2 Update fetchart.rst 2023-05-02 09:11:57 -04:00
Alok Saboo
b0540411e1 Update docs 2023-05-02 08:57:05 -04:00
Alok Saboo
731015b6d5 Update docs 2023-04-28 11:05:26 -04:00
J0J0 Todos
997e8a8440 Fix m3u8 wikipedia link in convert plugin docs 2023-04-21 22:12:17 +02:00
Alok Saboo
d48eab9ac1 Updated language 2023-04-21 07:58:37 -04:00
Alok Saboo
23b42e80e2 Merge remote-tracking branch 'upstream/master' into embedart_url 2023-04-08 21:07:41 -04:00
J0J0 Todos
94784c2c29 convert: playlist: Documentation overhaul 2023-04-02 21:14:50 +02:00
J0J0 T
a1baf9e94b convert: playlist: Fix rst linter error in docs
Fix "inline empasis start string without endstring" error in docs.
2023-03-29 07:46:08 +02:00
J0J0 T
c1908d551a convert: playlist: Document the feature
leaving out the fact that #EXTM3U is added to the playlist file header
(that important?).
2023-03-29 07:46:08 +02:00
Alok Saboo
6626b76182 Update documents and add changelog entry 2023-03-27 20:03:31 -04:00
J0J0 Todos
34227cfabc
Merge pull request #4708 from JOJ0/mb_external_ids
Save external ID's via MusicBrainz
2023-03-26 14:25:15 +02:00
J0J0 Todos
2e5394246f Docs for #4708 2023-03-25 20:51:52 +01:00
Adrian Sampson
4194914e94
Merge pull request #4712 from arsaboo/convert_negation
Add additional example to convert plugin
2023-03-24 16:55:36 -07:00
Alok Saboo
5231037591 Add JioSaavn as a tag source 2023-03-20 17:32:45 -04:00
Alok Saboo
5f87371229 rephrase 2023-03-14 20:57:34 -04:00
Alok Saboo
05cdecfb7c Add more examples to convert plugin 2023-03-14 20:39:47 -04:00
J0J0 Todos
1f9113af73
Merge pull request #4582 from jpluscplusm/jcm_fix_albumtypes
Store `albumtypes` multi-value field consistently in-DB & in-tag, preventing continual file re-tagging
2023-03-08 14:26:19 +01:00
Alok Saboo
033f63ad47 Add Github link 2023-03-07 17:18:15 -05:00
Alok Saboo
4c62673e41 Update index.rst 2023-03-07 17:12:11 -05:00
J0J0 Todos
78853cc9c2 Add note to albumtypes plugin docs about #4528
Add a note to the docs of the albumtypes plugin warning about issue #4528 and
linking to the manual fixing description.
2023-02-28 08:53:21 +01:00
Mark Trolley
55255b0087
Deprecate absubmit and update acousticbrainz plugins
Fixes #4627.

AcousticBrainz is shutting down as of early 2023. Deprecate the absubmit
plugin and update the acousticbrainz plugin to require configuration of
an AcousticBrainz server instance.
2023-02-20 17:42:07 -05:00
J0J0 Todos
527052e13d
Merge branch 'master' into splupdate_dry_run 2023-01-31 07:07:09 +01:00
J0J0 Todos
6abcc20df0
Merge pull request #4634 from ghbrown/discogs_s_ic
Implement item_candidates for Discogs plugin
2023-01-31 06:24:05 +01:00
ghbrown
429dfb3e7a Fix docs phrasing; fix changelog formatting 2023-01-28 18:11:22 -06:00
Adrian Sampson
cc33c9c8b8
Merge pull request #4647 from Steffo99/definition-list
Use definition lists with the plugins' names in the documentation
2023-01-26 15:23:47 -08:00
Adrian Sampson
3ba973de31
Merge pull request #4646 from Steffo99/docs-plugin-discogs
Improve formatting in the `plugins/discogs` documentation page
2023-01-26 15:23:36 -08:00
Stefano Pigozzi
e76fe01212
Add missing space 2023-01-22 15:02:18 +01:00
Stefano Pigozzi
2b600fa151
Revert the configuration section back to how it was before 2023-01-22 14:56:23 +01:00
Stefano Pigozzi
566579b5f8
Revert the configuration section back to how it was before 2023-01-22 14:37:45 +01:00
ghbrown
47fe387de1 Docs and changelog 2023-01-21 20:56:44 -06:00
Stefano Pigozzi
ca320527c8
Improve formatting in the plugins/plexupdate page 2023-01-20 13:10:15 +01:00
Stefano Pigozzi
54aa095882
Specify the language of a code-block 2023-01-20 13:01:23 +01:00
Stefano Pigozzi
bc379850b2
Improve formatting in the plugins/discogs page 2023-01-20 12:47:43 +01:00
Stefano Pigozzi
21bf37befa
Use definition lists with the plugins' names
So that they are easier to find when knowing the name of an enabled plugin
2023-01-20 12:36:44 +01:00
ghbrown
a6dfd1b40c Writing improvements 2023-01-11 11:40:25 -06:00
ghbrown
8938319075 Add Discogs singleton limitation to docs 2023-01-10 12:25:01 -06:00
Jack Wilsdon
dad9d2393d Remove Musixmatch from default enabled sources
Musixmatch are currently blocking all requests with the beets user
agent. See #4585.
2022-12-31 14:34:07 +00:00
J0J0 Todos
bcc9c93f97 Add docs for #4573 2022-12-06 07:49:36 +01:00
J0J0 Todos
6b06344662 Further improve playlist plugin docs
Incorporate wording suggestions and add links to query sections.
2022-11-29 08:27:35 +01:00
J0J0 Todos
a23e31d1b6 Improve playlist plugin docs 2022-11-28 16:18:30 +01:00
Phill Price
867656eef7
Update index.rst
Corrects popularity service from spotify to deezer to match plugin
2022-10-20 23:05:33 +01:00
Aidan Epstein
c906e55ba9 Fix recent bug that would not transcode when format was wrong
Bug introduced in c6d623241b, should_transcode would return False even when the format was different.

Also fix up tests and documentation.
2022-10-19 08:55:51 -07:00
Callum Brown
aa09d2a9eb AURA: document cors for local browser clients 2022-09-28 21:04:33 +01:00
Chris
f5d7967646
Fix typo in albumtypes plugin docs 2022-09-14 04:06:16 -04:00
Adrian Sampson
0c8bf6d7c7
Remove a stray dot 2022-08-27 13:16:02 -07:00
Alok Saboo
1a2fcdd4e3 Adjust line length 2022-08-24 10:04:01 -04:00
Alok Saboo
8ee1a9e508 Updated docs 2022-08-24 09:39:25 -04:00
Sacha Bron
93725c454d Add Beetstream in the plugin list 2022-08-20 01:30:38 +02:00
Aidan Epstein
d66a513d80
Fix documentation to refer to wma instead of wmv
This format actually has a definition.
2022-07-30 16:13:18 +00:00
Dickson
eed8a5bd83 docs: add link to Beets-audible plugin 2022-06-19 18:44:54 +08:00
Adrian Sampson
c25e7ad511
Merge pull request #4352 from arsaboo/spotify_extend
Extend Spotify plugin to obtain (popularity and audio features) track attributes
2022-06-12 17:33:29 -04:00
wisp3rwind
d72498f429 fixup! docs: fix broken links 2022-06-12 17:51:00 +02:00
wisp3rwind
9db8d8f6a1 docs: fix broken links
these failed in the weekly CI test. discogs probably remains broken,
since it received a 403.
2022-06-12 17:41:13 +02:00
e-berman
d4864b7b0c add cl formatting to beatport docs 2022-06-08 22:11:51 -07:00
Alok Saboo
b9685a4784 Add more details to the docs 2022-05-17 21:07:57 -04:00
Alok Saboo
28a4e43b58 Clarified documentation 2022-05-17 15:58:28 -04:00
Alok Saboo
19e2a11ea0 Updated documents and changelog. 2022-05-17 15:30:51 -04:00
Adrian Sampson
3f6da68af2
Slight docs rewording 2022-03-16 11:08:05 -04:00
Duc Nguyen
c0e44960c6 expand documentation on auto and auto_keep 2022-03-16 14:04:40 +01:00
Duc Nguyen
c4281ddacc add some documentation 2022-03-09 18:34:31 +01:00
Duc Nguyen
af5858d200 doc + linter + changelog 2022-03-04 10:42:17 +01:00
Adrian Sampson
e1d19c3a3f
Docs refinement 2022-03-03 11:17:07 +01:00
Joseph Heyburn
4bde4d082d discogs: allow style to be appended to genre
- Added more verbose documentation to `append_style_genre`
- Refactor based on code review
2022-03-03 10:03:31 +00:00
Joseph Heyburn
55e4917df3 discogs: allow style to be appended to genre
- Adds a configuration that, when enabled, will append the style to genre
- Rationale is to have more verbose genres in genre tag of players that only support genre
2022-03-02 22:04:36 +00:00
Adrian Sampson
5f45e9e108
Tiny wording tweaks for #4281 2022-02-16 16:34:38 -05:00
Jaime Marquínez Ferrándiz
8e921e4d74
fish plugin: Style fix
Co-authored-by: Adrian Sampson <adrian@radbox.org>
2022-02-16 21:51:19 +01:00
Jaime Marquínez Ferrándiz
8e5156d01c fish plugin: Add --output option 2022-02-15 23:11:30 +01:00
Adam Fontenot
07eb26f276 Resize album art when embedding (convert plugin)
Fixes #2116
2022-02-09 23:52:21 -08:00
wisp3rwind
3eb49fca2e replaygain: clarify docs for overwrite/force and actually respect it correctly
The code used to always check the 'overwrite' config value, while that
should only apply during imports. The manual 'replaygain' command has it's
own '-f' flag.

The logic for this flag was changed quite a few times recently, see

https://github.com/beetbox/beets/pull/3816
https://github.com/beetbox/beets/issues/3872
https://github.com/beetbox/beets/pull/3890

but apparently we (me and @ybnd) never really got it right...
If it is some comfort, the logic was never correct in the first place.
2022-01-22 14:00:32 +01:00
Alex
919e8be4e3
use correct headings 2022-01-14 23:13:29 +01:00
J0J0 T
2a53b890be Add to discogs plugin docs regarding PR #4227
- Clarify basic search behaviour in intro chapter of discogs plugin,
- and state change introduced in PR#4227 (discogs: Discogs query on
  insufficiently tagged files)
2022-01-10 09:10:21 +01:00
Adrian Sampson
5d0442f094
Merge pull request #4190 from patrick-nicholson/limit-plugin
Limit plugin
2021-12-27 17:01:09 -08:00
patrick-nicholson
5b34797056 sigh 2021-12-27 14:51:04 -05:00
patrick-nicholson
27c2b79f01 Finally learning to read GitHub. 2021-12-27 13:39:35 -05:00
patrick-nicholson
126b4e94cf Fixing doc typo and adding limit to toctree. 2021-12-26 21:57:29 -05:00
ybnd
ca37c94337 kodiupdate: Support multiple instances 2021-12-12 13:39:18 +01:00
Patrick Nicholson
cdb6b21f1a Adding limit and its documentation 2021-12-07 18:47:55 -05:00
Arsen Arsenović
96be1840e3
docs: add fetchart cover_format option 2021-11-03 13:31:33 +01:00
Piotrek Kochański
4d94bf8fad Merge branch 'master' of github.com:beetbox/beets into deinterlace 2021-11-01 21:33:27 +01:00
Piotrek Kochański
417ef0d453 Merge branch 'master' of github.com:beetbox/beets into deinterlace 2021-10-31 13:27:00 +01:00
wisp3rwind
786236f046 remove the gmusic plugin 2021-10-30 14:46:14 +02:00
Tianon Gravi
7bd36ed6ca Add "beet export --album" (matching "beet info --album") 2021-10-27 08:55:36 -07:00
Tianon Gravi
5c41478263 Add "beet info --album" to the plugin documentation too 2021-10-26 09:09:44 -07:00
PotcFdk
85a2eb8e96
Update absubmit.rst
[...] when the tracks do{es->}n't already have [...]
2021-10-25 02:39:32 +02:00
PotcFdk
b72c028a0b
Update absubmit.rst
Reword the first sentence of the Submitting Data paragraph.
2021-10-25 02:31:49 +02:00
Jay DesLauriers
b05432aed0 feat(unimported): support excluding subdirectories 2021-10-12 17:28:43 +00:00
wisp3rwind
c8bfad5e17 docs: fix links that were failing sphinx' linkcheck
There's one stale link left for the gmusic plugin, which should be fixed
by removing the plugin, see #4089
2021-10-04 16:14:14 +02:00
Edgars Supe
4f361eb795
Fix typos in albumtypes plugin docs 2021-09-10 23:59:06 +03:00
Adrian Sampson
e1d41c241d
Merge pull request #4048 from edgars-supe/albumtypes-plugin
Add plugin for formatting albumtypes
2021-09-10 16:47:33 -04:00
Edgars Supe
d40f0c8860 Fill default config for albumtypes plugin 2021-09-10 14:48:28 +03:00
Edgars Supe
fea5f5c548 Add beets-importreplace to external plugins list 2021-09-10 10:57:49 +03:00
Edgars Supe
c5764df989 Improve albumtypes plugin documentation 2021-09-10 10:23:47 +03:00
Edgars Supe
c59a22efa2 Add albumtypes to plugin index 2021-09-09 23:07:11 +03:00