| tocdepth: | 2 |
|---|
This project adheres to Semantic Versioning.
- Metatracks always failing equality (89e25d2)
- Add importlib_metadata dependency for entry_points backport (4cc6b97)
- Update dependencies (50e148c)
- Support python 3.12 (408594a)
- Upgrade sqlalchemy to v2.0.0 (4e568e5)
- Upgrade lint dependencies (8a9047d)
- Upgrade docs dependencies (8d95017)
- Upgrade test dependencies (0b5b384)
- Upgrade pytest to v7.0.0 (50eb061)
- Upgrade rich to v13.0.0 (3ee7ef0)
- Upgrade pluggy to v1.0.0 (88c0384)
- Add -d option to rm command to delete files (8246eb8)
- Query: Added support for numeric range queries (fac29a1)
I'm not particularly happy about how little time as passed between v1.0.0 and this release and I don't expect this timeframe to be the norm. In a perfect world, I'm releasing at most 1-2 major versions per year of Moe. I justified this timeframe as I still don't think there's many people using Moe and the list of breaking changes I wanted to implement had settled at a good number.
With that said, I recommend reading through the following notes before upgrading.
Use mediafile dependency over moe_mediafile fork (bcda77d)
Now that our changes have been merged into mediafile, there's no longer a need to use our fork.
You may experience issues if you have both moe_mediafile and mediafile installed together. All users upgrading should explicitly uninstall moe_mediafile by running ``pip uninstall moe_mediafile``.
DB sessions are now explicitly passed as arguments (228a017)
This helps clarify exactly which functions require the database to be initialized. Also, it helps avoid any potential future issues with relying entirely on a global/thread-local session factory.
The following functions/hooks are affected by this change:
add.add_item- newsessionparametercli.Hooks.add_command- the sub-command functions are now passed asessionparameterconfig.Hooks.register_sa_event_listeners-sessionparameter removedduplicate.resolve_dup_items- newsessionparameterduplicate.Hooks.resolve_dup_items- newsessionparameterduplicate.resolve_duplicates- newsessionparameterduplicate.get_duplicates- newsessionparameterlibrary.lib_item.Hooks.edit_changed_items- newsessionparameterlibrary.lib_item.Hooks.edit_new_items- newsessionparameterlibrary.lib_item.Hooks.process_removed_items- newsessionparameterlibrary.lib_item.Hooks.process_changed_items- newsessionparameterlibrary.lib_item.Hooks.process_new_items- newsessionparameterquery.query- newsessionparameterremove.remove_item- newsessionparameterutil.cli.query.cli_query- newsessionparameter
config.MoeSessionhas also been replaced withconfig.moe_sessionmaker. Sessions should no longer be created by importingMoeSession, and instead should use a session parameter that is created at the top-level of an application. Refer to theconfig.pydocstring as well ascli.pyfor more information on how to handle sessions now.Changed CandidateAlbum attributes (9cc69db)
source_stris now split into two fields:plugin_sourceandsource_id. This is so in the future we can check against theplugin_sourceand apply different handling criteria per plugin e.g. import weight values.sub_header_inforenamed todisambigs. The "sub-header" is specific to the cli, so it was renamed to be more generalized.
Replaced
lib_patharg forfmt_item_pathwith optionalparentarg (cc267d5)This is more flexible as it allows specifying the direct parent for albums, extras and tracks instead of just albums.
Removed sync plugin (ae0889d)
The original idea of the sync plugin to sync multiple metadata sources with one command has some implementation barriers that were not fully fleshed out. Instead, each plugin should just implement their own sync commands.
Removed musicbrainz plugin (d171be0)
Musicbrainz is now a third-party plugin to be consistent with Moe's policy that any external source plugins should not be in the core repository.
If you'd like to continue to use musicbrainz as an import source, you can install the new plugin with
pip install moe_musicbrainz. Also, ensure to enable it in your configuration. You can find more information on the Thid-Pary Plugins documentation page.Removed
pluginsub-directory and package (d3d756d)Now, rather than having to import an api function as
moe.plugins.add.add_item, it's justmoe.add.add_item. I felt the extrapluginsimport level was unnecessarily verbose.Custom fields now require dictionary access (1df625c)
Custom fields must now be accessed via
item.custom["my_custom_field"]i.e. normal dictionary access.I changed this from normal attribute access as overriding
__getattr__and__setattr__(required for transparent attribute access) had some finicky conflicts with sqlalchemy. Also, it prevented type hinting the custom attribute dictionary as well as integration with data serializers such as pydantic.Overall, the more I used them, the more issues I found, and the more it felt like a hack. I believe the new explicit dictionary access for custom attributes will prove to be more bulletproof. It also explicitly delineates normal and custom attributes which can be useful in some cases.
Renamed
album_objreference toalbumin tracks and extras (51ff9a9)track.albumnow refers to the actual album object (renamed fromtrack.album_obj) andtrack.albumartisthas been removed. Similarly,extra.album_objhas been renamed toextra.album.The original idea was that
track.albumwas a string that referred to an album's title, whiletrack.album_objwas the actual album object itself.track.albumandtrack.albumartistwere "mapped" attributes of an album directly exposed in the track API due to convention. However, these mapped attributes are not first-class attributes as far as sqlalchemy is concerned, and thus have additional issues and considerations compared to normal attributes. Ultimately, I decided these mapped attributes are not worth the headache.
- Slightly improved start-up time by importing default plugins (0ffd10a)
- Removed pyyaml dependency (2519817)
- Ensure tracks created from files contain required tags (bf215ed)
- Add new lib_path argument to fmt_item_path (5ed5dc4)
- Add sample rate and bit depth as track properties (f9c3384)
- [none] catalog number from musicbrainz now properly set (25d73e1)
- Albumartist overwriting track artist (6bbf445)
- Support python 3.11 (de6ebd2)
- Show catalog number after label during import (84f8067)
- Musicbrainz error if release does not have a date or format (d0fe109)
- Track audio_format is now a property and not a field (c2aeda7)
- Use fork of mediafile (53d8333)
- New MetaAlbum and MetaTrack classes (e496e7c)
- New track field - audio_format (07fce9f)
- New album field - catalog_nums (01c7170)
- CLI prompts now allow arrow keys to navigate choices (78344f9)
- New album field - track_total (eb947b9)
- Improve musicbrainz search accuracy (891b995)
- Tags now written to tracks if album fields changed (48f7076)
- New read plugin for updating items in moe with any file changes (adbbdd4)
- New album field - barcode (72d07d3)
First stable release! From this point on, the API is considered stable and breaking changes will result in a new major version per semantic versioning.
- Update docs for stable release (07fec3e)
- Import wrong dataclass (ee6959a)
- Support for external third-party plugins (b0c736c)
- Users can now create custom plugins in their configuration dir (84347f6)
- Add command can now handle adding extras (ab83e63)
- Candidate prompt to select an album to import (c5ff9a5)
- Musicbrainz error if a release has no label (6991a41)
- Musicbrainz error if release does not have a country specified (1c0f844)
- Sync_item not called with keyword arguments (7c4b65a)
- New config option
original_date(3894fa7) - New field - original_date (416d202)
- Add media, label, country, and year to import header (ce9cc9a)
- New album field - label (80e8348)
- New album field - country (5a51d71)
- New album field - media (256a3a6)
- New track field - artists (7701d9e)
- New path template function to get a unique extra filename (8a0c3a3)
- Allow plugins to create custom path template functions (195ea9c)
- Add mbcol cli argument to sync music to a musicbrainz collection (4f00136)
- List cli output is now sorted (fbb11d0)
- Add: New import option to skip a single item (3d3027c)
- Adjusted track match values to be more lenient (9b90803)
- Relative path error if album and file use non-relative hardlinks (8574e38)
- New sync plugin to sync music metadata (6ad78f2)
- Duplicate prompt ui improvements (fd24944)
- Import prompt ui improvements (2bbff8c)
- New global config option to explicitly disable plugins (88d6bab)
- Albums were not querying properly if they didn't contain tracks (094257d)
- Duplicate genres now persist in the database (6a655b0)
- Custom fields now populate when loaded from the database (911d0f7)
- Add rich as a dependency (626b20c)
Some big changes here, notably requiring python3.9 to take get the json1 extension in sqlite. This is what allows us to now support custom fields in plugins. This version introduces an non-backwards-compatible database change, and thus will require a deletion of any current library.
- Read and write musicbrainz ids (ef82c67)
- New hook to allow plugins to write custom tags to a track (8ee8fcb)
- New hook to allow plugins to read/set custom track tags (b5069ba)
- Custom fields can be set by plugins for all library items (9606c1d)
- MB: New api call to update an album from musicbrainz (2a972de)
- MB: Added new api call to set a mb collection to a set of releases (aad7959)
- MB: Ability to auto update a musicbrainz collection (6e1cec1)
- Add: Guess a track's disc number if not given or presumed wrong (d71afd9)
- Fuzzy match title when matching tracks (37b9f02)
- Paths are now configurable.
- Better duplicate resolution.
- clean query_type code
- remove src directory
- config: extra plugins can be specified in config init
- add
plugin_registrationhook to allow custom plugin registration
- cli: move
edit_new_itemsandprocess_new_itemshooks - switch to using a thread-local session
- remove core subpackage
- change to src/moe layout
- split cli and core files
- add: abort will now abort importing an item entirely
- add: take advantage of argparse pathlib type
- api: introduce core api
- library: add
fieldsattribute to library items - query: "*" query now searches by track ID
- library: take advantage of is_unique in eq
- list: add ability to list item paths
- move: remove ability to auto-move items on tag changes
- move: remove leftover empty dirs after an album has been moved
- move: add the
movecommand
- add: use ‘artist’ as a backup for ‘albumartist’ if missing
- add: invalid tracks aren’t added as extras and are logged properly
- more appropriate names for sub-command parsers
- abstract sqlalchemy orm events into new hook specifications
- move: add
asciify_pathsconfiguration option
- move: move/copying tracks & extras now requires a destination
- mrmoe -> moe
- cli: only print warnings or worse logs for external libraries
- info: error accessing empty fields
- info: album info now only prints album attributes
- track: remove
file_extfield - track: genre is now a concatenated string and genres is a list
- track: don’t expose
album_pathas a track field - extra: album -> album_obj
- track: properly read musibrainz track id from file
- write: write date, disc, and disc_total to track file
- move: album copies to proper directory on add
- move: don’t move items until they’ve been added to the dB
- write and move properly oeprate on all altered items
- library: error when adding duplicate genres
- add: abstract questionary dependency from API
- api: define the api
- add: track file types now transferred when adding a new album via prompt
- add: only print new track title on prompt if it changed
Fix issues installing from PYPI. (Lesson learned to use test.pypi.org next time.)
Initial Alpha Release!
Basic features include:
- add/remove/edit/list music to your library
- import metadata from Musicbrainz