Commit graph

1183 commits

Author SHA1 Message Date
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
Edgars Supe
899136774b Add documentation for albumtypes plugin 2021-09-09 23:07:11 +03:00
Piotrek Kochański
901377ded5 Improve wording. 2021-08-26 15:01:37 +02:00
Piotrek Kochański
bee4f13d84 Remove duplicate line. 2021-08-26 14:43:37 +02:00
Piotrek Kochański
7c1de83ef2 Extend fetchart documentation to cover new option. 2021-08-26 13:38:17 +02:00
Piotrek Kochański
31d9c80e18 Update docs/ to reflect new option to deinterlace.
Document new option to fetchart plugin to store cover art as
non-progressive.
2021-08-25 22:58:04 +02:00
Kirill A. Korinsky
b0f7418372
Stream-friendly smart playlists
This commit introduced a way to generate a stream-frienldy playlists.
2021-08-14 02:41:22 +02:00
Šarūnas Nejus
c6e4cf80f4
Add reference to the beetcamp plugin 2021-08-03 19:27:26 +01:00
Šarūnas Nejus
8dae6039f2
Order external plugins alphabetically 2021-08-03 19:27:26 +01:00
maffo999
653181a296 Fix subsonicupdate plugin 2021-07-14 20:10:04 +02:00
Sam Thursfield
2fa3717731 Optimise FormattedMapping when querying a specific set of fields
This changes greatly improves the speed of `beet export` and `beet info`
when the `--include-keys` option is used. It also removes the globbing
feature of `--include-keys` that was added in #1295. (See #3762 for
discussion).

Listing all fields for an item requires querying the database to find
any flex attributes. This is slow when done for every item being
exported. We already have a way for the user to specify a fixed set
of keys, but we previously queried everything and filtered it afterwards.
The new approach is more efficient.

Code that iterates through all fields now have to handle invalid field
names. The export and info plugins output invalid fields as None.

Timings before:

    > /usr/bin/time beet export -i title,path,artist -l  Bob Dylan
    13.26user 20.22system 0:34.01elapsed 98%CPU (0avgtext+0avgdata 52544maxresident)k

    > /usr/bin/time beet export -l  Bob Dylan
    12.93user 20.15system 0:33.58elapsed 98%CPU (0avgtext+0avgdata 53632maxresident)k

Timings after:

    > /usr/bin/time beet export -l  Bob Dylan
    13.33user 20.17system 0:34.02elapsed 98%CPU (0avgtext+0avgdata 53500maxresident)k

    > /usr/bin/time beet export -i title,path,artist -l  Bob Dylan
    0.49user 0.07system 0:00.56elapsed 98%CPU (0avgtext+0avgdata 50496maxresident)k

Notice the dramatic speedup in the last example!
2021-05-01 23:41:09 +02:00
Adrian Sampson
eab4372a58
Merge pull request #3900 from Lanny/master
badfiles: Optionally run checkers during import
2021-03-29 19:28:30 -04:00
Adrian Sampson
f067180c4c
Shorten a ReST underline 2021-03-28 14:23:38 -04:00
Xavier Hocquet
6081e6a8df CR comments 2021-03-28 13:08:00 -05:00
Xavier Hocquet
8c6530369d
Merge branch 'master' into tekstowo-lyrics 2021-03-28 12:05:42 -06:00
Ryan Lanny Jenkins
3e1fe88053 Merge branch 'master' of https://github.com/beetbox/beets 2021-03-24 16:59:24 -05:00
Ryan Lanny Jenkins
2f8a8e2f8a Add docs for badfiles' check_on_import option. 2021-03-24 16:55:28 -05:00
wisp3rwind
9a6b65351b Merge pull request #3560 from davidswarbrick/master
Album Art Resize to filesize
2021-03-23 12:15:51 +01:00
David Swarbrick
07b5e69f40 fetchart/artresizer: add max_filesize support (#3560)
Squashed from the PR, relevant commit messages follow below:

Added file size option to artresizer

 - In line with comments on PR, adjusted the ArtResizer API to add
   functionality to "resize to X bytes" through `max_filesize` arg

 - Adjustment to changelog.rst to include max_filesize change to ArtResizer
   and addition of new plugin.

Added explicit tests for PIL & Imagemagick Methods

 - Checks new resizing functions do reduce the filesize of images

Expose max_filesize logic to fetchart plugin

- Add syspath escaping for OS cross compatibility
- Return smaller PIL image even if max filesize not reached.
- Test resize logic against known smaller filesize (//2)
- Pass integer (not float) quality argument to PIL
- Remove Pillow from dependencies
- Implement "max_filesize" fetchart option, including
  logic to resize and rescale if maxwidth is also set.

Added tests & documentation for fetchart additions.

Tests now check that a target filesize is reached with a
higher initial quality (a difficult check to pass).

With a starting quality of 95% PIL takes 4 iterations to succeed
in lowering the example cover image to 90% its original size.
To cover all bases, the PIL loop has been changed to 5 iterations
in the worst case, and the documentation altered to reflect the
50% loss in quality this implies. This seems reasonable as users
concerned about performance would most likely be persuaded to
install ImageMagick, or remove the maximum filesize constraint.
The previous 30% figure was arbitrary.
2021-03-23 12:00:14 +01:00
Graham R. Cobb
cad2c055c5 Make unicode handling explicit, to support python 2 and 3.
Add link to Unidecode library in docs.

Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-16 16:29:57 +00:00
Graham Cobb
4b9c9d0a5f
doc improvement as suggested by @sampsyo
Co-authored-by: Adrian Sampson <adrian@radbox.org>
2021-03-16 15:30:43 +00:00
Graham Cobb
2df3765521
Tidy doc as suggested by @sampsyo
Co-authored-by: Adrian Sampson <adrian@radbox.org>
2021-03-16 15:29:35 +00:00
Graham R. Cobb
d1ec7b4b70 Add `bareasc` command to display entries with the unidecode transformation
applied.

Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-16 11:57:52 +00:00
Graham R. Cobb
06b6b72e0e Add credit to Unidecode library into bareasc docs.
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-15 22:52:14 +00:00
Graham R. Cobb
f4fccfa05c Add documentation for bareasc to the plugins index.
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-15 15:53:14 +00:00
Graham R. Cobb
341a0a0adf Added documentation and changelog for bareasc.
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-15 15:34:58 +00:00
Graham R. Cobb
680ccdcd96 Documentation and changelog for web `readonly` option fixing #3870.
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-11 23:09:51 +00:00
David Dembeck
374707bb7a
remove LyricsWiki from default sources in docs
https://github.com/beetbox/beets/pull/3766 missed removing this
2021-03-10 12:59:48 -06:00
govynnus
debd382837
Merge pull request #3758 from beetbox/aura
AURA: Add aura plugin and docs
2021-03-08 07:24:53 +00:00
Callum Brown
a24a094562 AURA: Small updates to docs and set server version 2021-03-07 18:24:57 +00:00
Callum Brown
9b9ff46e7d Merge branch 'master' into aura
Ensure aura branch has updated configuration to eliminate spurious
linter errors from the style checker.
2021-03-07 11:08:37 +00:00