https://github.com/elchead/readwise-note-extractor

extract highlights from a given (markdown) file and upload them to Readwise
https://github.com/elchead/readwise-note-extractor

Last synced: 2 months ago
JSON representation

extract highlights from a given (markdown) file and upload them to Readwise

• Host: GitHub
• URL: https://github.com/elchead/readwise-note-extractor
• Owner: elchead
• Created: 2021-12-02T22:40:15.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-23T15:36:38.000Z (almost 3 years ago)
• Last Synced: 2024-08-03T22:14:55.320Z (5 months ago)
• Language: Python
• Homepage:
• Size: 7.81 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-readwise - readwise-note-extractor - Export markdown highlights to Readwise. (Tools / Other)

README

        
# 📝 Readwise Note Extractor

The script extracts highlights from a given (markdown) file and uploads them to Readwise.

The note reader is specific to my note formatting but can be easily adjusted.

## Format

I have initial metadata at the top of the file that I want to ignore. The ending of my metadata is detected through a specific text line (currently hardcoded).

A highlight is defined through linebreaks.

E.g.:

```

This is meta.

This line indicates end of meta.

This is a highlight.

This is another highlight.

...

```

## Installation

1. Create an `.env` file with your Readwise API token `TOKEN=...`.

2. To read the token, install:

   ```

   pip install python-decouple

   ```

3. Include in `PATH`. I created a symbolic link in a path included directory to directly run the script from anywhere.

   ```

   ln -s push_readwise.py ~/homebrew/bin

   ```

## Usage

Run `push_readwise.py` to upload the notes of the file (currently hardcoded to `index.en.md`)