Skip to content

Releases: beetbox/beets

Release v2.6.1

02 Feb 02:30

Choose a tag to compare

Bug fixes

  • Make packaging a required dependency. πŸ› (#6332)

Release v2.6.0

01 Feb 14:44

Choose a tag to compare

Beets now requires Python 3.10 or later since support for EOL Python 3.9 has been dropped.

New features

  • Added support for Python 3.13.
  • Convert Plugin: force can be passed to override checks like no_convert, never_convert_lossy_files, same format, and max_bitrate
  • Discogs Plugin: Added support for multi value fields. πŸ› (#6068)
  • EmbedArt Plugin: Embedded arts can now be cleared during import with the clearart_on_import config option. Also, beet clearart is only going to update the files matching the query and with an embedded art, leaving untouched the files without.
  • FetchArt Plugin: Added config setting for a fallback cover art image.
  • FetchArt Plugin: Fix colorized output text.
  • Fish Plugin: Filenames are now completed in more places, like after import.
  • FtInTitle Plugin: Added album template value album_artist_no_feat.
  • FtInTitle Plugin: Added argument for custom feat. words in ftintitle.
  • FtInTitle Plugin: Added argument to skip the processing of artist and album artist are the same in ftintitle.
  • FtInTitle Plugin: Featured artists are now inserted before brackets containing remix/edit-related keywords (e.g., "Remix", "Live", "Edit") instead of being appended at the end. This improves formatting for titles like "Song 1 (Carol Remix) ft. Bob" which becomes "Song 1 ft. Bob (Carol Remix)". A variety of brackets are supported and a new bracket_keywords configuration option allows customizing the keywords. Setting bracket_keywords to an empty list matches any bracket content regardless of keywords.
  • ImportSource Plugin: Added new plugin that tracks original import paths and optionally suggests removing source files when items are removed from the library.
  • LastGenre Plugin: For tuning plugin settings -vvv can be passed to receive extra verbose logging around last.fm results and how they are resolved. The extended_debug config setting and --debug option have been removed.
  • MusicBrainz Plugin: Allow selecting tags or genres to populate the genres tag.
  • MusicBrainz Pseudo-Release Plugin: Add a new MusicBrainz Pseudo-Release Plugin plugin to proactively receive MusicBrainz pseudo-releases as recommendations during import.
  • Play Plugin: Added $playlist marker to precisely edit the playlist filepath into the command calling the player program.
  • Random Plugin: Added --field option to specify which field to use for equal-chance sampling (default: albumartist).
  • Spotify Plugin: Added support for multi-artist albums and tracks, saving all contributing artists to the respective fields.
  • Titlecase Plugin: Add the Titlecase Plugin plugin to allow users to resolve differences in metadata source styles.

Bug fixes

  • Errors in metadata plugins during autotage process will now be logged but won't crash beets anymore. If you want to raise exceptions instead, set the new configuration option raise_on_error to yes πŸ› (#5903), πŸ› (#4789).
  • Fix a bug introduced in release 2.4.0 where import from any valid import-log-file always threw a "none of the paths are importable" error.
  • Handle potential OSError when unlinking temporary files in ArtResizer. πŸ› (#5615)
  • Running beet --config <mypath> config -e now edits <mypath> rather than the default config path. πŸ› (#5652)
  • Sanitize log messages by removing control characters preventing terminal rendering issues.
  • When hardlinking from a symlink (e.g. importing a symlink with hardlinking enabled), dereference the symlink then hardlink, rather than creating a new (potentially broken) symlink πŸ› (#5676)
  • When using FromFilename Plugin together with Edit Plugin, temporary tags extracted from filenames are no longer lost when discarding or cancelling an edit session during import. πŸ› (#6104)
  • Command-Line Interface: Fix 'from_scratch' option for singleton imports: delete all (old) metadata when new metadata is applied. πŸ› (#3706)
  • Convert Plugin: auto_keep now respects no_convert and never_convert_lossy_files when deciding whether to copy/transcode items, avoiding extra lossy duplicates.
  • Discogs Plugin: Fixed unexpected flex attr from the Discogs plugin. πŸ› (#6177)
  • FtInTitle Plugin: Fixed artist name splitting to prioritize explicit featuring tokens (feat, ft, featuring) over generic separators (&, and), preventing incorrect splits when both are present.
  • Inline Plugin: Fix recursion error when an inline field definition shadows a built-in item field (e.g., redefining track_no). Inline expressions now skip self-references during evaluation to avoid infinite recursion. πŸ› (#6115)
  • LastGenre Plugin: Canonicalize genres when force and keep_existing are on, yet no genre info on lastfm could be found. πŸ› (#6303)
  • LastGenre Plugin: Fix the issue where last.fm doesn't return any result in the artist genre stage because "concatenation" words in the artist name (like "feat.", "+", or "&") prevent it. Using the albumartists list field and fetching a genre for each artist separately improves the chance of receiving valid results in that stage.
  • Lyrics Plugin: Accepts strings for lyrics sources (previously only accepted a list of strings). πŸ› (#5962)
  • Smart Playlist Plugin: Fixed an issue where multiple queries in a playlist configuration were not preserving their order, causing items to appear in database order rather than the order specified in the config. πŸ› (#6183)
  • Spotify Plugin: The plugin now gracefully handles audio-features API deprecation (HTTP 403 errors). When a 403 error is encountered from the audio-features endpoint, the plugin logs a warning once and skips audio features for all remaining tracks in the session, avoiding unnecessary API calls and rate limit exhaustion.
  • Spotify Plugin: Updated Spotify API credentials. πŸ› (#6270)
  • Web Plugin: repair broken /item/values/… and /albums/values/… endpoints. Previously, due to single-quotes (ie. string literal) in the SQL query, the query eg. GET /item/values/albumartist would return the literal "albumartist" instead of a list of unique album artists.
  • update Edit Plugin fix display formatting of field changes to clearly show added and removed flexible fields.

For plugin developers

Read more

Release v2.5.1

14 Oct 22:53

Choose a tag to compare

New features

  • Zero Plugin: Add new configuration option, omit_single_disc, to allow zeroing the disc number on write for single-disc albums. Defaults to False.

Bug fixes

For packagers

  • Fixed issue with legacy metadata plugins not copying properties from the base class.
  • Reverted the following: When installing beets via git or locally the version string now reflects the current git branch and commit hash. πŸ› (#6089)

Other changes

  • Removed outdated mailing list contact information from the documentation πŸ› (#5462).
  • Getting Started: Modernized the Getting Started guide with tabbed sections and dropdown menus. Installation instructions have been streamlined, and a new subpage now provides additional setup details.

Release v2.5.0

11 Oct 10:03

Choose a tag to compare

New features

  • Convert Plugin: Add a config option to disable writing metadata to converted files.
  • Discogs Plugin Added support for featured artists. πŸ› (#6038)
  • Discogs Plugin New configuration option featured_string to change the default string used to join featured artists. The default string is Feat..
  • Discogs Plugin Support for artist_credit in Discogs tags. πŸ› (#3354)
  • Discogs Plugin Support for name variations and config options to specify where the variations are written. πŸ› (#3354)
  • Discogs Plugin: New config option strip_disambiguation to toggle stripping discogs numeric disambiguation on artist and label fields.
  • LastGenre Plugin: Add a --pretend option to preview genre changes without storing or writing them.

Bug fixes

  • Metadata source plugins: Fixed data source penalty calculation that was incorrectly applied during import matching. The source_weight configuration option has been renamed to data_source_mismatch_penalty to better reflect its purpose. πŸ› (#6066)
  • Chromaprint/Acoustid Plugin BPSync Plugin Fix plugin loading issue caused by an import of another beets.plugins.BeetsPlugin class. πŸ› (#6033)
  • Discogs Plugin Fixed inconsistency in stripping disambiguation from artists but not labels. πŸ› (#5366)
  • FromFilename Plugin: Fix πŸ› (#5218), improve the code (refactor regexps, allow for more cases, add some logging), add tests.
  • MusicBrainz Plugin Refresh flexible MusicBrainz metadata on reimport so format changes are applied. πŸ› (#6036)
  • Spotify Plugin Ensure spotifysync keeps popularity, ISRC, and related fields current even when audio features requests fail. πŸ› (#6061)
  • Spotify Plugin Fixed an issue where candidate lookup would not find matches due to query escaping (single vs double quotes).
  • Spotify Plugin Fixed an issue where track matching and lookups could return incorrect or misleading results when using the Spotify plugin. The problem occurred primarily when no album was provided or when the album field was an empty string. πŸ› (#5189)
  • Spotify Plugin Removed old and undocumented config options artist_field, album_field and track that were causing issues with track matching. πŸ› (#5189)

Other changes

  • Moved art.py utility module from beets into beetsplug namespace as it is not used in the core beets codebase. It can now be found in beetsplug._utils.
  • Moved vfs.py utility module from beets into beetsplug namespace as it is not used in the core beets codebase. It can now be found in beetsplug._utils.
  • When installing beets via git or locally the version string now reflects the current git branch and commit hash. πŸ› (#4448)
  • Autotagger Matching Options: match.distance_weights.source configuration has been renamed to match.distance_weights.data_source for consistency with the name of the field it refers to.
  • FAQ: Add check for musicbrainz plugin if auto-tagger can't find a match πŸ› (#6020)
  • Plugins: Clarify that musicbrainz must be mentioned if plugin list modified πŸ› (#6020)
  • Using the Auto-Tagger: Section on no matching release found, related to possibly disabled musicbrainz plugin πŸ› (#6020)
  • beets.metadata_plugin.MetadataSourcePlugin: Remove discogs specific disambiguation stripping.

For developers and plugin authors

  • Metadata source plugins are now registered globally when instantiated, which makes their handling slightly more efficient.
  • The track_distance() and album_distance() methods have been removed from MetadataSourcePlugin. Distance calculation for data source mismatches is now handled automatically by the core matching logic. This change simplifies the plugin architecture and fixes incorrect penalty calculations. πŸ› (#6066)
  • Typing improvements in beets/logging.py: getLogger now returns BeetsLogger when called with a name, or RootLogger when called without a name.

Release v2.4.0

13 Sep 16:50

Choose a tag to compare

New features

  • Discogs Plugin: Add configurable search_limit option to limit the number of results returned by the Discogs metadata search queries.
  • Discogs Plugin: Implement track_for_id method to allow retrieving singletons by their Discogs ID. πŸ› (#4661)
  • Duplicates Plugin: Add --remove option, allowing to remove from the library without deleting media files. πŸ› (#5832)
  • MPDStats Plugin: Add new configuration option, played_ratio_threshold, to allow configuring the percentage the song must be played for it to be counted as played instead of skipped.
  • MusicBrainz Collection Plugin: When getting the user collections, only consider collections of releases, and ignore collections of other entity types.
  • MusicBrainz Plugin: The MusicBrainz autotagger has been moved to a separate plugin. The default plugins includes MusicBrainz Plugin, but if you've customized your plugins list in your configuration, you'll need to explicitly add MusicBrainz Plugin to continue using this functionality. Configuration option musicbrainz.enabled has thus been deprecated. πŸ› (#2686) πŸ› (#4605)
  • Playlist Plugin: Support files with the .m3u8 extension. πŸ› (#5829)
  • Replace Plugin: Add new plugin.
  • Spotify Plugin Deezer Plugin: Add new configuration option search_limit to limit the number of results returned by search queries.
  • Web Plugin: Display artist and album as part of the search results.
  • Web Plugin: Show notifications when a track plays. This uses the Media Session API to customize media notifications.

Bug fixes

  • Fix HiddenFileTest by using bytestring_path().
  • Fix an issue where calling Library.add would cause the database_change event to be sent twice, not once. πŸ› (#5560)
  • Fixed regression with ListenBrainz Plugin where the plugin could not be loaded πŸ› (#5975)
  • Chromaprint/Acoustid Plugin: AcoustID lookup HTTP requests will now time out after 10 seconds, rather than hanging the entire import process.
  • Deezer Plugin: Fix the issue with that every query to deezer was ascii encoded. This resulted in bad matches for queries that contained special e.g. non latin characters as η›—δ½œ. If you want to keep the legacy behavior set the config option deezer.search_query_ascii: yes. πŸ› (#5860)
  • Discogs Plugin: Beets will no longer crash if a release has been deleted, and returns a 404.
  • LastGenre Plugin: Fix the issue introduced in Beets 2.3.0 where non-whitelisted last.fm genres were not canonicalized to parent genres. πŸ› (#5930)
  • MusicBrainz Plugin: Fix the MusicBrainz search not taking into account the album/recording aliases
  • MusicBrainz Plugin: fix regression where user configured extra_tags have been read incorrectly. πŸ› (#5788)
  • Spotify Plugin: Fix the issue with that every query to spotify was ascii encoded. This resulted in bad matches for queries that contained special e.g. non latin characters as η›—δ½œ. If you want to keep the legacy behavior set the config option spotify.search_query_ascii: yes. πŸ› (#5699)
  • tests: Fix library tests failing on Windows when run from outside D:/. πŸ› (#5802)
  • tests: Fix tests failing without langdetect (by making it required). πŸ› (#5797)

For packagers

  • Loosened typing_extensions dependency in pyproject.toml to apply to every python version.
  • Optional extra_tags parameter has been removed from BeetsPlugin.candidates method signature since it is never passed in. If you override this method in your plugin, feel free to remove this parameter.

For plugin developers

  • The FetchArt Plugin plugins has seen a few changes to function signatures and source registration in the process of introducing typings to the code. Custom art sources might need to be adapted.

  • We split the responsibilities of plugins into two base classes

    1. beets.plugins.BeetsPlugin is the base class for all plugins, any plugin needs to inherit from this class.
    2. beets.metadata_plugin.MetadataSourcePlugin allows plugins to act like metadata sources. E.g. used by the MusicBrainz plugin. All plugins in the beets repo are opted into this class where applicable. If you are maintaining a plugin that acts like a metadata source, i.e. you expose any of track_for_id, album_for_id, candidates, item_candidates, album_distance, track_distance methods, please update your plugin to inherit from the new baseclass, as otherwise your plugin will stop working with the next major release.
  • Several definitions have been moved:

    • BLOB_TYPE constant, PathQuery and SingletonQuery queries have moved from beets.library to beets.dbcore.query module
    • DateType, DurationType, PathType types and MusicalKey class have moved from beets.library to beets.dbcore.types module.
    • Distance has moved from beets.autotag to beets.autotag.distance module.
    • beets.autotag.current_metadata has been renamed to beets.util.get_most_common_tags.

    Old imports are now deprecated and will be removed in version 3.0.0.

  • beets.ui.decargs is deprecated and will be removed in version 3.0.0.

  • Beets is now PEP 561 compliant, which means that it provides type hints for all public APIs. This allows IDEs to provide better autocompletion and type checking for downstream users of the beets API.

  • plugins.find_plugins function does not anymore load plugins. You need to explicitly call plugins.load_plugins() to load them.

  • plugins.load_plugins function does not anymore accept the list of plugins to load. Instead, it loads all plugins that are configured by plugins configuration.

  • Flexible fields, which can be used by plugins to store additional metadata, now also support list values. Previously, beets would throw an error while storing the data in the SQL database due to missing type conversion. πŸ› (#5698)

Other changes

  • Added a test to check that all plugins can be imported without errors.
  • Documentation structure for auto generated API references changed slightly. Autogenerated API references are now located in the docs/api subdirectory.
  • Refactor: Split responsibilities of Plugins into MetaDataPlugins and general Plugins.
  • Refactored library.py file by splitting it into multiple modules within the beets/library directory.
  • UI: Update default text_diff_added color from bold red to bold green.
  • UI: Use text_diff_added and text_diff_removed colors in all diff comparisons, including case differences.
  • Getting Started: Add instructions to install beets on Void Linux.
  • LastGenre Plugin: Refactor loading whitelist and canonicalization file. πŸ› (#5979)
  • LastGenre Plugin: Updated and streamlined the genre whitelist and canonicalization tree πŸ› (#5977)
  • Substitute Plugin: Fix rST formatting for example cases so that each case is shown on separate lines.

Release v2.3.1

14 May 09:54

Choose a tag to compare

Bug fixes:

  • Path Formats: Fixed a regression where path legalization incorrectly removed parts of user-configured path formats that followed a dot (.). πŸ› (#5771)

For packagers:

  • Force poetry version below 2 to avoid it mangling file modification times in sdist package. πŸ› (#5770)

Release v2.3.0

07 May 22:36

Choose a tag to compare

Beets now requires Python 3.9 or later since support for EOL Python 3.8 has been dropped.

New features

  • LastGenre Plugin: The new configuration option, keep_existing, provides more fine-grained control over how pre-populated genre tags are handled. The force option now behaves in a more conventional manner. πŸ› (#4982)
  • Lyrics Plugin: Add new configuration option dist_thresh to control the maximum allowed distance between the lyrics search result and the tagged item's artist and title. This is useful for preventing false positives when fetching lyrics.
  • Lyrics Plugin: Rewrite lyrics translation functionality to use Azure AI Translator API and add relevant instructions to the documentation.
  • MBSync Plugin: Add support for all metadata sorces.
  • Missing Plugin: Add support for all metadata sources.

Bug fixes

  • Fix ambiguous column name sqlite3.OperationalError that occured in album queries that filtered album track titles, for example beet list -a keyword title:foo.
  • ImageMagick 7.1.1-44 is now supported.
  • Synchronise files included in the source distribution with what we used to have before the introduction of Poetry. πŸ› (#5531) πŸ› (#5526)
  • FetchArt Plugin: Fix fetchart bug where a tempfile could not be deleted due to never being properly closed. πŸ› (#5521)
  • LastGenre Plugin: Fix track-level genre handling. Now when an album-level genre is set already, single tracks don't fall back to the album's genre and request their own last.fm genre. Also log messages regarding what's been tagged are now more polished. πŸ› (#5582)
  • ListenBrainz Plugin: Fix UnboundLocalError in cases where 'mbid' is not defined.
  • ListenBrainz Plugin: Fix rST formatting for URLs of Listenbrainz API Key documentation and config.yaml.
  • Lyrics Plugin: Do not attempt to search for lyrics if either the artist or title is missing and ignore artist_sort value if it is empty. πŸ› (#2635)
  • Lyrics Plugin: Fix fetching lyrics from lrclib source. If we cannot find lyrics for a specific album, artist, title combination, the plugin now tries to search for the artist and title and picks the most relevant result. Update the default sources configuration to prioritize lrclib over other sources since it returns reliable results quicker than others. πŸ› (#5102)
  • Lyrics Plugin: Fix plugin crash when genius backend returns empty lyrics. πŸ› (#5583)
  • Lyrics Plugin: Fix the issue with genius backend not being able to match lyrics when there is a slight variation in the artist name. πŸ› (#4791)
  • Lyrics Plugin: LRCLib will fallback to plain lyrics if synced lyrics are not found and synced flag is set to yes.
  • Lyrics Plugin: Rewrite lyrics tests using pytest to provide isolated configuration for each test case. This fixes the issue where some tests failed because they read developers' local lyrics configuration. πŸ› (#5133)
  • ParentWork Plugin: Only output parentwork changes when running in verbose mode.
  • Sort Order: Fix a bug that would raise an exception when sorting on a non-string field that is not populated in all items. πŸ› (#5512)
  • Thumbnails Plugin: Fix API call to GIO on big endian architectures (like s390x) in thumbnails plugin. πŸ› (#5708)
  • import: Fix MemoryError and improve performance tagging large albums by replacing munkres library with lap.lapjv. πŸ› (#5207)
  • write: Fix the issue where for certain files differences in mb_artistid, mb_albumartistid and albumtype fields are shown on every attempt to write tags. Note: your music needs to be reimported with beet import -LI or synchronised with beet mbsync in order to fix this! πŸ› (#5265) πŸ› (#5371) πŸ› (#4715)

For packagers

  • External plugin developers: beetsplug/__init__.py file can be removed from your plugin as beets now uses native/implicit namespace package setup.
  • The minimum supported Python version is now 3.9.

Other changes

  • Database models are now serializable with pickle.
  • Release workflow: fix the issue where the new release tag is created for the wrong (outdated) commit. Now the tag is created in the same workflow step right after committing the version update. πŸ› (#5539)
  • FtInTitle Plugin: Optimize the plugin by avoiding unnecessary writes to the database.
  • Smart Playlist Plugin: URL-encode additional item fields within generated EXTM3U playlists instead of JSON-encoding them.
  • typehints: ./beets/importer.py file now has improved typehints.
  • typehints: ./beets/plugins.py file now includes typehints.

Release v2.2.0

02 Dec 06:58
01f1faf

Choose a tag to compare

New features

  • /plugins/substitute: Allow the replacement string to use capture groups from the match. It is thus possible to create more general rules, applying to many different artists at once.

Bug fixes

  • Bring back test files and the manual to the source distribution tarball. πŸ› (#5513)
  • Fix bug where matcher doesn't consider medium number when importing. This makes it difficult to import hybrid SACDs and other releases with duplicate tracks. πŸ› (#5148)
  • Check if running python from the Microsoft Store and provide feedback to install from python.org. πŸ› (#5467)

Other changes

  • Changed bitesize label to good first issue. Our contribute page is now automatically populated with these issues. πŸ› (#4855)

Release v2.1.0

22 Nov 02:07
0780bf3

Choose a tag to compare

New features

  • Ability to query albums with track db fields and vice-versa, for example beet list -a title:something or beet list artpath:cover. Consequently album queries involving path field have been sped up, like beet list -a path:/path/.
  • Beets now uses platformdirs to determine the default music directory. This location varies between systems -- for example, users can configure it on Unix systems via user-dirs.dirs(5).
  • New template function added: %capitalize. Converts the first letter of the text to uppercase and the rest to lowercase.
  • Plugin autobpm: Add new configuration option beat_track_kwargs which enables adjusting keyword arguments supplied to librosa's beat_track function call.
  • Plugin ftintitle: New keep_in_artist option for the plugin, which allows keeping the "feat." part in the artist metadata while still changing the title.

Bug fixes

  • Album flexible fields are now correctly saved. For instance MusicBrainz external links such as bandcamp_album_id will be available on albums in addition to tracks. For albums already in your library, a re-import is required for the fields to be added. Such a re-import can be done with, in this case, beet import -L data_source:=MusicBrainz.
  • Fix lyrics plugin only getting part of the lyrics from Genius.com πŸ› (#4815)
  • Fix the TypeError when set_fields is provided non-string values. πŸ› (#4840)
  • Fix the auto value for the reflink config option.
  • Improve naming of temporary files by separating the random part with the file extension.
  • Plugin autobpm: Fix the TypeError where tempo was being returned as a numpy array. Update librosa dependency constraint to prevent similar issues in the future. πŸ› (#5289)
  • Plugin convert: Fixed the convert plugin no_convert option so that it no longer treats "and" and "or" queries the same. To maintain previous behaviour add commas between your query keywords. For help see combiningqueries.
  • Plugin discogs: Fix the TypeError when there is no description.
  • Plugin ftintitle: The detection of a "feat. X" part in a song title does not produce any false positives caused by words like "and" or "with" anymore. πŸ› (#5441)
  • Plugin ftintitle: The detection of a "feat. X" part now also matches such parts if they are in parentheses or brackets. πŸ› (#5436)
  • Plugin lyrics: Update tekstowo backend to fetch lyrics directly since recent updates to their website made it unsearchable. πŸ› (#5456)
  • Use single quotes in all SQL queries πŸ› (#4709)

For packagers

  • The beet script has been removed from the repository.
  • The typing_extensions is required for Python 3.10 and below.
  • The minimum supported Python version is now 3.8.

Other changes

  • Added caching for dependency installation in all CI jobs which speeds them up a bit, especially the tests.
  • GitHub workflows have been reorganised for clarity: style, linting, type and docs checks now live in separate jobs and are named accordingly.
  • Installation instructions have been made consistent across plugins documentation. Users should simply install beets with an extra of the corresponding plugin name in order to install extra dependencies for that plugin.
  • Plugin autobpm: Add plugin dependencies to pyproject.toml under the autobpm extra and update the plugin installation instructions in the docs. Since importing the bpm calculation functionality from librosa takes around 4 seconds, update the plugin to only do so when it actually needs to calculate the bpm. Previously this import was being done immediately, so every beet invocation was being delayed by a couple of seconds. πŸ› (#5185)
  • The linting workflow has been made to run only when Python files or documentation is changed, and they only check the changed files. When dependencies are updated (poetry.lock), then the entire code base is checked.
  • The long-deprecated beets.util.confit module has been removed. This may cause extremely outdated external plugins to fail to load.
  • contributing: Since poetry now manages local virtual environments, tox has been replaced by a task runner poethepoet. This change affects beets developers and contributors. Please see updates in the development-tools section for more details. Type poe while in the project directory to see the available commands.
  • contributing: The project now uses poetry for packaging and dependency management. This change affects project management and mostly affects beets developers. Please see updates in getting-the-source and testing for more information.

Release v2.0.0

30 May 04:06
b88c097

Choose a tag to compare

With this release, beets now requires Python 3.7 or later (it removes support for Python 3.6).

Major new features

  • The beets importer UI received a major overhaul. Several new configuration options are available for customizing layout and colors: ui_options. πŸ› (#3721) πŸ› (#5028)

New features

  • edit: Prefer editor from VISUAL environment variable over EDITOR.
  • config: Prefer editor from VISUAL environment variable over EDITOR.
  • listenbrainz: Add initial support for importing history and playlists from ListenBrainz πŸ› (#1719)
  • mbsubmit: add new prompt choices helping further to submit unmatched tracks to MusicBrainz faster.
  • spotify: We now fetch track's ISRC, EAN, and UPC identifiers from Spotify when using the spotifysync command. πŸ› (#4992)
  • discogs: supply a value for the cover_art_url attribute, for use by fetchart. πŸ› (#429)
  • update: added `-e` flag for excluding fields from being updated.
  • deezer: Import rank and other attributes from Deezer during import and add a function to update the rank of existing items. πŸ› (#4841)
  • resolve transl-tracklisting relations for pseudo releases and merge data with the actual release πŸ› (#654)
  • Fetchart: Use the right field (spotify_album_id) to obtain the Spotify album id πŸ› (#4803)
  • Prevent reimporting album if it is permanently removed from Spotify πŸ› (#4800)
  • Added option to use cover_art_url as an album art source in the fetchart plugin. πŸ› (#4707)
  • fetchart: The plugin can now get album art from spotify.
  • Added option to specify a URL in the embedart plugin. πŸ› (#83)
  • list singleton:true queries have been made faster
  • list singleton:1 and singleton:0 can now alternatively be used in queries, same as comp
  • --from-logfile now parses log files using a UTF-8 encoding in beets/beets/ui/commands.py. πŸ› (#4693)
  • bareasc lookups have been made faster
  • list lookups using the pattern operator :: have been made faster
  • Added additional error handling for spotify plugin. πŸ› (#4686)
  • We now import the remixer field from Musicbrainz into the library. πŸ› (#4428)
  • mbsubmit: Added a new mbsubmit command to print track information to be submitted to MusicBrainz after initial import. πŸ› (#4455)
  • Added spotify_updated field to track when the information was last updated.
  • We now import and tag the album information when importing singletons using Spotify source. πŸ› (#4398)
  • spotify: The plugin now provides an additional command spotifysync that allows getting track popularity and audio features information from Spotify. πŸ› (#4094)
  • spotify: The plugin now records Spotify-specific IDs in the spotify_album_id, spotify_artist_id, and spotify_track_id fields. πŸ› (#4348)
  • Create the parental directories for database if they do not exist. πŸ› (#3808) πŸ› (#4327)
  • musicbrainz-config: a new musicbrainz.enabled option allows disabling the MusicBrainz metadata source during the autotagging process
  • kodiupdate: Now supports multiple kodi instances πŸ› (#4101)
  • Add the item fields bitrate_mode, encoder_info and encoder_settings.
  • Add query prefixes = and ~.
  • A new configuration option, duplicate_keys, lets you change which fields the beets importer uses to identify duplicates. πŸ› (#1133) πŸ› (#4199)
  • Add exact match <exact-match> queries, using the prefixes = and =~. πŸ› (#4251)
  • discogs: Permit appending style to genre.
  • discogs: Implement item_candidates for matching singletons.
  • discogs: Check for compliant discogs_client module.
  • convert: Add a new auto_keep option that automatically converts files but keeps the originals in the library. πŸ› (#1840) πŸ› (#4302)
  • Added a -P (or --disable-plugins) flag to specify one/multiple plugin(s) to be disabled at startup.
  • import-options: Add support for re-running the importer on paths in log files that were created with the -l (or --logfile) argument. πŸ› (#4379) πŸ› (#4387)
  • Preserve mtimes from archives πŸ› (#4392)
  • Add %sunique{} <sunique> template to disambiguate between singletons. πŸ› (#4438)
  • Add a new import.ignored_alias_types config option to allow for specific alias types to be skipped over when importing items/albums.
  • smartplaylist: A new --pretend option lets the user see what a new or changed smart playlist saved in the config is actually returning. πŸ› (#4573)
  • fromfilename: Add debug log messages that inform when the plugin replaced bad (missing) artist, title or tracknumber metadata. πŸ› (#4561) πŸ› (#4600)
  • musicbrainz-config: MusicBrainz release pages often link to related metadata sources like Discogs, Bandcamp, Spotify, Deezer and Beatport. When enabled via the musicbrainz.external_ids options, release ID's will be extracted from those URL's and imported to the library. πŸ› (#4220)
  • convert: Add support for generating m3u8 playlists together with converted media files. πŸ› (#4373)
  • Fetch the release_group_title field from MusicBrainz. πŸ› 4809
  • discogs: Add support for applying album information on singleton imports. πŸ› 4716
  • smartplaylist: During explicit runs of the splupdate command, the log message "Creating playlist ..."" is now displayed instead of hidden in the debug log, which states some form of progress through the UI. πŸ› (#4861)
  • subsonicupdate: Updates are now triggered whenever either the beets database is changed or a smart playlist is created/updated. πŸ› 4862
  • importfeeds: Add a new output format allowing to save a playlist once per import session. πŸ› 4863
  • Make ArtResizer work with PIL/pillow 10.0.0 removals. πŸ› (#4869)
  • A new configuration option, duplicate_verbose_prompt, allows changing how duplicates are presented during import. πŸ› 4866
  • embyupdate: Add handling for private users by adding userid config option. πŸ› (#4402)
  • substitute: Add the new plugin substitute as an alternative to the rewrite plugin. The main difference between them being that rewrite modifies files' metadata and substitute does not. πŸ› (#2786)
  • Add support for artists and albumartists multi-valued tags. πŸ› (#505)
  • autobpm: Add the autobpm plugin which uses Librosa to calculate the BPM of the audio. πŸ› (#3856)
  • fetchart: Fix the error with CoverArtArchive where the maxwidth option would not be used to download a pre-sized thumbnail for release groups, as is already done with releases.
  • fetchart: Fix the error with CoverArtArchive where no cover would be found when the maxwidth option matches a pre-sized thumbnail size, but no thumbnail is provided by CAA. We now fallback to the raw image.
  • advancedrewrite: Add an advanced version of the rewrite plugin which allows to replace fields based on a given library query.
  • lyrics: Add LRCLIB as a new lyrics provider and a new synced option to prefer synced lyrics over plain lyrics.
  • import: Expose import.quiet_fallback as CLI option.
  • import: Expose import.incremental_skip_later as CLI option.
  • smartplaylist: Expose config options as CLI options.
  • smartplaylist: Add new option smartplaylist.output.
  • smartplaylist: Add new option smartplaylist.uri_format.
  • Sorted the default configuration file into categories. πŸ› (#4987)
  • convert: Don't treat WAVE (.wav) files as lossy anymore when using the never_convert_lossy_files option. They will get transcoded like the other lossless formats.
  • Add support for barcode field. πŸ› (#3172)
  • smartplaylist: Add new config option smartplaylist.fields.

Bug fixes

  • lastimport: Improve error handling in the process_tracks function and enable it to be used with other plugins.
  • spotify: Improve handling of ConnectionError.
  • deezer: Improve Deezer plugin error handling and set requests timeout to 10 seconds. πŸ› (#4983)
  • spotify: Add bad gateway (502) error handling.
  • spotify: Add a limit of 3 retries, instead of retrying endlessly when the API is not available.
  • Fix a crash when the Spotify API timeouts or does not return a Retry-After interval. πŸ› (#4942)
  • scrub: Fixed the import behavior where scrubbed database tags were restored to newly imported tracks with config settings scrub.auto: yes and import.write: no. πŸ› (#4326)
  • deezer: Fixed the error where Deezer plugin would crash if non-Deezer id is passed during import.
  • fetchart: Fix fetching from Cover Art Archive when the maxwidth option is set to one of the supported Cover Art Archive widths.
  • discogs: Fix "Discogs plugin replacing Feat. or Ft. with a comma" by fixing an oversight that removed a functionality from the code base when the MetadataSourcePlugin abstract class was introduced in PR's #3335 and #3371. πŸ› (#4401)
  • convert: Set default max_bitrate value to None to avoid transcoding when this parameter is not set. πŸ› (#4472)
  • replaygain: Avoid a crash when errors occur in the analysis backend. πŸ› (#4506)
  • We now use Python's defaults for command-line argument encoding, which should reduce the chance for errors and "file not found" failures when invoking other command-line tools, especially on Windows. πŸ› (#4507)
  • We now respect the Spotify API's rate limiting, which avoids crashing when the API reports code 429 (too many requests). πŸ› (#4370)
  • Fix implicit paths OR queries (e.g. beet list /path/ , /other-path/) which have previously been returning the entire library. πŸ› (#1865)
  • The Discogs release ID is now populated correctly to the discogs_albumid field again (it was no longer working after Discogs changed their release URL format). πŸ› (#4225)
  • The ...
Read more