beets 1.4.2

This is just a little bug fix release. With 1.4.2, we're also confident enough to recommend that anyone who's interested give Python 3 a try: bugs may still lurk, but we've deemed things safe enough for broad adoption. If you can, please install beets with pip3 instead of pip2 this time and let us know how it goes!

Here are the fixes:

• badfiles: Fix a crash on non-ASCII filenames. #2299
• The %asciify{} path formatting function and the asciify-paths setting properly substitute path separators generated by converting some Unicode characters, such as ½ and ¢, into ASCII.
• convert: Fix a logging-related crash when filenames contain curly braces. Thanks to @kierdavis. #2323
• We've rolled back some changes to the included zsh completion script that were causing problems for some users. #2266

Also, we've removed some special handling for logging in the discogs that we believe was unnecessary. If spurious log messages appear in this version, please let us know by filing a bug.

beets 1.4.1

Version 1.4 has alpha-level Python 3 support. Thanks to the heroic efforts of @jrobeson, beets should run both under Python 2.7, as before, and now under Python 3.4 and above. The support is still new: it undoubtedly contains bugs, so it may replace all your music with Limp Bizkit—but if you're brave and you have backups, please try installing on Python 3. Let us know how it goes.

If you package beets for distribution, here's what you'll want to know:

• This version of beets now depends on the six library.
• We also bumped our minimum required version of Mutagen to 1.33 (from 1.27).
• Please don't package beets as a Python 3 application yet, even though most things work under Python 3.4 and later.

This version also makes a few changes to the command-line interface and configuration that you may need to know about:

• duplicates: The duplicates command no longer accepts multiple field arguments in the form -k title albumartist album. Each argument must be prefixed with -k, as in -k title -k albumartist -k album.
• The old top-level colors configuration option has been removed (the setting is now under ui).
• The deprecated list_format_album and list_format_item configuration options have been removed (see format_album and format_item).

The are a few new features:

• mpdupdate, mpdstats: When the host option is not set, these plugins will now look for the $MPD_HOST environment variable before falling back to localhost. Thanks to @tarruda. #2175
• web: Added an expand option to show the items of an album. #2050
• embyupdate: The plugin can now use an API key instead of a password to authenticate with Emby. #2045 #2117
• acousticbrainz: The plugin now adds a bpm field.
• beet --version now includes the Python version used to run beets.
• /reference/pathformat can now include unescaped commas (,) when they are not part of a function call. #2166 #2213
• The update command takes a new -F flag to specify the fields to update. Thanks to @dangmai. #2229 #2231

And there are a few bug fixes too:

• convert: The plugin no longer asks for confirmation if the query did not return anything to convert. #2260 #2262
• embedart: The plugin now uses jpg as an extension rather than jpeg, to ensure consistency with the plugins/fetchart. Thanks to @tweitzel. #2254 #2255
• embedart: The plugin now works for all jpeg files, including those that are only recognizable by their magic bytes. #1545 #2255
• web: The JSON output is no longer pretty-printed (for a space savings). #2050
• permissions: Fix a regression in the previous release where the plugin would always fail to set permissions (and log a warning). #2089
• beatport: Use track numbers from Beatport (instead of determining them from the order of tracks) and set the medium_index value.
• With per_disc_numbering enabled, some metadata sources (notably, the beatport) would not set the track number at all. This is fixed. #2085
• play: Fix $args getting passed verbatim to the play command if it was set in the configuration but -A or --args was omitted.
• With ignore_hidden enabled, non-UTF-8 filenames would cause a crash. This is fixed. #2168
• embyupdate: Fixes authentication header problem that caused a problem that it was not possible to get tokens from the Emby API.
• lyrics: Some titles use a colon to separate the main title from a subtitle. To find more matches, the plugin now also searches for lyrics using the part part preceding the colon character. #2206
• Fix a crash when a query uses a date field and some items are missing that field. #1938
• discogs: Subtracks are now detected and combined into a single track, two-sided mediums are treated as single discs, and tracks have media, medium_total and medium set correctly. #2222 #2228.
• missing: missing is now treated as an integer, allowing the use of (for example) ranges in queries.
• smartplaylist: Playlist names will be sanitized to ensure valid filenames. #2258
• The ID3 APIC tag now uses the Latin-1 encoding when possible instead of a Unicode encoding. This should increase compatibility with other software, especially with iTunes and when using ID3v2.3. Thanks to @lazka. #899 #2264 #2270

