[Metadata Reader Plugin] KePub Metadata Reader

[jgoguen]

This plugin allows calibre to read metadata from KePub files. This plugin is required for calibre to process KePub metadata and provides no benefit unless you work with KePub files on your Kobo reader.

Usage:
There is no setup or special usage for this plugin. Once installed, restart calibre and the plugin will automatically be invoked when required.

Special Notes:
This plugin requires calibre 2.4.1 or later.

Installation Directions
Open Preferences -> Plugins -> Get new plugins and install the 'KePub Metadata Reader' plugin. You may also download the attached zip file and install the plugin manually, then restart calibre as described in the Introduction to Plugins thread.

Version History

Spoiler:

Version 3.4.2 - 2021-01-05
Fix for non-English locales on Windows failing to load or install the plugin
Version 3.2.9 - 2020-06-17
Fix issue with the logger object not being callable and the conversion adding stray <br> tags
Version 3.2.7 - 2020-05-16
Fix Windows issues with Unicode strings.
Version 3.2.2 - 2020-05-10
Python 3 compatibility - Plugin loads in both calibre and Python 3 calibre beta
Version 3.0.2 - 2017-12-24
Call load_translations where there are translated strings
Version 3.0.0 - 2017-10-30
Imported to BitBucket, made small bugfix and formatting changes, new translations
Version 2.7.1 - 2016-06-27
Spanish translation update
Version 2.7.0 - 2016-06-26
Code cleanup from driver update, no-op functionally
Version 2.5.3 - 2015-09-30
Fix problem preventing the cover image from being set properly with unusually-set OPF IDs
Version 2.5.1 - 2015-08-05
Fix problems with file names not being converted properly
Version 2.5.0 - 2015-08-03
General fixes and non-specific improvements from adding the metadata writer cover image code and conversion input
Version 2.4.2 - 2015-06-15
Fix plugin name
Version 2.4.0 - 2015-05-25
Initial release. Version set to remain in sync with KoboTouchExtended.

[Thorsten]

I can not really install this Plugin. The message say "Plugin is installed".
After the restart of calibre (Version 2.30 [64bit]) I see it is again listed in the class "Not installed".
Please help me.

[jgoguen]

Restart calibre in debug mode (click the arrow beside the Preferences button to reveal the option), check that the plugin is still not installed, close calibre, and a debug log will be shown automatically. Paste that debug log here between QUOTE tags.

[Julianus]

I have the same Problem.

Spoiler:

