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:
- Export the
KoboReader.sqlite
file from your Kobo and place it in the root path where this code has been downloaded. - Run
pip install .
orpip install --upgrade .
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for kobo_highlights_extractor-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c878c479b5112b96d353c908928bb44eaca93deb1426776321ceaed6189368fa |
|
MD5 | 4c94fabb778d3621b492f2f1b0506ef4 |
|
BLAKE2b-256 | 249e5978a46b4149d3ae20157540163dfe99bd966a103f067c36d2e23b550978 |
Hashes for kobo_highlights_extractor-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ade53b5174342eb9c70201dfd5228bebcdc69691b0583f4677cb8c28efdf66 |
|
MD5 | e97959c30d156fe73f81388ebbcae3ec |
|
BLAKE2b-256 | 814abffda329c4a1c700e87bb23778183cce9180dd357bb04685b886ca37eddf |