View Single Post
Old 04-01-2019, 03:59 PM   #1
karl1c
Connoisseur
karl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead communitykarl1c has become a pillar of the MobileRead community
 
Posts: 56
Karma: 15570
Join Date: Jul 2017
Device: iPad
[GUI Plugin] KyBook3 Sync - replaced

The next Update will only be available to those who have donated 1 or more.

If you're using this plugin, please leave a comment to say whether it works for you. Thanks.

Does anyone with some Python experience want to help with developing this plugin? If so, I'd be happy to make it available. PM me.

Now ONLY syncs those file formats in the comma-separated list in settings.

This plugin provides master-slave synchronisation of books and metadata from Calibre to KyBook3 (http://kybook-reader.com).

KyBook3 provides support for almost every book and audiobook format and can read metadata from them. However, many files have incorrect metadata and/or cover. Even when KyBook3 downloads metadata and covers from Calibre's Content Server some metadata and cover errors occur. This plugin is an attempt to overcome these shortcomings.

Main Features:
  • Upload selected books to KyBook3 (skips files with the same MD5 already in KyBook3)
  • Sync title, authors, publishers, subjects, series, publication date, language, comments, ratings, (some) identifiers, & cover to KyBook3 with the following mapping:
    Calibre Tags -> KyBook3 Subjects
    Calibre Comments -> KyBook3 Annotations
  • Backup of KyBook3's metadata

Special Notes:
  • The plugin assumes that Calibre's metadata is more correct than KyBook3's
  • Neither books nor metadata in Calibre are changed.
  • No book files in KyBook3 will be changed or overwritten.
  • Metadata in KyBook3 is overwritten by that in Calibre
  • You should probably ensure that Calibre's Tags are single words with an initial capital
  • Calibre's Comments can (optionally) have HTML stripped
  • There is currently no way to sync from KyBook3 to Calibre (although this is planned)
  • Sync takes place over Wi-Fi, so may take a long time. I suggest you sync in small batches. Alternatively, you can add all the books you want in KyBook3 from iTunes and then run KyBook3 Sync to sync just the metadata

Testimonials:
  • "... syncing calibre with an actual reader app is a dream come true, thank you."
Installation Steps:
  1. Download the attached zip file and install the plugin/restart Calibre/add to context menu or toolbar as described in the Introduction to plugins thread
  2. Click on the KyBook3 Sync icon to see KyBook3's menu
  3. Click on "Customize this plugin" in KyBook3's menu and set the Link, Username, & Password used by KyBook3's Content Server
  4. You should now be able to select some books in Calibre and sync them to KyBook3

Debugging:
If you have problems with the plugin:
  1. Be patient, syncing over WiFi can be slow and if your first book is a 500MB PDF, progress will be "stuck" at 1% for a long time!
  2. In Calibre click Preferences | Restart in debug mode
  3. After the restart, try running the plugin again
  4. When it fails, or it appears to get stuck, close Calibre
  5. A text file will appear with debug info, copy the contents and paste into a post here between spoiler tags (the icon with an eye and a red x) or save the text file to Dropbox and paste a link to it here.

Paypal Donations:
  • If you find this plugin useful please feel free to show your appreciation. I have spent many unpaid hours in its development and support so any encouragement for me to continue is appreciated!

Version History:
Spoiler:

Version 1.0.11 - 18 April 2019
Corrected error when a book had no language assigned

Version 1.0.10 - 10 April 2019
Added syncing of series number (thanks to nimapourkarimi)
Corrected error when no files of the required formats were found
Removed setting ebookid fields to NULL in authors & sequences tables

Version 1.0.9 - 08 April 2019
Corrected error where /$User/covers was not created correctly from Windows (thanks to ilovejedd)

Version 1.0.8 - 08 April 2019
Now ONLY syncs formats specified in settings

Version 1.0.7 - 07 April 2019
Added syncing of rating
Added syncing of some identifiers (isbn, amazon, asin, oclc)
Corrected error in presentation of SQL in debug output

Version 1.0.6 - 05 April 2019
Added automatic logging when running as a plugin
Improved robustness of file uploads

Version 1.0.5 - 04 April 2019
Added progress bar for uploading DB file
Tidied up failure when Content Server on KyBook3 has not been started

Version 1.0.4 - 03 April 2019
Corrected creation of zip file (thanks to ilovejedd)
Added dynamic setting of Calibre's library path (thanks to ilovejedd)
Corrected error where some subjects appeared more than once in KyBook3

Version 1.0.3 - 02 April 2019
Added support for Windows paths
Corrected error in syncing series (thanks to nimapourkarimi)

Version 1.0.2 - 02 April 2019
Added support for Calibre's GUI Debug mode
Corrected filling lookups with NULL values

Version 1.0.1 - 01 April 2019
Changed port number and password for client/listener.

Version 1.0.0 - 01 April 2019
Initial release of KyBook3 Sync plugin


Future Development:
I plan to add the following features:
  • syncing of identifiers (isbn, issn, etc.) [in progress]
  • use Calibre's uuid to avoid calculating md5 and speed up processing
  • adding to Calibre books found in KyBook3, but not already in Calibre
  • syncing metadata back from KyBook3 to Calibre
  • syncing of collections (does anyone actually use collections?)

Last edited by BetterRed; 04-16-2021 at 06:26 AM. Reason: Plugin Replaced
karl1c is offline