[Feature]: setup plugin with working metadataTab by Waqibsk · Pull Request #6 · bookbrainz/CaliBBre

Waqibsk · 2026-06-25T14:47:11Z

No description provided.

MonkeyDo · 2026-07-08T17:13:40Z

Hello,
I am still unable to load the plugin. I tried zipping the folder myself, but also using the calibre-customize command suggested in #7

No luck with either.
I do see this debug trace when I open calibre from the command line:

Traceback (most recent call last):
  File "calibre/gui2/ui.py", line 134, in __init__
  File "calibre/gui2/ui.py", line 152, in init_iaction
  File "calibre/customize/__init__.py", line 678, in load_actual_plugin
  File "importlib/__init__.py", line 88, in import_module
  File "<frozen importlib._bootstrap>", line 1406, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1371, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1342, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 938, in _load_unlocked
  File "calibre/customize/zipplugin.py", line 219, in exec_module
  File "calibre_plugins.calibbre.main", line 3, in <module>
    from .plugin import BookBrainzPlugin
  File "calibre/customize/zipplugin.py", line 219, in exec_module
  File "calibre_plugins.calibbre.plugin", line 3, in <module>
    from .ui import Ui_Dialog
  File "calibre/customize/zipplugin.py", line 219, in exec_module
  File "calibre_plugins.calibbre.ui.__init__", line 5, in <module>
    from .metadata_tab import MetadataTabMixin
  File "calibre/customize/zipplugin.py", line 219, in exec_module
  File "calibre_plugins.calibbre.ui.metadata_tab", line 6, in <module>
    from ..workers import (
    ...<2 lines>...
    )
  File "calibre/customize/zipplugin.py", line 219, in exec_module
  File "calibre_plugins.calibbre.workers", line 3, in <module>
    import requests
ModuleNotFoundError: No module named 'requests'

Waqibsk · 2026-07-10T19:09:07Z

Hmm it seems the requests library by default is not supported by calibre ( but apperantly it was working just fine for me during development while i used calibre-customize -b . && calibre-debug -g, maybe some environment issue ).

Replaced the implementation using the standard python library urllib.
it should work now.

would like to know if it fixes the issue

MonkeyDo · 2026-07-31T11:11:14Z

