Add Deezer plugin #3355

rhlahuja · 2019-09-02T01:02:34Z

Add a Deezer plugin to allow tracks and albums to be matched using the Deezer API.

Introduce a base MetadataSourcePlugin class to define shared API import logic. This will be integrated into the Spotify plugin in a followup PR.

sampsyo · 2019-09-03T01:07:58Z

Awesome! Looking pretty good so far.

I have just a couple of high-level questions:

Since you said you repurposed some logic from your Spotify plugin, would it make sense to factor out some code that gets reused into a common library?
It looks like there are also changes to the Spotify plugin here too—would you mind breaking those out into a separate PR?

rhlahuja · 2019-09-03T18:29:10Z

Yeah, I was going back and forth on this. Some helpers like album_distance, track_distance, and _get_artist can easily be factored out, although some of the higher-level functions like track_for_id and album_for_id may not quite be similar enough to easily modularize. I'll take another look at this later and refactor what makes sense. Is there a particular place you'd like to place the common library? Something like beetsplug/api_utils.py?
Sure thing -- I'll include the aforementioned Spotify refactor in a separate PR.

sampsyo · 2019-09-03T22:23:41Z

Cool; thanks for looking into it! Depending on the exact scope, something like beets.autotag or beets.autotag.match could be a good fit for these reusable bits.

rhlahuja · 2019-09-05T02:50:36Z

@sampsyo I've factored out shared logic into a base APIAutotaggerPlugin class (better name suggestions welcome). I plan to revert all changes to spotify.py and discogs.py and include them in a separate PR, but I committed them all here for now to get a sense of the final state. Before I begin testing and documenting, what are your thoughts so far?

sampsyo

Awesome; thank you for working on this! This looks great overall. I left a few comments inline.

sampsyo · 2019-09-07T19:22:56Z

beets/autotag/__init__.py

+
+
+@six.add_metaclass(abc.ABCMeta)
+class APIAutotaggerPlugin(object):


In retrospect, perhaps the most natural home for this base class would be in the beets.plugins module?

In general, we have talked several times in beets's history about creating "template" base classes like this one to make it simpler to write certain kinds of plugins. So I'm very happy to see that you came to the same idea independently! It would be great to introduce more of these, so perhaps creating a new place to gather plugin templates together would be the thing to do.

Also, what do you think about the name MetadataSourcePlugin?

Awesome! I was unsure if this class is the right approach, but it's great to hear something like this was already being considered. And I agree, beets.plugins.MetadataSourcePlugin seems like a more natural place/name for this.

sampsyo · 2019-09-07T19:24:42Z

docs/changelog.rst

+* :doc:`/plugins/deezer`:
+   * Added Deezer plugin as an import metadata provider: you can now match tracks
+     and albums using the `Deezer`_ database.
+     Thanks to :user:`rhlahuja`.

 Fixes:


We could even mention the new base class in a "for developers" section.

sampsyo · 2019-09-07T19:24:58Z

docs/changelog.rst

+* :doc:`/plugins/deezer`:
+   * Added Deezer plugin as an import metadata provider: you can now match tracks
+     and albums using the `Deezer`_ database.
+     Thanks to :user:`rhlahuja`.


No need for a nested list here if it's just one bullet.

sampsyo · 2019-09-07T19:25:31Z

docs/plugins/deezer.rst

+--------------------
+
+* You're a Beets user.
+* You want to autotag music with metadata from the Deezer API.


This section doesn't seem to add too much—both of these points are pretty well covered by your introductory sentence above. 😃

rhlahuja · 2019-09-11T07:53:35Z

@sampsyo this is tested and ready for a final review. Once merged, I'll open another PR for reusing this shared logic in the Spotify and Discogs plugins.

sampsyo

Nice! This looks great! I have one small comment above, but I can resolve it myself during the merge. Thank you for taking the time to make this base class awesome! ✨

sampsyo · 2019-09-14T13:31:38Z

beets/autotag/__init__.py

+    AlbumMatch,
+    TrackMatch,
+    Distance,
+)


I think this change can be reverted now because Distance is no longer used here.

Oops; I'm obviously wrong about that. Not changing anything!

Add Deezer plugin

rhlahuja added 15 commits September 1, 2019 17:53

Add Deezer plugin

6e5e8a9

