Giter Site home page Giter Site logo

rufex / kindle-clippings Goto Github PK

View Code? Open in Web Editor NEW
6.0 2.0 0.0 28 KB

Script to organize clippings made using a Kindle device.

License: MIT License

Python 100.00%
kindle highlight clipping amazon ebook epub mobi text books article kindle-highlights kindle-clippings organize-clippings

kindle-clippings's Introduction

Kindle Clippings Organizer

Python Script for extracting notes taken in a Kindle and organize them in a separate .txt files for each book or article.

First checks in your collection of previously generated files if there is already a file corresponding to the book to be exported, and only append to them the new ones.

Setting it up

  1. Install the needed dependencies
  2. Create a YAML file called "config_kindle_highlights.yml", with the following structure:
Paths:
  bookshelf: { absolute path to the directory where you are storing your generated TXTs }
  clippings_file: { absolute path to the txt where the clippings are stored by your Kindle }
  output_folder: { absolute path to a directory where you want to store your new TXTs }
  log_file: { absolute path to your log file }
  last_date: 2000-01-01 

How to use it

  1. Make sure your YAML contains all the needed information.
  2. Run your script from the your terminal, passing the needed arguments.
python kindle_clippings.py [-h] [--filter-date] {append,create,show-list}
  • mode (required)
    • append: look for existing files and only add highlights that were not previously stored. If the file doesn't exist, create a new one in the output folder.
    • create: create new files for every book in the output folder.
    • show-list: it won't create nor modify any file, just display the overview of generated highlights.
  • filter-date (optional): Only look for new clippings, based on the date store in the YAML (last clipping exported in a previous run)

kindle-clippings's People

Contributors

rufex avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.