calibre Fehlerdiagnoseprotokoll
calibre 2.30 [64bit] isfrozen: True is64bit: True
Windows-8-6.2.9200 Windows ('64bit', 'WindowsPE')
('Windows', '8', '6.2.9200')
Python 2.7.9
Windows: ('8', '6.2.9200', '', 'Multiprocessor Free')
Successfully initialized third party plugins: Read KEPUB metadata && Kobo Utilities && KoboBooks && Set KEPUB metadata && KePub Output && KoboTouchExtended
Starting up...
DEBUG: 0.0 KoboUtilites::action.py - loading translations
DEBUG: 0.0 KoboUtilites::dialogs.py - loading translations
DEBUG: 0.0 KoboUtilites::action.py - loading translations
DEBUG: 1.7 No Kobo Touch, Glo or Mini appears to be connected
DEBUG: 1.7 rebuild_menus - self.supports_ratings=None
Started up in 5.23 seconds with 193 books
DEBUG: 11.1 KoboUtilities:_on_device_connection_changed - self.plugin_device_connection_changed.__class__: <type 'PyQt5.QtCore.pyqtBoundSignal'>
DEBUG: 11.1 Methods for self.plugin_device_connection_changed: ['__call__', '__class__', '__delattr__', '__doc__', '__format__', '__getattribute__', '__getitem__', '__hash__', '__init__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', 'connect', 'disconnect', 'emit', 'signal']
Job: 1 Geräteinformationen erhalten started
DeviceJob: 1 Geräteinformationen erhalten done, calling callback
DeviceJob: 1 Geräteinformationen erhalten callback returned
Job: 2 Bibliotheksinformationen festlegen started
DeviceJob: 2 Bibliotheksinformationen festlegen done, calling callback
DeviceJob: 2 Bibliotheksinformationen festlegen callback returned
Job: 3 Liste der Bücher auf dem Gerät erhalten started
DEBUG: 0.0 KoboTouch:books - oncard='None'
DEBUG: 0.0 KoboTouch:books - oncard='None', prefix='F:\'
DEBUG: 0.0 Kobo device: Kobo Glo HD
DEBUG: 0.0 Version of driver: (2, 3, 3) Has kepubs: True
DEBUG: 0.0 Version of firmware: (3, 15, 0) Has kepubs: True
DEBUG: 0.0 Firmware supports cover image tree: True
DEBUG: 0.0 KoboTouch:books - opts.extra_customization= [u'', False, False, False, False, False, False, False, False, False, False, False, u'', True, False, False, False, False, False, False, u'', False]
DEBUG: 0.0 KoboTouch:books - prefs['manage_device_metadata']= manual
DEBUG: 0.0 KoboTouch:books - set_debugging_title to ''
DEBUG: 0.0 KoboTouch:books - length bl=0
C:\Program Files\Calibre2\pylib.zip\dateutil\parser.py:339: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
DEBUG: 0.1 KoboTouch:books - length bl after sync=9
DEBUG: 0.1 KoboTouch:books - reading device database
DEBUG: 0.1 Database Version=117
DEBUG: 0.1 KoboTouch:books - shelf list: [u'fiction', u'Fantasy', u'High-Fantasy', u'sf_fantasy', u'Perry Rhodan']
DEBUG: 0.1 KoboTouch:books - query= SELECT Title, Attribution, DateCreated, ContentID, MimeType, ContentType, ImageID, ReadStatus, ___ExpirationStatus, FavouritesIndex, Accessibility, IsDownloaded, Series, SeriesNumber, ___UserID, ExternalId FROM content where BookID is Null and ((Accessibility = -1 and IsDownloaded in ('true', 1 )) or (Accessibility in (1,2) and IsDownloaded in ('true', 1)) ) and not ((___ExpirationStatus=3 or ___ExpirationStatus is Null) and ContentType = 6) AND (externalId IS NULL OR externalId = '') AND contentId NOT LIKE 'file:///mnt/sd/%'
Job: 1 Geräteinformationen erhalten finished
Keine weiteren Informationen verfügbar.
Job: 2 Bibliotheksinformationen festlegen finished
Keine weiteren Informationen verfügbar.
DEBUG: 0.3 KoboTouch:books - about to sync_booklists
DEBUG: 0.3 USBMS: starting sync_booklists
DEBUG: 0.4 USBMS: finished sync_booklists
DEBUG: 0.4 KoboTouch:books - have done sync_booklists
DEBUG: 0.4 KoboTouch:books - end - oncard='None'
DEBUG: 0.4 KoboTouch:books - oncard='carda'
DEBUG: 0.4 KoboTouch:books - Asked to process 'carda', but do not have one!
DEBUG: 0.4 KoboTouch:books - oncard='cardb'
DEBUG: 0.4 KoboTouch:books - Asked to process 'cardb', but do not have one!
DeviceJob: 3 Liste der Bücher auf dem Gerät erhalten done, calling callback
DeviceJob: metadata_downloaded: Starting set_books_in_library
DeviceJob: set_books_in_library: books to process= 9
DeviceJob: set_books_in_library finished: time= 0.00500011444092
DeviceJob: metadata_downloaded: updating views
DeviceJob: metadata_downloaded: syncing
DeviceJob: metadata_downloaded: refreshing ondevice
DeviceJob: metadata_downloaded: sending metadata_available signal
DEBUG: 11.8 KoboUtilites:_on_device_metadata_available - Start
DEBUG: 11.8 Have a Kobo device connected connected
DEBUG: 11.8 BEGIN Get Device Path
DEBUG: 11.8 Root path of device: F:\
DEBUG: 11.8 END Get Device Path
DEBUG: 11.8 KoboUtilities:get_device - drive_info: {'main': {u'device_store_uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'location_code': 'main', u'date_last_connected': u'2015-06-15T14:45:07.688000+00:00', u'calibre_version': u'2.30.0', u'last_library_uuid': None, u'device_name': u'Kobo Glo HD', u'prefix': 'F:/'}}
DEBUG: 11.8 migrate_library_config_if_required - start
DEBUG: 11.8 get_library_config - library_config: {u'profiles': {u'Default': {u'forDevice': None, u'storeOptionsStore': {u'doNotStoreIfReopened': False, u'storeIfMoreRecent': False, u'storeOnConnect': False, u'promptToStore': True}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 0}, u'customColumnOptions': {u'currentReadingLocationColumn': u'', u'lastReadColumn': u'', u'percentReadColumn': u'', u'ratingColumn': u''}}}, u'SchemaVersion': 0.1}
DEBUG: 11.8 get_plugin_pref - start - store_name='commonOptionsStore', option='individualDeviceOptions'
DEBUG: 11.8 get_plugin_pref - c: {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}
DEBUG: 11.8 get_prefs - start - store_name='backupOptionsStore', prefs_store='{u'Devices': {u'0e9d51fa-e63c-46fb-8115-6134a762849d': {u'uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'name': u'Kobo Glo HD', u'active': True, u'type': u'Kobo Glo HD', u'location_code': u'main', u'serial_no': u'N437545011039'}}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 1434377739}, u'commonOptionsStore': {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}, u'backupOptionsStore': {u'backupDestDirectory': u'', u'backupEachCOnnection': False, u'doDailyBackp': False, u'backupCopiesToKeepSpin': 5, u'backupZipDatabase': True}}'
DEBUG: 11.8 get_prefs - start - store_name='updateOptionsStore', prefs_store='{u'Devices': {u'0e9d51fa-e63c-46fb-8115-6134a762849d': {u'uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'name': u'Kobo Glo HD', u'active': True, u'type': u'Kobo Glo HD', u'location_code': u'main', u'serial_no': u'N437545011039'}}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 1434377739}, u'commonOptionsStore': {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}, u'backupOptionsStore': {u'backupDestDirectory': u'', u'backupEachCOnnection': False, u'doDailyBackp': False, u'backupCopiesToKeepSpin': 5, u'backupZipDatabase': True}}'
DEBUG: 11.8 KoboUtilites:_on_device_metadata_available - self.current_device_profile: None
DEBUG: 11.8 KoboUtilites:_on_device_metadata_available - self.current_backup_config: {u'backupDestDirectory': u'', u'backupEachCOnnection': False, u'doDailyBackp': False, u'backupCopiesToKeepSpin': 5, u'backupZipDatabase': True}
DEBUG: 11.8 Have a Kobo device connected connected
DEBUG: 11.8 BEGIN Get Device Path
DEBUG: 11.8 Root path of device: F:\
DEBUG: 11.8 END Get Device Path
DEBUG: 11.8 KoboUtilities:get_device - drive_info: {'main': {u'device_store_uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'location_code': 'main', u'date_last_connected': u'2015-06-15T14:45:07.688000+00:00', u'calibre_version': u'2.30.0', u'last_library_uuid': None, u'device_name': u'Kobo Glo HD', u'prefix': 'F:/'}}
DEBUG: 11.8 migrate_library_config_if_required - start
DEBUG: 11.8 get_library_config - library_config: {u'profiles': {u'Default': {u'forDevice': None, u'storeOptionsStore': {u'doNotStoreIfReopened': False, u'storeIfMoreRecent': False, u'storeOnConnect': False, u'promptToStore': True}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 0}, u'customColumnOptions': {u'currentReadingLocationColumn': u'', u'lastReadColumn': u'', u'percentReadColumn': u'', u'ratingColumn': u''}}}, u'SchemaVersion': 0.1}
DEBUG: 11.8 get_plugin_pref - start - store_name='commonOptionsStore', option='individualDeviceOptions'
DEBUG: 11.8 get_plugin_pref - c: {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}
DEBUG: 11.8 get_prefs - start - store_name='backupOptionsStore', prefs_store='{u'Devices': {u'0e9d51fa-e63c-46fb-8115-6134a762849d': {u'uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'name': u'Kobo Glo HD', u'active': True, u'type': u'Kobo Glo HD', u'location_code': u'main', u'serial_no': u'N437545011039'}}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 1434377739}, u'commonOptionsStore': {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}, u'backupOptionsStore': {u'backupDestDirectory': u'', u'backupEachCOnnection': False, u'doDailyBackp': False, u'backupCopiesToKeepSpin': 5, u'backupZipDatabase': True}}'
DEBUG: 11.8 get_prefs - start - store_name='updateOptionsStore', prefs_store='{u'Devices': {u'0e9d51fa-e63c-46fb-8115-6134a762849d': {u'uuid': u'0e9d51fa-e63c-46fb-8115-6134a762849d', u'name': u'Kobo Glo HD', u'active': True, u'type': u'Kobo Glo HD', u'location_code': u'main', u'serial_no': u'N437545011039'}}, u'updateOptionsStore': {u'doFirmwareUpdateCheck': False, u'doEarlyFirmwareUpdate': False, u'firmwareUpdateCheckLastTime': 1434377739}, u'commonOptionsStore': {u'individualDeviceOptions': False, u'buttonActionDevice': u'', u'buttonActionLibrary': u''}, u'backupOptionsStore': {u'backupDestDirectory': u'', u'backupEachCOnnection': False, u'doDailyBackp': False, u'backupCopiesToKeepSpin': 5, u'backupZipDatabase': True}}'
DEBUG: 11.8 rebuild_menus - self.supports_ratings=True
DEBUG: 11.8 rebuild_menus - have device.
DeviceJob: 3 Liste der Bücher auf dem Gerät erhalten callback returned
Job: 3 Liste der Bücher auf dem Gerät erhalten finished
Keine weiteren Informationen verfügbar.
Downloading plugin zip attachment: http://plugins.calibre-ebook.com/261009.zip
Installing plugin: C:\Users\Julian\AppData\Local\Temp\calibre_naauhj\ 1kctnk.zip
Downloading plugin zip attachment: http://plugins.calibre-ebook.com/261010.zip
Installing plugin: C:\Users\Julian\AppData\Local\Temp\calibre_naauhj\ 94f3ak.zip