The last release, 1.3.19, also erroneously reported its version as "1.3.18" when you typed beet version. This has been corrected.

beets 1.3.19

This is primarily a bug fix release: it cleans up a couple of regressions that appeared in the last version. But it also features the triumphant return of the beatport and a modernized bpd.

It's also the first version where beets passes all its tests on Windows! May this herald a new age of cross-platform reliability for beets.

New features:

• beatport: This metadata source plugin has arisen from the dead! It now works with Beatport's new OAuth-based API. Thanks to
  @jbaiter. #1989 #2067
• bpd: The plugin now uses the modern GStreamer 1.0 instead of the old 0.10. Thanks to @philippbeckmann. #2057 #2062
• A new --force option for the remove command allows removal of items without prompting beforehand. #2042
• A new duplicate_action importer config option controls how duplicate albums or tracks treated in import task. #185

Some fixes for Windows:

• Queries are now detected as paths when they contain backslashes (in addition to forward slashes). This only applies on Windows.
• embedart: Image similarity comparison with ImageMagick should now work on Windows.
• fetchart: The plugin should work more reliably with non-ASCII paths.

And other fixes:

• replaygain: The bs1770gain backend now correctly calculates sample peak instead of true peak. This comes with a major speed increase. #2031
• lyrics: Avoid a crash and a spurious warning introduced in the last version about a Google API key, which appeared even when you hadn't enabled the Google lyrics source.
• Fix a hard-coded path to bash-completion to work better with Homebrew installations. Thanks to @bismark. #2038
• Fix a crash introduced in the previous version when the standard input was connected to a Unix pipe. #2041
• Fix a crash when specifying non-ASCII format strings on the command line with the -f option for many commands. #2063
• fetchart: Determine the file extension for downloaded images based on the image's magic bytes. The plugin prints a warning if result is not consistent with the server-supplied Content-Type header. In previous versions, the plugin would use a .jpg extension for all images. #2053

beets 1.3.18

This update adds a new hook that lets you integrate beets with command-line tools and an export that can dump data from the beets database as JSON. You can also automatically translate lyrics using a machine translation service.

The echonest plugin has been removed in this version because the API it used is shutting down. You might want to try the acousticbrainz instead.

Some of the larger new features:

• The new hook lets you execute commands in response to beets events.
• The new export can export data from beets' database as JSON. Thanks to @GuilhermeHideki.
• lyrics: The plugin can now translate the fetched lyrics to your native language using the Bing translation API. Thanks to @Kraymer.
• fetchart: Album art can now be fetched from fanart.tv.

Smaller new things:

• There are two new functions available in templates: %first and %ifdef. See template-functions.
• convert: A new album_art_maxwidth setting lets you resize album art while copying it.
• convert: The extension setting is now optional for conversion formats. By default, the extension is the same as the name of the configured format.
• importadded: A new preserve_write_mtimes option lets you preserve mtime of files even when beets updates their metadata.
• fetchart: The enforce_ratio option now lets you tolerate images that are almost square but differ slightly from an exact 1:1 aspect ratio.
• fetchart: The plugin can now optionally save the artwork's source in an attribute in the database.
• The terminal_encoding configuration option can now also override the input encoding. (Previously, it only affected the encoding of the standard output stream.)
• A new ignore_hidden configuration option lets you ignore files that your OS marks as invisible.
• web: A new values endpoint lets you get the distinct values of a field. Thanks to @sumpfralle. #2010

Fixes:

• Fix a problem with the stats command in exact mode when filenames on Windows use non-ASCII characters. #1891
• Fix a crash when iTunes Sound Check tags contained invalid data. #1895
• mbcollection: The plugin now redacts your MusicBrainz password in the beet config output. #1907
• scrub: Fix an occasional problem where scrubbing on import could undo the id3v23 setting. #1903
• lyrics: Add compatibility with some changes to the LyricsWiki page markup. #1912 #1909
• lyrics: Fix retrieval from Musixmatch by improving the way we guess the URL for lyrics on that service. #1880
• edit: Fail gracefully when the configured text editor command can't be invoked. #1927
• fetchart: Fix a crash in the Wikipedia backend on non-ASCII artist and album names. #1960
• convert: Change the default ogg encoding quality from 2 to 3 (to fit the default from the oggenc(1) manpage). #1982
• convert: The never_convert_lossy_files option now considers AIFF a lossless format. #2005
• web: A proper 404 error, instead of an internal exception, is returned when missing album art is requested. Thanks to
  @sumpfralle. #2011