Add changelog hyperlink

e8228d0

Appease flake8

804397b

Add deezer.rst doc, remove unused options

2cf55ee

Formatting

790ca80

Add deezer, spotify docs to autotagger index

ca33f19

Fix doc links

8c84daf

Stringify Deezer ID

2177c76

Fix AlbumInfo.album_credit assignment

43f0929

Include deezer in toctree

240097e

Avoid empty deezer_id string

cd1aa3e

Handle empty deezer_id upfront

70264ee

Fix track.index assignment

2ab883a

Fix track data enumeration idx

9babce5

Simplify regex match

4a55259

Factor out APIAutotaggerPlugin

bd0cea9

rhlahuja added 10 commits September 4, 2019 20:11

Remove unnecessary indexing

f64bd65

Appease flake8

1b05912

Modularize distance

8010488

Use positional str.format arg

30cfd7f

Fix str format arg order

f7c6b5b

Formatting

a3fb8eb

Use Abstract Base Class

0d6df42

Fix Spotify API error formatting

12a8e0a

Formatting

4a6fa56

Use six.with_metaclass

46065c3

rhlahuja added 4 commits September 6, 2019 15:25

with_metaclass --> add_metaclass

867242d

Guard against None match

112941b

Avoid nested capturing groups

bdb7565

Optional capturing groups

0a700c7

sampsyo reviewed Sep 7, 2019

View reviewed changes

rhlahuja added 11 commits September 9, 2019 17:31

Rename/move to plugins.MetadataSourcePlugin, fix formatting

732e372

Fix discogs.py MetadataSourcePlugin refs

68e91b1

Avoid circular import

c531b16

Try absolute import

1de0af6

Move get_distance to beets.autotag

84b1347

Try absolute import

2b0cf3e

Add missing import

dfdf8de

Appease flake8

876c0f7

Move get_distance --> beets.plugins

ed80e91

Use qualified import

6cfe7ad

Revert Spotify, Discogs changes

0b2837d

sampsyo approved these changes Sep 14, 2019

View reviewed changes

sampsyo added a commit that referenced this pull request Sep 14, 2019

Merge pull request #3355 from rhlahuja/add-deezer-plugin

cc6a2bb

Add Deezer plugin

sampsyo added a commit that referenced this pull request Sep 14, 2019

Docs tweaks for #3355

bebb725

sampsyo merged commit 0b2837d into beetbox:master Sep 14, 2019

rhlahuja mentioned this pull request Sep 16, 2019

Integrate MetadataSourcePlugin #3371

Merged

allesmi mentioned this pull request Oct 1, 2019

docs/plugins/discogs.rst: Update plugin documentation #3385

Merged

rhlahuja mentioned this pull request Oct 4, 2019

Add BPSyncPlugin #3389

Merged

wisp3rwind mentioned this pull request Oct 4, 2021

beets fails to detect compilations when importing metadata from Deezer #4057

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Deezer plugin #3355

Add Deezer plugin #3355

rhlahuja commented Sep 2, 2019 •

edited

Loading

sampsyo commented Sep 3, 2019

rhlahuja commented Sep 3, 2019 •

edited

Loading

sampsyo commented Sep 3, 2019

rhlahuja commented Sep 5, 2019

sampsyo left a comment

sampsyo Sep 7, 2019

sampsyo Sep 7, 2019

rhlahuja Sep 10, 2019

sampsyo Sep 7, 2019

sampsyo Sep 7, 2019

sampsyo Sep 7, 2019

rhlahuja commented Sep 11, 2019

sampsyo left a comment

sampsyo Sep 14, 2019

sampsyo Sep 14, 2019



		@six.add_metaclass(abc.ABCMeta)
		class APIAutotaggerPlugin(object):

Add Deezer plugin #3355

Add Deezer plugin #3355

Conversation

rhlahuja commented Sep 2, 2019 • edited Loading

sampsyo commented Sep 3, 2019

rhlahuja commented Sep 3, 2019 • edited Loading

sampsyo commented Sep 3, 2019

rhlahuja commented Sep 5, 2019

sampsyo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhlahuja commented Sep 11, 2019

sampsyo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhlahuja commented Sep 2, 2019 •

edited

Loading

rhlahuja commented Sep 3, 2019 •

edited

Loading