Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osteel/kobwise
Convert your Kobo annotations to Readwise highlights
https://github.com/osteel/kobwise
annotations cli composer highlights kobo php readwise
Last synced: 3 months ago
JSON representation
Convert your Kobo annotations to Readwise highlights
- Host: GitHub
- URL: https://github.com/osteel/kobwise
- Owner: osteel
- License: gpl-3.0
- Created: 2021-10-03T14:38:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T15:23:40.000Z (about 2 years ago)
- Last Synced: 2024-08-03T22:14:41.110Z (5 months ago)
- Topics: annotations, cli, composer, highlights, kobo, php, readwise
- Language: PHP
- Homepage:
- Size: 2.88 MB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-readwise - kobwise - Convert Kobo annotations into Readwise highlights. (Tools / Kobo)
README
kobwise
Convert your Kobo annotations to Readwise highlights
## Why?
[Readwise](https://readwise.io) is an application allowing you to import highlights from books, articles, or any source of content you find inspiring and/or worth remembering. It will then resurface these highlights at a frequency of your choosing.
Readwise integrates with various services and platforms to ease the process of importing highlights, but unfortunately it is [not compatible with Kobo](https://help.readwise.io/article/82-does-readwise-support-kobo-highlights).
kobwise is a small command-line application offering a bridge between the two, converting your Kobo annotations to a `.csv` file that is [compatible with Readwise](https://readwise.io/import_bulk).
## Instal
kobwise is written in PHP and is installed using [Composer](https://getcomposer.org):
```
composer global require osteel/kobwise
```
Make sure the `~/.composer/vendor/bin` directory is in your system's `PATH`.
Show me how
If it's not already there, add the following line to your Bash configuration file (usually `~/.bash_profile`, `~/.bashrc`, `~/.zshrc`, etc.):
```
export PATH=~/.composer/vendor/bin:$PATH
```
If the file doesn't exist, create it.
Run the following command on the file you've just updated for the change to take effect:
```
source ~/.bash_profile
```
## Use
All you need to do is call the `convert` command on the annotation file:
```
kobwise convert "The Almanack of Naval Ravikant.txt"
```
It will create a new `.csv` file in the current folder, which you can then [upload to Readwise](https://readwise.io/import_bulk).
A help menu is also available upon running `kobwise` with no arguments:
```
kobwise
```
## Update and delete
Update kobwise:
```
composer global update osteel/kobwise
```
Delete kobwise:
```
composer global remove osteel/kobwise
```
## Known limitations
Kobo's annotation files are formatted in such a way that it is not easy to distinguish separate annotations from different paragraphs belonging to the same annotation.
It is therefore recommended to skim through the annotation file beforehand, and to delete any empty lines between paragraphs that should belong together.
As Readwise doesn't allow its users to [permanently delete highlights](https://help.readwise.io/article/123-why-cant-i-permanently-delete-highlights), it is also recommended to review the `.csv` file before import.
## Wait. I can export my Kobo annotations?
For some reason, Kobo does not enable this option by default, and you need to manually update a configuration file to do so.
The steps are the following:
1. Plug your Kobo to your computer
2. Open the `eReader.config` file at the root of your Kobo
3. Add this line at the very end: `[FeatureSettings] ExportHighlights=true`
4. Save the file and eject your Kobo
5. From your Kobo library, tap the three dots in front of the book you want to export annotations from
6. Tap `Export Annotations`
7. Connect your Kobo to your computer again
8. You should now see a `.txt` file at the root, containing the annotations
If you need more help, here is a [detailed guide](https://www.epubor.com/export-kobo-highlights-and-notes.html) with screenshots.