• Tolerate more malformed floating-point numbers in metadata tags. #2014
• The ignore configuration option now includes the lost+found directory by default.
• acousticbrainz: AcousticBrainz lookups are now done over HTTPS. Thanks to @Freso. #2007

beets 1.3.17

This release introduces one new plugin to fetch audio information from the AcousticBrainz project and another plugin to make it easier to submit your handcrafted metadata back to MusicBrainz. The importer also gained two oft-requested features: a way to skip the initial search process by specifying an ID ahead of time, and a way to manually provide metadata in the middle of the import process (via the edit plugin).

Also, as of this release, the beets project has some new Internet homes! Our new domain name is beets.io, and we have a shiny new GitHub organization: beetbox.

Here are the big new features:

• A new acousticbrainz fetches acoustic-analysis information from the AcousticBrainz project. Thanks to @opatel99, and thanks to Google Code-In! #1784
• A new mbsubmit lets you print music's current metadata in a format that the MusicBrainz data parser can understand. You can trigger it during an interactive import session. #1779
• A new --search-id importer option lets you manually specify IDs (i.e., MBIDs or Discogs IDs) for imported music. Doing this skips the initial candidate search, which can be important for huge albums where this initial lookup is slow. Also, the enter Id prompt choice now accepts several IDs, separated by spaces. #1808
• edit: You can now edit metadata on the fly during the import process. The plugin provides two new interactive options: one to edit your music's metadata, and one to edit the matched metadata retrieved from MusicBrainz (or another data source). This feature is still in its early stages, so please send feedback if you find anything missing. #1846 #396

There are even more new features:

• fetchart: The Google Images backend has been restored. It now requires an API key from Google. Thanks to @lcharlick. #1778
• info: A new option will print only fields' names and not their values. Thanks to @GuilhermeHideki. #1812
• The fields command now displays flexible attributes. Thanks to @GuilhermeHideki. #1818
• The modify command lets you interactively select which albums or items you want to change. #1843
• The move command gained a new --timid flag to print and confirm which files you want to move. #1843
• The move command no longer prints filenames for files that don't actually need to be moved. #1583

Fixes:

• play: Fix a regression in the last version where there was no default command. #1793
• lastimport: The plugin now works again after being broken by some unannounced changes to the Last.fm API. #1574
• play: Fixed a typo in a configuration option. The option is now warning_threshold instead of warning_treshold, but we kept the old name around for compatibility. Thanks to @JesseWeinstein. #1802 #1803
• edit: Editing metadata now moves files, when appropriate (like the modify command). #1804
• The stats command no longer crashes when files are missing or inaccessible. #1806
• fetchart: Possibly fix a Unicode-related crash when using some versions of pyOpenSSL. #1805
• replaygain: Fix an intermittent crash with the GStreamer backend. #1855
• lastimport: The plugin now works with the beets API key by default. You can still provide a different key the configuration.
• replaygain: Fix a crash using the Python Audio Tools backend. #1873

beets 1.3.16