Thats the debuglog with the Glo HD connected.
hope it will help.

[jgoguen]

I think the name of the ZIP file may be different from the name set in the plugin, that may be it. I'll dig a bit further. This line says the plugins were initialized properly:

Successfully initialized third party plugins: Read KEPUB metadata && Kobo Utilities && KoboBooks && Set KEPUB metadata && KePub Output && KoboTouchExtended

[jgoguen]

I was close. The name of the plugin as defined on the plugin index is different from the name set in the plugin itself. I've fixed the name of the plugin and uploaded a new version.

Instead of upgrading the plugin, please remove the plugin, wait for the update, and install the new version. You're looking for plugin version 2.4.2, calibre should pick it up within the next hour or so.

[Julianus]

Thank you very much for your fast support and generaly for your awesome plugins,they are working great now.

[jgoguen]

New version uploaded, fixes issues with file names not being handled correctly. Calibre should offer it soon.

[jgoguen]

New version posted, affecting detection of cover images for some books. Look for calibre to offer the update in the next hour or so.

[Chocky]

Hi,

Calibre will not install the latest versions of the Kepub Reader/Writer , I have 2.4.2 and it says 2.5.3 available.

I have even removed both plugins and reinstalled but it installs the 2.4.2, and it keeps showing the "2 updated plug-ins link" in the bottom right.

