KOReader calibre plugin

[kyx84]

KOReader calibre plugin
A calibre plugin to synchronize metadata from KOReader to calibre.

KOReader creates sidecar files that hold read progress and annotations. This plugin reads the data from those sidecar files and updates calibre's metadata based on them. It is inspired by the Kobo Utilities plugin, that synchronizes reading progress between the original Kobo firmware ("Nickel") and custom columns in calibre.

Note that at the moment the sync is primarily one-way—from the KOReader device to calibre, and only works for USB and wireless devices. For the latter, you'll need KOReader 2021.04 or newer.

Pushing metadata from calibre to KOReader currently works only for books which do not have KOReader sidecar files, and of course requires the raw metadata column to be mapped. The use-case is for setting up a new device, or if a book was removed from your device and you've now added it back. This has been tested for calibre's Connect to Folder and Custom USB Device modes. It does not seem to work for the Kobo Touch device driver nor with wireless connections, but I (@charlesangus) find those don't communicate perfectly with Calibre/KOReader in any case... I haven't disabled it for other devices - it may be a quirk in my setup which is causing it to fail, and it may work fine for you.

Releases will also be uploaded to this plugin thread on the MobileRead Forums. If you are on there as well, please let me know what you think of the plugin in that thread.

Using this plugin
Download and install
1. Go to your calibre's Preferences > Plugins > Get new plugins and search for KOReader Sync
2. Click Install
3. Restart calibre

Alternatively
1. Download the latest release from here.
2. Go to your calibre's Preferences > Plugins > Load plugin from file and point it to the downloaded ZIP file
3. Restart calibre

Setup
1. Pick and choose the metadata you would like to sync and create the appropriate columns in calibre. These are your options:
- A Floating point numbers column to store the current percent read, with Format for numbers set to `{:.0%}`.
- An Integers column to store the current percent read.
- A regular Text column to store the location you last stopped reading at.
- A Rating column to store your rating of the book, as entered on the book's status page.
- A Long text column to store your review of the book, as entered on the book's status page.
- A regular Text column to store the reading status of the book, as entered on the book status page (Finished, Reading, On hold).
- A Yes/No column to store the reading status of the book, as a boolean (Yes = Finished, No = everything else).
- A Long text column to store your bookmarks and highlights of the book, with Interpret this column as set to Plain text formatted using markdown. (Highlights are an unordered list with their metadata in an HTML comment.)
- A regular Text column to store the MD5 hash KOReader uses to sync progress to a KOReader Sync Server. (Progress sync in the KOReader app.) This might allow for syncing progress to calibre without having to connect your KOReader device, in the future.
- A Date column to store when the last sync was performed.
- A Long text column to store the contents of the metadata sidecar as HTML, with Interpret this column as set to HTML.
10. Add KOReader Sync to main toolbar when a device is connected, if it isn't there already.
11. Right-click the KOReader Sync icon and Configure.
12. Map the metadata you want to sync to the newly created calibre columns.
13. Click OK to save your mapping.
14. From now on just click the KOReader Sync icon to sync all mapped metadata for all books on the connected device to calibre.

Note: Some field are depreciated and removed from plugin since they are changed/removed `sidecar_contents` data structure:
- `first_bookmark` removed
- `last_bookmark` removed
- `bookmarks` renamed to `annotations`
- `rating` uses 5-point instead 10-point scale
- `datesidecarmodified` removed from `calculated`
- `datesidecarmodified` is seems always empty, part of `calculated`

Things to consider
- The plugin overwrites existing metadata in Calibre without asking. That usually isn’t a problem, because you will probably only add to KOReader’s metadata. But be aware that you might lose data in calibre if you’re not careful.
- Pushing sidecars back to KOReader currently only happens for sidecars which are missing. For now, manually delete the `<bookname>.sdr` folder from the device before attempting to push the sidecars back to KOReader for any books you would like to overwrite the current metadata with Calibre's metadata.
- When pushing missing sidecars to the device, no attempt is made to convert Calibre's metadata to account for changes in KOReader's sidecar format. Old metadata may work unpredictably if it's from a different version of KOReader.

Original author grand me permission as source code contributor 
and now I will be maintaining and releasing this plugin. 
Since they is not actively maintaining it.

Old thread: https://www.mobileread.com/forums/sh....php?p=4060545

[kyx84]

Reserved for testing or quick upds to the community