Script to import highlights from kobo device to Calibre reader

degiz · 07-13-2021, 01:58 PM

Hey everyone,

tl;dr I've written a script to import highlights from a kobo book to calibre app viewer; please go ahead and try it!

My reading workflow is very much about the highlights, so I like to have them backed up, and easy to come back to in the future. The key point is to be able to see not only the highlight but also the concrete page in the book as if it's a note in a paper book. I use Calibre to manage my ebook library, and would love to keep using it for my highlights collection as well.

I've recently got a Kobo Forma reader (which I love!) and was happy to find out that all highlights are stored in the SQLite database, with some precise location that looks like that:

Code:

span#kobo\.46\.1

I've figured out that this location system is very similar to the EPUB CFI, the one that calibre is using for its ebook viewer highlight, and wrote a python script that imports the highlights from Kobo database, and inserts them into a calibre database as if you annotated text in the Calibre (see the screenshots).

You can find the script here.

So in a nutshell the script does the following:

reads all highlights from Kobo DB
matches the Kobo-book to the Calibre-book
converts location from Kobo-CFI to Epub-CFI
inserts highlights to the calibre DB, making sure there're no duplicates

I don't think that amending the original calibre DB is the best approach, but consider that a hacky solution before I find out the proper one

Current limitations:

not a calibre plugin, but an external script, so you need some basic XP with terminal
works only for (k)epub books (hardcoded format), but tbh I don't have non-epub books at all

I've tested the script on ~10 epub books (in English and Russian), and it works well, I personally use it for each book I read now.

I've only tested this on Mac Os manually, and I'm planning to add some proper tests later when other people also give it a try.

Please make sure to backup your calibre library!

I hope the script will work for you too, and looking forward to hear your opinion!

Cootey · 07-14-2021, 06:48 PM

I can't wait to try this! Does the sync go in the other direction? I'd love to be able to restore lost annotations on my Kobo if that happens.

Sent from my iPad using Tapatalk Pro

Wolfsbruder · 07-14-2021, 08:45 PM

I will be trying this out too, I look forward to being able to restore lost highlights to my kobo devices as well.

Of course my use case is also to keep highlights in sync across all my kobo devices.

degiz · 07-15-2021, 07:57 AM

Quote:

Does the sync go in the other direction?

It's only Kobo->Calibre now. But that's totally doable! I'd like to stabilize the existing functionality first, and then probably implement the other direction too.

Cootey · 07-16-2021, 06:02 AM

Quote:

Originally Posted by degiz

It's only Kobo->Calibre now. But that's totally doable! I'd like to stabilize the existing functionality first, and then probably implement the other direction too.

Sounds great. Good luck.

I'll give your script a try this weekend.

JSWolf · 07-16-2021, 06:22 AM

Can this be converted to a Calibre plugin?

Cootey · 07-16-2021, 06:31 PM

I may have to experiment with this another time. I've got a big project this weekend, and I don't have poetry installed. I get that it's like homebrew or apt, but I only have a little window for playing this weekend, so I'll explore poetry another time, then revisit your script. Cheers!

Bortex · 05-10-2024, 08:13 PM

Quote:

Originally Posted by degiz

It's only Kobo->Calibre now. But that's totally doable! I'd like to stabilize the existing functionality first, and then probably implement the other direction too.

This would be nice 👌

Quoth · 05-11-2024, 08:23 AM

Quote:

Originally Posted by degiz

It's only Kobo->Calibre now. But that's totally doable! I'd like to stabilize the existing functionality first, and then probably implement the other direction too.

But Kobo Utilities on Calibre and Calibre Annotation both do that very well.
Also the optional menu item on MyBooks Book list.