[jgoguen]

Can you post a debug log here showing your attempt to upgrade the plugin?

[Chocky]

Originally Posted by jgoguen

Can you post a debug log here showing your attempt to upgrade the plugin?

How do I do that?

[davidfor]

Restart calibre in debug mode by right-clicking on the preferences button and select "Restart in debug mode". Calibre will restart and show a prompt about the logging. Install the plugin and close calibre. In windows, the log will be opened. I'm not sure about the other plaforms, but you should be able to find the log file and post it.

[Chocky]

Here it is.

calibre Debug log
calibre 2.46 [64bit] isfrozen: True is64bit: True
Windows-8-6.2.9200 Windows ('64bit', 'WindowsPE')
('Windows', '8', '6.2.9200')
Python 2.7.9
Windows: ('8', '6.2.9200', '', 'Multiprocessor Free')
Successfully initialized third party plugins: DeDRM && Kindle and Mobipocket DeDRM && K4PC, K4Mac, Kindle Mobi and Topaz DeDRM && Ignoble Epub DeDRM && Inept Epub DeDRM && Inept PDF DeDRM && eReader PDB 2 PML && KePub Input && KePub Metadata Reader && KePub Metadata Writer && Reading List && KePub Metadata Writer && KePub Metadata Reader && KePub Output && Count Pages && Kobo Utilities
Starting up...
DEBUG: 0.0 KoboUtilites::action.py - loading translations
DEBUG: 0.0 KoboUtilites::dialogs.py - loading translations
DEBUG: 0.0 KoboUtilites::action.py - loading translations
DEBUG: 2.0 No Kobo Touch, Glo or Mini appears to be connected
DEBUG: 2.0 rebuild_menus - self.supports_ratings=None, self.supports_tiles=None
Started up in 4.51 seconds with 237 books

[Chocky]

It then opens OK a couple of times but goes back to this.