The big news in this release is a new interactive editor plugin. It's really nifty: you can now change your music's metadata by making changes in a visual text editor, which can sometimes be far more efficient than the built-in modify-cmd` command. No more carefully retyping the same artist name with slight capitalization changes.

This version also adds an oft-requested "not" operator to beets' queries, so you can exclude music from any operation. It also brings friendlier formatting (and querying!) of song durations.

The big new stuff:

• A new edit lets you manually edit your music's metadata using your favorite text editor. #164 #1706
• Queries can now use "not" logic. Type a ^ before part of a query to exclude matching music from the results. For example, beet list -a beatles ^album:1 will find all your albums by the Beatles except for their singles compilation, "1." See not_query. #819 #1728
• A new embyupdate can trigger a library refresh on an Emby server when your beets database changes.
• Track length is now displayed as "M:SS" rather than a raw number of seconds. Queries on track length also accept this format: for example, beet list length:5:30.. will find all your tracks that have a duration over 5 minutes and 30 seconds. You can turn off this new behavior using the format_raw_length configuration option. #1749

Smaller changes:

• Three commands, modify, update, and mbsync, would previously move files by default after changing their metadata. Now, these commands will only move files if you have the config-import-copy or config-import-move options enabled in your importer configuration. This way, if you configure the importer not to touch your filenames, other commands will respect that decision by default too. Each command also sprouted a --move command-line option to override this default (in addition to the --nomove flag they already had). #1697
• A new configuration option, va_name, controls the album artist name for various-artists albums. The setting defaults to "Various Artists," the MusicBrainz standard. In order to match MusicBrainz, the discogs also adopts the same setting.
• info: The info command now accepts a -f/--format option for customizing how items are displayed, just like the built-in list command. #1737

Some changes for developers:

• Two new plugin hooks , albuminfo_received and trackinfo_received, let plugins intercept metadata as soon as it is received, before it is applied to music in the database. #872
• Plugins can now add options to the interactive importer prompts. See append_prompt_choices. #1758

Fixes:

• plexupdate: Fix a crash when Plex libraries use non-ASCII collection names. #1649
• discogs: Maybe fix a crash when using some versions of the requests library. #1656
• Fix a race in the importer when importing two albums with the same artist and name in quick succession. The importer would fail to detect them as duplicates, claiming that there were "empty albums" in the database even when there were not. #1652
• plugins/lastgenre: Clean up the reggae-related genres somewhat. Thanks to @Freso. #1661
• The importer now correctly moves album art files when re-importing. #314
• fetchart: In auto mode, the plugin now skips albums that already have art attached to them so as not to interfere with re-imports. #314
• fetchart: The plugin now only resizes album art if necessary, rather than always by default. #1264
• fetchart: Fix a bug where a database reference to a non-existent album art file would prevent the command from fetching new art. #1126
• thumbnails: Fix a crash with Unicode paths. #1686
• embedart: The remove_art_file option now works on import (as well as with the explicit command). #1662 #1675
• metasync: Fix a crash when syncing with recent versions of iTunes. #1700
• duplicates: Fix a crash when merging items. #1699
• smartplaylist: More gracefully handle malformed queries and missing configuration.
• Fix a crash with some files with unreadable iTunes SoundCheck metadata. #1666
• thumbnails: Fix a nasty segmentation fault crash that arose with some library versions. #1433
• convert: Fix a crash with Unicode paths in --pretend mode. #1735
• Fix a crash when sorting by nonexistent fields on queries. #1734
• Probably fix some mysterious errors when dealing with images using ImageMagick on Windows. #1721
• Fix a crash when writing some Unicode comment strings to MP3s that used older encodings. The encoding is now always updated to UTF-8. #879
• fetchart: The Google Images backend has been removed. It used an API that has been shut down. #1760
• lyrics: Fix a crash in the Google backend when searching for bands with regular-expression characters in their names, like Sunn O))). #1673
• scrub: In auto mode, the plugin now actually only scrubs files on import, as the documentation always claimed it did---not every time files were written, as it previously did. #1657
• scrub: Also in auto mode, album art is now correctly restored. #1657
• Possibly allow flexible attributes to be used with the %aunique template function. #1775
• lyrics: The Genius backend is now more robust to communication errors. The backend has also been disabled by default, since the API it depends on is currently down. #1770

beets 1.3.15

This release adds a new plugin for checking file quality and a new source for lyrics. The larger features are:

• A new badfiles helps you scan for corruption in your music collection. Thanks to @fxthomas. #1568
• lyrics: You can now fetch lyrics from Genius.com. Thanks to @sadatay. #1626 #1639
• zero: The plugin can now use a "whitelist" policy as an alternative to the (default) "blacklist" mode. Thanks to @adkow. #1621 #1641

And there are smaller new features too:

• Add new color aliases for standard terminal color names (e.g., cyan and magenta). Thanks to @mathstuf. #1548
• play: A new --args option lets you specify options for the player command. #1532
• play: A new raw configuration option lets the command work with players (such as VLC) that expect music filenames as arguments, rather than in a playlist. Thanks to @nathdwek. #1578
• play: You can now configure the number of tracks that trigger a "lots of music" warning. #1577
• embedart: A new remove_art_file option lets you clean up if you prefer only embedded album art. Thanks to @jackwilsdon. #1591 #733
• plexupdate: A new library_name option allows you to select which Plex library to update. #1572 #1595
• A new include option lets you import external configuration files.

This release has plenty of fixes:

• lastgenre: Fix a bug that prevented tag popularity from being considered. Thanks to @svoos. #1559
• Fixed a bug where plugins wouldn't be notified of the deletion of an item's art, for example with the clearart command from the embedart. Thanks to @nathdwek. #1565
• fetchart: The Google Images source is disabled by default (as it was before beets 1.3.9), as is the Wikipedia source (which was causing lots of unnecessary delays due to DBpedia downtime). To re-enable these sources, add wikipedia google to your sources configuration option.
• The list command's help output now has a small query and format string example. Thanks to @pkess. #1582
• fetchart: The plugin now fetches PNGs but not GIFs. (It still fetches JPEGs.) This avoids an error when trying to embed images, since not all formats support GIFs. #1588
• Date fields are now written in the correct order (year-month-day), which eliminates an intermittent bug where the latter two fields would not get written to files. Thanks to @jdetrey. #1303 #1589
• replaygain: Avoid a crash when the PyAudioTools backend encounters an error. #1592
• The case sensitivity of path queries is more useful now: rather than just guessing based on the platform, we now check the case sensitivity of your filesystem. #1586
• Case-insensitive path queries might have returned nothing because of a wrong SQL query.
• Fix a crash when a query contains a "+" or "-" alone in a component. #1605
• Fixed unit of file size to powers of two (MiB, GiB, etc.) instead of powers of ten (MB, GB, etc.). #1623

beets 1.3.14

This is mainly a bugfix release, but we also have a nifty new plugin for ipfs and a bunch of new configuration options.

The new features:

• A new ipfs plugin lets you share music via a new, global, decentralized filesystem. #1397
• duplicates: You can now merge duplicate track metadata (when detecting duplicate items), or duplicate album tracks (when detecting duplicate albums).
• duplicates: Duplicate resolution now uses an ordering to prioritize duplicates. By default, it prefers music with more complete metadata, but you can configure it to use any list of attributes.
• metasync: Added a new backend to fetch metadata from iTunes. This plugin is still in an experimental phase. #1450
• The move command has a new --pretend option, making the command show how the items will be moved without actually changing anything.
• The importer now supports matching of "pregap" or HTOA (hidden track-one audio) tracks when they are listed in MusicBrainz. (This feature depends on a new version of the musicbrainzngs library that is not yet released, but will start working when it is available.) Thanks to @ruippeixotog. #1104 #1493
• plexupdate: A new token configuration option lets you specify a key for Plex Home setups. Thanks to @edcarroll. #1494
• zero: A new update_database configuration option nulls out fields in the database along with files' tags. #1516

Fixes:

• fetchart: Complain when the enforce_ratio or min_width options are enabled but no local imaging backend is available to carry them out. #1460
• importfeeds: Avoid generating incorrect m3u filename when both of the m3u and m3u_multi options are enabled. #1490
• duplicates: Avoid a crash when misconfigured. #1457
• mpdstats: Avoid a crash when the music played is not in the beets library. Thanks to @CodyReichert. #1443
• Fix a crash with ArtResizer on Windows systems (affecting embedart, fetchart, and thumbnails). #1448
• permissions: Fix an error with non-ASCII paths. #1449
• Fix sorting by paths when the sort_case_insensitive option is enabled. #1451
• embedart: Avoid an error when trying to embed invalid images into MPEG-4 files.
• fetchart: The Wikipedia source can now better deal artists that use non-standard capitalization (e.g., alt-J, dEUS).
• web: Fix searching for non-ASCII queries. Thanks to
  @oldtopman. #1470
• mpdupdate: We now recommend the newer python-mpd2 library instead of its unmaintained parent. Thanks to @somasis. #1472
• The importer interface and log file now output a useful list of files (instead of the word "None") when in album-grouping mode. #1475 #825
• Fix some logging errors when filenames and other user-provided strings contain curly braces. #1481
• Regular expression queries over paths now work more reliably with non-ASCII characters in filenames. #1482
• Fix a bug where the autotagger's ignored setting was sometimes, well, ignored. #1487
• Fix a bug with Unicode strings when generating image thumbnails. #1485
• keyfinder: Fix handling of Unicode paths. #1502
• fetchart: When album art is already present, the message is now printed in the text_highlight_minor color (light gray). Thanks to
  @somasis. #1512
• Some messages in the console UI now use plural nouns correctly. Thanks to
  @JesseWeinstein. #1521
• Sorting numerical fields (such as track) now works again. #1511
• replaygain: Missing GStreamer plugins now cause a helpful error message instead of a crash. #1518
• Fix an edge case when producing sanitized filenames where the maximum path length conflicted with the replace rules. Thanks to Ben Ockmore. #496 #1361
• Fix an incompatibility with OS X 10.11 (where /usr/sbin seems not to be on the user's path by default).
• Fix an incompatibility with certain JPEG files. Here's a relevant Python bug. Thanks to @nathdwek. #1545
• Fix the group_albums importer mode so that it works correctly when files are not already in order by album. #1550
• The fields command no longer separates built-in fields from plugin-provided ones. This distinction was becoming increasingly unreliable.
• duplicates: Fix a Unicode warning when paths contained non-ASCII characters. #1551
• fetchart: Work around a urllib3 bug that could cause a crash. #1555 #1556
• When you edit the configuration file with beet config -e and the file does not exist, beets creates an empty file before editing it. This fixes an error on OS X, where the open command does not work with non-existent files. #1480

beets 1.3.13

This is a tiny bug-fix release. It copes with a dependency upgrade that broke beets. There are just two fixes:

• Fix compatibility with Jellyfish version 0.5.0.
• embedart: In auto mode (the import hook), the plugin now respects the write config option under import. If this is disabled, album art is no longer embedded on import in order to leave files untouched---in effect, auto is implicitly disabled. #1427

beets 1.3.12

This little update makes queries more powerful, sorts music more intelligently, and removes a performance bottleneck. There's an experimental new plugin for synchronizing metadata with music players.

Packagers should also note a new dependency in this version: the Jellyfish Python library makes our text comparisons (a big part of the auto-tagging process) go much faster.

New features:

• Queries can now use "or" logic: if you use a comma to separate parts of a query, items and albums will match either side of the comma. For example, beet ls foo , bar will get all the items matching foo or matching bar. See combiningqueries. #1423
• The autotagger's matching algorithm is faster. We now use the Jellyfish library to compute string similarity, which is better optimized than our hand-rolled edit distance implementation. #1389
• Sorting is now case insensitive by default. This means that artists will be sorted lexicographically regardless of case. For example, the artist alt-J will now properly sort before YACHT. (Previously, it would have ended up at the end of the list, after all the capital-letter artists.) You can turn this new behavior off using the sort_case_insensitive configuration option. See query-sort. #1429
• An experimental new metasync lets you get metadata from your favorite music players, starting with Amarok. #1386
• fetchart: There are new settings to control what constitutes "acceptable" images. The minwidth option constrains the minimum image width in pixels and the enforce_ratio option requires that images be square. #1394

Little fixes and improvements:

• fetchart: Remove a hard size limit when fetching from the Cover Art Archive.
• The output of the fields command is now sorted. Thanks to @multikatt. #1402
• replaygain: Fix a number of issues with the new bs1770gain backend on Windows. Also, fix missing debug output in import mode. #1398
• Beets should now be better at guessing the appropriate output encoding on Windows. (Specifically, the console output encoding is guessed separately from the encoding for command-line arguments.) A bug was also fixed where beets would ignore the locale settings and use UTF-8 by default. #1419
• discogs: Better error handling when we can't communicate with Discogs on setup. #1417
• importadded: Fix a crash when importing singletons in-place. #1416
• fuzzy: Fix a regression causing a crash in the last release. #1422
• Fix a crash when the importer cannot open its log file. Thanks to @barsanuphe. #1426
• Fix an error when trying to write tags for items with flexible fields called date and original_date (which are not built-in beets fields). #1404