Skip to main content

A package to extract highlights from kobo books

Project description

Description

With this script you can get the highlights from Kobo reader using the sqlite file. The reason I made it is because when you export the highlights, a basic information as the page where are located is not exported. Oh, thanks, Kobo, for this useless option. When I highlight something usually I want to reference in other place, so maybe I need to search in the original content to expand the context.

Basic Usage

To run the basic usage, you just need to clone this repo and follow the next steps:

  1. Export the KoboReader.sqlite file from your Kobo and place it in the root path where this code has been downloaded.
  2. Run pip install . or pip install --upgrade .
  3. Run python app.py

All the highlights will be extracted and saved in an .md file with the name of the book, into a highlights folder, and with the follow structure:

# Title

## Chapter 1

Lorem Ipsum

Progress: Position progress on chapter
Date: date when the highlight was highlighted

---

Lorem Ipsum2

Progress: Position progress on chapter
Date: date when the highlight was highlighted

## Chapter B

Lorem Ipsum

Note: A note 

Progress: Position progress on chapter
Date: date when the highlight was highlighted

...

Advanced usage

This script accepts some parameters to use in a more advanced usage:

  • --db-file: if your .sqlite file has another name, you can specify it with this param
  • --template: if you want to use another template, you can pass it using this param. Please, use the template at the end as example to know what variables you can use.
  • --highlights-path: if you want to put the exported highlights in another place, you can specify it with this param.

Basic template

# {{ book_data['book_title'] }}

{% for chapter in book_data['chapters'] %}

## {{ chapter['chapter_title'] }}

{% for highlight in chapter['highlights'] %}

> {{ highlight['highlight'].strip() }}

{% if highlight['note'] is not none and highlight['note'] != "" %}
Note: {{ highlight['note'] }}
{% endif %}

Progress: {{ highlight['chapter_progress'] }} %
Date: {{ highlight['date'] }}

---

{% endfor %}
{% endfor %}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kobo_highlights_extractor-0.1.0.tar.gz (16.2 kB view hashes)

Uploaded Source

Built Distribution

kobo_highlights_extractor-0.1.0-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page