Skip to main content

An unofficial Python client for the Readwise Reader API.

Project description

logo

Readwise API

An unofficial Python client for the Readwise Reader API.

Installation

pip install readwise-api

Usage

Prerequisites

First, you have to 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>.

Python API

import readwise

List all documents:

readwise.get_documents(location="new")

Get a single document by its ID:

readwise.get_document_by_id("<document_id>")

CLI

List all documents:

readwise list new

Naturally, the output can be saved to a JSON file:

readwise list new > new_documents.json

Get a single document by its ID:

readwise get <document_id>

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_api-0.3.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

readwise_api-0.3.0-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

Details for the file readwise_api-0.3.0.tar.gz.

File metadata

  • Download URL: readwise_api-0.3.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/20.6.0

File hashes

Hashes for readwise_api-0.3.0.tar.gz
Algorithm Hash digest
SHA256 8375853b147007f0709d48bc8601f871e104f48afdfe8bf6364c3ac0a82f8c6f
MD5 ed078d553ab217a7f710940838ae78e4
BLAKE2b-256 ac36c0292cd3564d4704b13c54c35326d909d188adbde4360c177e7920074651

See more details on using hashes here.

File details

Details for the file readwise_api-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: readwise_api-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.3 Darwin/20.6.0

File hashes

Hashes for readwise_api-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6815d02186e429d67c1484156b4f31065f7696d24dc5c4ebfc67350179f3fe50
MD5 dd0e02610cae268ed65d4e4a91e7f950
BLAKE2b-256 4a2b1648646c62ebfeb3507f892d37ecd1c03090143617101e4427dcbf33483c

See more details on using hashes here.

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