07-13-2021, 01:58 PM	#1
degiz Junior Member Posts: 3 Karma: 29060 Join Date: Jul 2021 Device: Kobo Forma	Script to import highlights from kobo device to Calibre reader Hey everyone, tl;dr I've written a script to import highlights from a kobo book to calibre app viewer; please go ahead and try it! My reading workflow is very much about the highlights, so I like to have them backed up, and easy to come back to in the future. The key point is to be able to see not only the highlight but also the concrete page in the book as if it's a note in a paper book. I use Calibre to manage my ebook library, and would love to keep using it for my highlights collection as well. I've recently got a Kobo Forma reader (which I love!) and was happy to find out that all highlights are stored in the SQLite database, with some precise location that looks like that: Code: span#kobo\.46\.1 I've figured out that this location system is very similar to the EPUB CFI, the one that calibre is using for its ebook viewer highlight, and wrote a python script that imports the highlights from Kobo database, and inserts them into a calibre database as if you annotated text in the Calibre (see the screenshots). You can find the script here. So in a nutshell the script does the following: reads all highlights from Kobo DB matches the Kobo-book to the Calibre-book converts location from Kobo-CFI to Epub-CFI inserts highlights to the calibre DB, making sure there're no duplicates I don't think that amending the original calibre DB is the best approach, but consider that a hacky solution before I find out the proper one Current limitations: not a calibre plugin, but an external script, so you need some basic XP with terminal works only for (k)epub books (hardcoded format), but tbh I don't have non-epub books at all I've tested the script on ~10 epub books (in English and Russian), and it works well, I personally use it for each book I read now. I've only tested this on Mac Os manually, and I'm planning to add some proper tests later when other people also give it a try. Please make sure to backup your calibre library! I hope the script will work for you too, and looking forward to hear your opinion! Attached Thumbnails

07-16-2021, 06:31 PM	#7
Cootey Absentminded Reader Posts: 1,287 Karma: 6916983 Join Date: Apr 2017 Device: Kobo Mini, Libra Colour & Elipsa; Kindle Paperwhite 3 & 4; iOS apps	I may have to experiment with this another time. I've got a big project this weekend, and I don't have poetry installed. I get that it's like homebrew or apt, but I only have a little window for playing this weekend, so I'll explore poetry another time, then revisit your script. Cheers! Last edited by Cootey; 07-16-2021 at 06:34 PM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
How do i import/export highlights in Calibre?	Rbk95	Calibre	15	03-29-2024 10:10 PM
Exporting highlights from Kobo - not using Kobo device	Docno	Windows Devices	0	05-13-2021 02:50 AM
Kobo Reader Device Interface in Calibre - Disable?	ZodWallop	Kobo Reader	2	06-06-2020 05:21 PM
PRS-T1 Is it possible to import highlights with Calibre?	diddy	Sony Reader	53	01-13-2014 09:19 AM
Script: store calibre ebooks as symlinks to existing lib; advanced CLI import	dancal	Calibre	0	12-10-2012 08:09 PM

07-14-2021, 06:48 PM	#2
Cootey Absentminded Reader Posts: 1,287 Karma: 6916983 Join Date: Apr 2017 Device: Kobo Mini, Libra Colour & Elipsa; Kindle Paperwhite 3 & 4; iOS apps	I can't wait to try this! Does the sync go in the other direction? I'd love to be able to restore lost annotations on my Kobo if that happens. Sent from my iPad using Tapatalk Pro

07-14-2021, 08:45 PM	#3
Wolfsbruder Connoisseur Posts: 59 Karma: 260632 Join Date: Apr 2012 Location: US Device: Kobo HD, Kobo Aura H2O, Kobo Aura One, Kobo Forma, Kobo Elipsa	I will be trying this out too, I look forward to being able to restore lost highlights to my kobo devices as well. Of course my use case is also to keep highlights in sync across all my kobo devices.

07-16-2021, 06:22 AM	#6
JSWolf Resident Curmudgeon Posts: 76,465 Karma: 136564696 Join Date: Nov 2006 Location: Roslindale, Massachusetts Device: Kobo Libra 2, Kobo Aura H2O, PRS-650, PRS-T1, nook STR, PW3	Can this be converted to a Calibre plugin?