kobo-highlights 0.1.0

Kobo Highlights is a CLI application to manage the bookmarks of your Kobo ereader. It can import them into a human-friendly markdown database.

DISCLAIMER: This is an unofficial project that I developed independently from Kobo and without any contact with them.

Kobo highlights

Kobo highlights is a simple CLI application to manage bookmarks from a Kobo erader. It can import them into a markdown database where they can be easily accessed.

Kobo Highlights was developed in Python using Typer for the CLI functionality and Rich for writing nice text to the terminal.

Kobo highlights was develop as a personal project and it's design is based on how my particular ereader handles bookmarks, so there are no guarantees that it will work on other models.

Requirements

Kobo highlights was developed and tested in Fedora and the automatic tests are run in Ubuntu as macOS. I expect it to work properly on most Linux distributions and on macOS. It has not been testes on Windows, but you can try it.

Kobo highlights requires Python 3.10.

Installation

This project was developed using Poetry and there are multiple ways of installing it:

• Simply download it from pypi: pip install kobo-highlights.

• Install it with Poetry by cloning this repo and running poetry install inside it. Note that you must have poetry installed.

• Install it from the repo using pip by cloning the repo and, inside it, running pip install .

Quick guide

Once Kobo Highlights has been installed, it can be accessed running the kh command. If you run kh --help you should see something like this:

From that message, you can see that the available options from Kobo Highlights are:

• kh config to manage your configuration.

• kh ls to list your bookmarks. By default is prints only new bookmarks, you can use the --all option to print all bookmarks instead.

• kh import to import your bookmarks. It can be called with all, new (default), a bookmark ID, a list of bookmarks IDs, a book title or a book author. Use kh import --help for more information.

You can run any of these commands with the --help option to find out more on how to use them.

The first time you run Kobo Highlights you will be probably told that you need to create a configuration file before doing anything else. You can just follow the instructions to create a valid configuration file. In the next section the program configuration is explained in more detail.

Configuration

Kobo Highlights uses a toml configuration file that is stored in the default directory designated by Typer. In most Linux systems this is in ~/.config/kobo_highlights. The configuration file contains two fields:

• ereader_dir: Is the absolute path to the directory where your erader is mounter. Notably, your ereader doesn't need to be mounted when you create the config file, but you should specify the directory where you expect it to be mounted when you manage your bookmarks.

• target_dir: Is the absolute path to the directory where you want your markdown database to be created. This database will contain one markdown file per book with the highlighted text stored in block quotes.

Evert time you run Kobo Highlights it will try to find a configuration file, if it fails, it will ask you if you want to create one interactively and save it. If you don't want to create a configuration file, Kobo Highlights will stop.

You can manage your configuration file with the kh config command. In particular you cant use config show to show your current configuration and config new to create and save a new configuration.

The markdown database

The main goal of Kobo highlights is to read the bookmarks from the ereader and format them in a way in which they are easy to work with. I choose to do this by creating a markdown database of the bookmarks. This database is located in the directory specified in the configuration and will have a markdown file per book. The names of these files follow the convention <book title> - <book author(s)>.md.

The markdown files will contain, for each bookmark in that book, a markdown block quote that contains the text highlighted in the ereader potentially followed by a set of paragraphs containing the possible annotations that were made about the highlighted text.

Note that Kobo highlights by default only imports new bookmarks to the markdown database. To determine if a bookmark is already in the database, Kobo highlights reads the plain text inside every block quote in every file that could follow the filename convention. This has the following consequences:

• Because only the plain text in the block quotes is read, you can add emphasis indicators (**, *, __, and _) to the highlighted text and Kobo highlights won't notice.

• Because Kobo highlights only looks at the highlighted text, but not at the annotations, you can modify the annotation text as you please and Kobo highlights won't notice.