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.2.0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readwise_api-0.2.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readwise_api-0.2.0.tar.gz
  • Upload date:
  • Size: 4.3 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.2.0.tar.gz
Algorithm Hash digest
SHA256 18c3b9044d1bc4924d6e2d33358f9cb59e0c3c9344d93352e89a732deff480ba
MD5 a2b16b986302fa5af1af648da98638cd
BLAKE2b-256 3f7a2f5b0d5bc564742ec02ac2cb276158e89e8f806a8dbe469431b43af03f18

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readwise_api-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4632b056e51b11d0c7f552933ee77306e455d594f7a5dd447ae865144dc6cb4a
MD5 266a28a6b5d0a8b2bb37ae9f46336701
BLAKE2b-256 a56edc32323be0475805b471ffd2c9b901701e2af8b88a2ff2020a824bcad5ce

See more details on using hashes here.

Supported by

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