Skip to main content

Export Readwise highlights to Apple Notes.

Project description

readwise-to-apple-notes

PyPI Changelog Tests License

Export Readwise highlights to Apple Notes.

apple-notes-readwise-folder

Installation

Install this tool using pip:

pip install readwise-to-apple-notes

Usage

[!IMPORTANT] First, obtain a Readwise access token. Then, the token has to be stored, either into an .env file or an environment variable using export READWISE_TOKEN=<your_token>.

For help, run:

readwise-to-apple-notes --help

You can also use:

python -m readwise-to-apple-notes --help

Export

[!NOTE] When you first run the export command. The script will create a new folder in your Apple Notes labled "Readwise" if it does not exist. All highlights within a given book, article, document will be placed in the same note. See example below.

readwise-apple-note-example

Export all highlights:

readwise-to-apple-notes export

You should see progress bars for each document and the number of highlights to be written to a new Apple Note.

readwise-to-apple-notes export

Exporting highlights  [####################################]  28/28 100% 
Exporting highlights  [####################################]  10/10  100%         
Exporting highlights  [####################################]  21/21  100%  

Export after a specific date:

readwise-to-apple-notes export --updated-after 2024-03-15

Export a single books highlights:

readwise-to-apple-notes export --book-id=<user_book_id>

Or a list of books:

readwise-to-apple-notes export --book-id=<user_book_id>,<another_book_id>

Additional Commands

When you need to look up abook_id, run:

readwise-to-apple-notes books

{
    "id": 29932193,
    "title": "Thinking, Fast and Slow",
    "author": "Daniel Kahneman",
    "category": "books",
    "num_highlights": 2,
    "source": "kindle",
    "document_note": "",
    "document_tag": ""
}
...
{
    "id": 29931089,
    "title": "How to Use Readwise",
    "author": "Readwise Team",
    "category": "books",
    "num_highlights": 62,
    "source": "native",
    "document_note": "",
    "document_tag": "readwise"
}

If you know the book_id and want to check a book's details, run:

readwise-to-apple-notes book 29932193

{
    "id": 29932193,
    "title": "Thinking, Fast and Slow",
    "author": "Daniel Kahneman",
    "category": "books",
    "source": "kindle",
    "num_highlights": 2,
    "last_highlight_at": "2016-08-03T04:56:00.000000Z",
    "updated": "2023-07-10T00:56:27.463529Z",
    "cover_image_url": "https://images-na.ssl-images-amazon.com/images/I/41shZGS-G%2BL._SL200_.jpg",
    "highlights_url": "https://readwise.io/bookreview/29932193",
    "source_url": null,
    "asin": "B00555X8OA",
    "tags": [],
    "document_note": ""
}

API Reference

Usage: readwise-to-apple-notes [OPTIONS] COMMAND [ARGS]...

Export Readwise Highlights to Apple Notes.

Options:
--version  Show the version and exit.
--help     Show this message and exit.

Commands:
book
books
export

Development

To contribute to this tool, first checkout the code. Then create a new virtual environment using poetry:

cd readwise-to-apple-notes
poetry install

Now install the dependencies and test dependencies:

poetry install --with=dev

To run the tests:

pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readwise_to_apple_notes-0.1.0.tar.gz (8.9 kB view hashes)

Uploaded Source

Built Distribution

readwise_to_apple_notes-0.1.0-py3-none-any.whl (10.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page