Git Product home page Git Product logo

kindle2notion's Introduction

A program to copy all your Kindle highlights and notes to a page in Notion.
Explore the docs · File issues and feature requests here

If you found this script helpful or appreciate my work, you can support me here:

Kindle2Notion - Export your Kindle clippings to a Notion database. | Product Hunt Buy Me A Coffee

Downloads Contributors Forks Stargazers Issues MIT License LinkedIn

Table of Contents

About The Project

Kindle2Notion Demo

A Python package to export all the clippings from your Kindle device to a page in Notion. Run this script whenever you plug in your Kindle device to your PC.

A key inspiration behind this project was the notes saving feature on Google Play Books, which automatically syncs all your highlights from a book hosted on the service to a Google Doc in real time. I wanted a similar feature for my Kindle and this project is one step towards a solution for this problem.

Intended for

  • Avid readers who would want to browse through their prior reads and highlights anytime anywhere.
  • For those who like to take notes alongside their highlights.

Getting Started

NOTE Need a step-by-step guide to setting this package up? Click here for the full guide.

To get a local copy up and running follow these simple steps:

Prerequisites

  • A Kindle device.
  • A Notion account to store your links.
  • Python 3 on your system to run the code.

Installation & Setup

NOTE As of 10-07-2022, the latest update to this package relies on the offical Notion API for sending API requests. This requires you to create an integration token from here. For old users, you'd have to switch to this method as well since notion-py isn't being maintained anymore.

  1. Install the library.
    pip install kindle2notion
  2. Create an integration on Notion.
    1. Duplicate this database template to your the workspace you want to use for storing your Kindle clippings.
    2. Open Settings & Members from the left navigation bar.
    3. Select the Integrations option listed under Workspaces in the settings modal.
    4. Click on Develop your own integrations to redirect to the integrations page.
    5. On the integrations page, select the New integration option and enter the name of the integration and the workspace you want to use it with. Hit submit and your internal integration token will be generated.
  3. Go back to your database page and click on the Share button on the top right corner. Use the selector to find your integration by its name and then click Invite. Your integration now has the requested permissions on the new database.

Usage

  1. Plug in your Kindle device to your PC.

  2. You need the following three arguments in hand before running the code:

    1. Take your_notion_auth_token from the secret key bearer token provided at
    2. Find your_notion_database_id from the URL of the database you have copied to your workspace. For reference,
      https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
                                        |--------- Database ID --------|
      
    3. your_kindle_clippings_file is the path to your My Clippings File.txt on your Kindle.
  3. Additionally, you may modify some default parameters of the command-line with the following options of the CLI:

    • --enable_highlight_date Set to False if you don't want to see the "Date Added" information in Notion.
    • --enable_book_cover Set to False if you don't want to store the book cover in Notion.
  4. Export your Kindle highlights and notes to Notion!

    • On MacOS and UNIX,
    kindle2notion 'your_notion_auth_token' 'your_notion_table_id' 'your_kindle_clippings_file'
    • On Windows
    python -m kindle2notion 'your_notion_auth_token' 'your_notion_table_id' 'your_kindle_clippings_file'

You may also avail help with the following command:

kindle2notion --help
python -m kindle2notion --help

NOTE This code has been tested on a 4th Gen Kindle Paperwhite on both MacOS and Windows.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jeffrey Jacob (Twitter | Email | LinkedIn)

kindle2notion's People

Contributors

paperboi avatar jlmbaka avatar adam-tokarski avatar guptaanmol184 avatar imesut avatar anshulahuja98 avatar djemeljanovs avatar horhik avatar rahulakrishna 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.