https://github.com/floscha/readwise-api
An unofficial Python client for the Readwise Reader API.
https://github.com/floscha/readwise-api
Last synced: 11 days ago
JSON representation
An unofficial Python client for the Readwise Reader API.
- Host: GitHub
- URL: https://github.com/floscha/readwise-api
- Owner: floscha
- License: mit
- Created: 2023-06-05T12:00:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-12T18:44:15.000Z (almost 2 years ago)
- Last Synced: 2025-04-15T01:48:40.082Z (26 days ago)
- Language: Python
- Size: 52.7 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-readwise - readwise-api - An unofficial Python client for the Readwise Reader API. (Client Libraries)
- jimsghstars - floscha/readwise-api - An unofficial Python client for the Readwise Reader API. (Python)
README
# Readwise API
An unofficial Python client for the [Readwise Reader API](https://readwise.io/reader_api).
## Installation
`pip install readwise-api`
## Usage
### Prerequisites
First, you have to obtain a [Readwise access token](https://readwise.io/access_token).
Then, the token has to be stored, either into an *.env* file or an environment variable using `export READWISE_TOKEN=`.
### Python API
```python
import readwise
```
**List all documents:**
```python
readwise.get_documents(location="new")
```
**Get a single document by its ID:**
```python
readwise.get_document_by_id("")
```
**Save a document to Readwise Reader**
```python
readwise.save_document("https://www.youtube.com/watch?v=dQw4w9WgXcQ")
```
### CLI
**List all documents:**
```shell
readwise list new
```
Naturally, the output can be saved to a JSON file:
```shell
readwise list new > new_documents.json
```
**Get a single document by its ID:**
```shell
readwise get
```
**Save a document to Readwise Reader**
```shell
readwise save "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
```