datasette-kindle-highlights - freedom of highlights

datasette-kindle-highlights imports Kindle highlights and notes from Bookcision into a SQLite database. This project also leverages Simon Wilson's datasette project to export the resulting database as a website.

Screenshots

Install

Download the pre-built binary from the Github Releases page.

Or, install with cargo:

cargo install kindle_highlights

Docker

Create the database from a directory of JSON files, exported from Bookcision, under a data directory:

kindle_highlights --directory=data

Run the docker image:

docker run -p 8001:8001 -v $PWD/highlights.db:/data/highlights.db rphillips/datasette-kindle-highlights

Browse to http://localhost:8001/

Development

Just is an awesome program to run specific commands.

Running just in the project directory displays a bunch of convienient commands:

just --list
Available recipes:
    all
    build                 # Build Release
    build-debug           # Build Debug
    clean                 # Clean
    clean-db              # Clean database
    clean-rust            # Clean database
    cleanup-venv          # Cleanup virtual environenment
    create-venv           # Create a dev venv if not exist
    generate-db           # Generate the database using ./data directory
    generate-docker-image # Generate docker image
    run                   # Run with datasette
    run-with-docker       # Run with docker
    update-venv           # Update virtualenv

just build will build a release version of kindle_highlights. just run will build kindle_highlights, generate a database, and run datasette

Development Kubernetes

Create a Kubernetes Cluster

ctlptl create cluster kind --registry=ctlptl-registry

Tilt

tilt up

Status

This project is just at the very beginning stages. I welcome anyone to help out. I would like to add the following features:

• Add search functionality
• Wire up an automated, github action, Docker image that contains both datasette and the kindle_highlights application
• Dark mode
• Add more documentation on how to run the application, datasette, and the docker image
• Add better 'note' support to the datasette website

License

datasette-kindle-highlights is licensed under the Apache 2.0 license. For more information, please see the LICENSE-2.0 file.