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.1.0.tar.gz (4.2 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.1.0-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: readwise_api-0.1.0.tar.gz
  • Upload date:
  • Size: 4.2 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.1.0.tar.gz
Algorithm Hash digest
SHA256 792df91a876928635e3f9373d2a65f75d0f6d57e35e441973b884afba873297c
MD5 aed96d83e50fc938b97d7b7f9fd757f8
BLAKE2b-256 5beeb68bee2367719e843242681f0710b9d8c2a9e4549c44fd5d805eac2fe694

See more details on using hashes here.

File details

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

File metadata

  • Download URL: readwise_api-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ffc64338e1eb86eccb462622a79e83f741cc95d41407952432ca1116708c24e2
MD5 8050fdd66136170fce129e56f300166b
BLAKE2b-256 b9e53903dfcf392f9177f69e6c1f0d7d8fbafd2bec4fc227a1bc53a1460025c9

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