[GUI Plugin] KOReader Sync

[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.

For best experience please use the latest KOReader release

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

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.

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.

Full and detailed readme can be found here

For Bug reports or Feature requests please use github template


Old thread

[kyx84]

User feedback is needed

[kyx84]

New release: https://github.com/harmtemolder/kore...ses/tag/v0.6.4

(looking on how to upload it to the first post, since I do not have rights to edit my own post)

[theducks]

Originally Posted by kyx84

New release: https://github.com/harmtemolder/kore...ses/tag/v0.6.4

(looking on how to upload it to the first post, since I do not have rights to edit my own post)

Moderator Notice
Done it

You should be able to do this very soon as you will reach whatever magic points level the forum requires.

[igorius]

Great update! Thanks a lot!

[kyx84]

v0.6.5

What's Changed

• Readme updated with latest changes, auto-format the text by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/34

• Enabling sync to koreader with exception catch for Permission issue to help with #28 by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/32

Full Changelog: https://github.com/harmtemolder/kore...0.6.4...v0.6.5

Github: https://github.com/harmtemolder/kore...ses/tag/v0.6.5

[kyx84]

v0.6.6

What's Changed

• Adding mobileread plugin thread to the readme, ver upd by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/35

• Fixing koreader to calibre rating by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/37

Full Changelog: https://github.com/harmtemolder/kore...0.6.5...v0.6.6

[Uncle Robin]

I just tried this for the first time in a very long time, this was the result

Spoiler:

calibre, version 7.15.0
ERROR: Unhandled exception: <b>KeyError</b>:'column_date_sidecar_modified'

calibre 7.15 embedded-python: True
Windows-10-10.0.19045-SP0 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.19045')
Python 3.11.5
Windows: ('10', '10.0.19045', 'SP0', 'Multiprocessor Free')
Interface language: None
EXE path: C:\Program Files\Calibre2\calibre.exe
Successfully initialized third party plugins: DeDRM (10, 0, 9) && Calibre Power Search Plugin (2, 2, 0) && Count Pages (1, 13, 6) && EpubMerge (3, 1, 0) && Find Duplicates (1, 10, 9) && KOReader Sync (0, 6, 6) && KePub Input (3, 6, 6) && KePub Output (3, 6, 11) && Kindle hi-res covers (0, 5, 1) && Kobo Books (1, 9, 2) && Kobo Utilities (2, 17, 1) && KoboTouchExtended (3, 6, 11) && MultiColumnSearch (1, 0, 96) && Obok DeDRM (10, 0, 9) && Reading List (1, 15, 4) && Save Composite Custom Columns (1, 1, 1) && View Manager (1, 10, 3)
Traceback (most recent call last):
File "calibre\utils\config.py", line 430, in __getitem__
KeyError: 'column_date_sidecar_modified'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "calibre_plugins.koreader.action", line 841, in sync_to_calibre
File "calibre_plugins.koreader.action", line 410, in update_metadata
File "calibre\utils\config.py", line 432, in __getitem__
KeyError: 'column_date_sidecar_modified'

[kyx84]

Originally Posted by Uncle Robin

I just tried this for the first time in a very long time, this was the result

Spoiler:

calibre, version 7.15.0
ERROR: Unhandled exception: <b>KeyError</b>:'column_date_sidecar_modified'

calibre 7.15 embedded-python: True
Windows-10-10.0.19045-SP0 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.19045')
Python 3.11.5
Windows: ('10', '10.0.19045', 'SP0', 'Multiprocessor Free')
Interface language: None
EXE path: C:\Program Files\Calibre2\calibre.exe
Successfully initialized third party plugins: DeDRM (10, 0, 9) && Calibre Power Search Plugin (2, 2, 0) && Count Pages (1, 13, 6) && EpubMerge (3, 1, 0) && Find Duplicates (1, 10, 9) && KOReader Sync (0, 6, 6) && KePub Input (3, 6, 6) && KePub Output (3, 6, 11) && Kindle hi-res covers (0, 5, 1) && Kobo Books (1, 9, 2) && Kobo Utilities (2, 17, 1) && KoboTouchExtended (3, 6, 11) && MultiColumnSearch (1, 0, 96) && Obok DeDRM (10, 0, 9) && Reading List (1, 15, 4) && Save Composite Custom Columns (1, 1, 1) && View Manager (1, 10, 3)
Traceback (most recent call last):
File "calibre\utils\config.py", line 430, in __getitem__
KeyError: 'column_date_sidecar_modified'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
File "calibre_plugins.koreader.action", line 841, in sync_to_calibre
File "calibre_plugins.koreader.action", line 410, in update_metadata
File "calibre\utils\config.py", line 432, in __getitem__
KeyError: 'column_date_sidecar_modified'

fixed in upcoming release, if you do not want to wait - uncheck Sync only if changes are more recent and try again

[kyx84]

v0.6.7

What's Changed

• Adding script for md to bb converter by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/39

• Adding issue template for a bug and feature request by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/40

• Updating bug_report and feature_request with latest fields by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/41

• Fix for checkbox sync if more recent by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/42

• Bug template: multi selection for dropdown by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/43

• Release prep for v0.6.7 by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/44

Full Changelog: https://github.com/harmtemolder/kore...0.6.6...v0.6.7

[Uncle Robin]

Awesome, thanks for that!

[Goldbucket]

An chance to get this working, if the sidecar folders are stored in a different place (./docsettings). It's not about an SD Card, just the KOReader setting to prevent them from appearing in Nickel.

[Leilu]

Thank you for taking over the development.
I've always wanted to be able to synchronize my reading progress on KOReader from Calibre but it's never worked. I'll give it a try.

Edit:

It's working. Thank you. I now have a way to transfer my reading progress if my e-reader breaks down.

I have several improvement ideas:
1- Add the possibility to sync the KOReader history with Calibre.
2- Improve the synchronization interface. With my 1,295 books, it's impossible to scroll to find the one that was successfully synchronized. Perhaps it would be better to sort or filter this sync screen. Maybe with only the synchronized one at the top or even hide all the others with the option to open a json log file for more details.
3- Add the ability to sync tags in both directions to take advantage of KOReader's new collections feature.
4- Add a progress bar to sync. Calibre that freezes for several tens of seconds is not very reassuring.

[kyx84]

Originally Posted by Leilu

I have several improvement ideas:
1- Add the possibility to sync the KOReader history with Calibre.
2- Improve the synchronization interface. With my 1,295 books, it's impossible to scroll to find the one that was successfully synchronized. Perhaps it would be better to sort or filter this sync screen. Maybe with only the synchronized one at the top or even hide all the others with the option to open a json log file for more details.
3- Add the ability to sync tags in both directions to take advantage of KOReader's new collections feature.
4- Add a progress bar to sync. Calibre that freezes for several tens of seconds is not very reassuring.

all question/issues were submitted vial Github and tracked there if interested

[kyx84]

v0.6.8

What's Changed

• Do not edit raw sidecar when restoring to KOReader by @harmtemolder in https://github.com/harmtemolder/kore...plugin/pull/52

• fix: convert bookmarks from array to object on old sidecars by @TheOnlyWayUp in https://github.com/harmtemolder/kore...plugin/pull/51

• Do not mark as failed if book id is not found in calibre db by @kyxap in https://github.com/harmtemolder/kore...plugin/pull/59

New Contributors

• @harmtemolder made their first contribution in https://github.com/harmtemolder/kore...plugin/pull/52

• @TheOnlyWayUp made their first contribution in https://github.com/harmtemolder/kore...plugin/pull/51

Full Changelog: https://github.com/harmtemolder/kore...0.6.7...v0.6.8