+        retranslate_placeholder(self, _translate)
+
+        self.pushButton_update_metadataTab.setText(
+            _translate("Dialog", "Update Book Metadata")


Capitalization

MonkeyDo · 2026-07-31T11:11:34Z

+        book_name = self.mi.title
+        if not book_name:
+            QMessageBox.warning(
+                self, "Input Error", "The book should have a valid Name"


"name" here shouldn't be capitalized}
Same for "error"

MonkeyDo · 2026-07-31T11:18:02Z

+                if not bbid:
+                    continue
+                bookTitle = item.get("defaultAlias", {}).get("name", "Unknown")
+                bookLang = item.get("defaultAlias", {}).get("language", "eng")


This represents the language of the title rather than the language of the edition.
It's a bit confusing, I know, but the book language should be queried from item.get("languages", []) whichj is an array of language codes (there can be more than one, although that is rare)

"languages": [ "eng", "fra" ],

should display "eng, fra" as a composited string

Is there a built-in way to translate those codes to a language name such as "English, French" or something like that?

MonkeyDo · 2026-07-31T11:31:05Z

+        self.pushButton_fetch_metadataTab.setEnabled(False)
+        self.pushButton_update_metadataTab.setEnabled(False)
+        self.stackedWidget_noResults_metadataTab.setCurrentIndex(1)
+        self.label_noMetadata_metadataTab_2.setText("Network Error")


Capitalization

MonkeyDo · 2026-07-31T11:36:08Z

+        languages = results.get("languages") or []
+        self.label_data_language_metadataTab.setText(
+            ", ".join(languages) if languages else "Unknown"
+        )


I see that the languages here are correct, pulled from the languages array and joined with a comma, contrarily to the search results
This probably warrants creating a utility functiion to extract languages and return a string, that can be reused.

MonkeyDo · 2026-07-31T12:34:09Z

+            cleaned = release_date.lstrip("+00")[:10]
+            parsed = None
+            for fmt in ("%Y-%m-%d", "%Y-%m", "%Y"):
+                try:
+                    parsed = datetime.strptime(cleaned, fmt)
+                    break
+                except ValueError:
+                    pass
+            if parsed:
+                if fmt == "%Y-%m-%d":
+                    release_date = parsed.strftime("%B %d, %Y")
+                elif fmt == "%Y-%m":
+                    release_date = parsed.strftime("%B %Y")
+                else:
+                    release_date = str(parsed.year)
+            else:
+                release_date = release_date.lstrip("+")


I think this whole date parsing routine can be improved.
I put together another approach using regepxs to handle the extended date representation (that +/-YY at the beginning, which is not necessarily "+00", although for Editions they should be very rare), and format it, defaulting to a locale-aware date-only format:
https://www.onlineide.pro/playground/share/cf958f35-b91a-412b-9d63-a4c8dd21bab2

That being said, There might be other options like using a library.

MonkeyDo · 2026-07-31T12:34:24Z

+                authors.append(name)
+
+        if not authors:
+            authors = ["Unknown Author"]


Capitalization

MonkeyDo · 2026-07-31T12:36:47Z

+
+        release_date = bb_data.get("releaseEventDate") or ""
+        if release_date:
+            cleaned = release_date.lstrip("+00")[:10]


Same comment about dates as above.
Whatever the solution chosen, it should be implemented in a reusable method to avoid code duplication.

Waqibsk · 2026-08-08T13:21:32Z

Hi @MonkeyDo, added the suggested changes. Let me know if there is anything else

Waqibsk · 2026-08-08T13:27:15Z

Also a point to note: the /search api endpoint still does not return author names, so the authors column will be empty for now

MonkeyDo

For the purposes of reviewing, clumping in 3 PRs into this one made things much more complicated.
I would much, much have prefered that fixes and improivements were applied directly to each PR, especially if the feedback was left in another PR.

Understand that a PR that add 1,488 line sof code and removes 689 lines is absolutely awful to review.

That beign said, I think this is ready to merge.

Waqibsk added 10 commits June 15, 2026 10:54

cleanup && improve file structure

bbd7ffe

fix: plugin name

eb04191

add: BookBrainz API

c622e63

add: background workers

86cad79

add: metadataTab ui components

3434206

initialize browseTab and collectionTab

7a69c3f

add: main plugin class

7382d28

add: top level ui dialog class

11a2a0c

add: functional metadataTab

ffdaee4

fix: remove unused stackedwidget

8b2a86b

Waqibsk mentioned this pull request Jun 25, 2026

[Feature]: Add metadataTab ui components #5

Closed

fix: replace requests with urllib

c390cb5

MonkeyDo requested changes Jul 31, 2026

View reviewed changes

MonkeyDo mentioned this pull request Jul 31, 2026

[Feature]: Add Bookbrainz api and background workers for metadataTab #4

Closed

Waqibsk added 6 commits August 1, 2026 18:55

fix: change plugin description

36ea745

fix: capitalization

eb92a42

fix: spacing && capitalization

760fe22

feat: open bookbrainz button && remove sortName row

5cc564c

refactor: add date utility function and fix capitalization

0c59749

refactor: format languages

ab3dfd4

fix: language on search results

de785de

MonkeyDo approved these changes Aug 30, 2026

View reviewed changes

MonkeyDo merged commit ee40009 into bookbrainz:gsoc-2026 Aug 30, 2026

Navigation Menu

[Feature]: setup plugin with working metadataTab - #6

[Feature]: setup plugin with working metadataTab#6
MonkeyDo merged 18 commits into
bookbrainz:gsoc-2026from
Waqibsk:setup-plugin

Waqibsk commented Jun 25, 2026

Uh oh!

MonkeyDo commented Jul 8, 2026

Uh oh!

Waqibsk commented Jul 10, 2026 •

edited

Loading

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

MonkeyDo Jul 31, 2026

Uh oh!

Waqibsk commented Aug 8, 2026

Uh oh!

Waqibsk commented Aug 8, 2026

Uh oh!

MonkeyDo left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Waqibsk commented Jun 25, 2026

Uh oh!

MonkeyDo commented Jul 8, 2026

Uh oh!

Waqibsk commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Waqibsk commented Aug 8, 2026

Uh oh!

Waqibsk commented Aug 8, 2026

Uh oh!

MonkeyDo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Waqibsk commented Jul 10, 2026 •

edited

Loading