KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

kindle-clippings

★ 85 Open GitHub ↗

A Python-script to extract and organise highlights and notes from the "My Clippings.txt" file on a Kindle e-reader.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# kindle-clippings

This script reads the `My Clippings.txt` file, which is stored in the `documents`-folder on a Kindle e-reader, extracts the notes and highlights and stores these as separate text files for each publication (e-book, PDF, etc.) in a clippings directory. These clippings files can then be edited, reorganised and re-ordered within the clippings directory, and only new highlights and notes will be added the next time the script is run. The output files use reStructured Text (RST) formatting, so that they can be easily converted into new e-books, which include metadata on the publications (title, author). Metadata on the notes/highlights (location, date, type, partial SHA256-hash) is written as an RST-comment before each note, so this information can be found in the text files but becomes invisible if they are converted into e-books or other output document types (PDF, word processor files, etc.).

This script requires Python 3 and is written for use on Linux, Mac, BSD and other Unix-derivatives, although it will probably also work on Windows (I can't test this as I don't run Windows, so feel free to open issues, or better, create a fix and commit a pull request if it doesn't work). I've tested the script with the `My Clippings.txt` file from both my old first-generation Kindle and my newer 10th generation Kindle. Please open an issue or commit a fix if it doesn't work with later Kindle-versions.

Note that this script currently only works with a Kindle that is set to English language, because the format of the notes and highlights changes with the language setting. See [issue #2](https://github.com/lvzon/kindle-clippings/issues/2) for alternative regular expressions that recognise French and Spanish, I currently haven't implemented languages other than English.

Usage: `./extract-kindle-clippings.py [<My Clippings.txt file> [<output directory>]]`

If not specified, the default input file is `./My Clippings.txt` or `/media/$USER/Kindle/documents/My Clippings.txt`. The default output directory is `./clippings/`.

The script works by scanning `My Clippings.txt` and generating a SHA-256 hash for each note, which is stored in the output file comments. When the script is run, it scans all RST-files in the output directory for hashes, and only writes the notes and highlights which weren't found in the output directory. Publications which have only one or two notes/highlights don't get their own output file, but the notes/highlights are appended to `short_notes.rst`, together with the author and title of the publication. Each output file is given the time and date of the most recent note/highlight.

Because the script only scans the hashes in the comments, you're free to rename, move, split, combine, amend and otherwise edit the output files, as long as you keep the comment lines (the lines starting with `..`), keep the files within the output directory (or subdirectories thereof) and keep the `.rst` file extension. You can move comment lines anywhere in the RST-file, and even safely delete or change the actual notes/highlights. You can also safely combine output files from different e-readers or other sources.

This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

kindle-clippings

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README