Skip to main content

Push wallabag annotations to Readwise highlights

Project description

wallabag2readwise

Description

Exports / synchronizes annotations from wallabag to Readwise article highlights.

This tool can be run as a cli tool or as a (docker) container.

Rate limiting of the Readwise API is supported.

Installation

CLI

pip install -U wallabag2readwise

or with pipx

pipx install wallabag2readwise

Docker / Container

docker pull ghcr.io/rwxd/wallabag2readwise:latest
docker run ghcr.io/rwxd/wallabag2readwise:latest --wait-time 60 ...

Docker-Compose

version: "3.9"
services:
  wallabag2readwise:
    image: ghcr.io/rwxd/wallabag2readwise:latest
    container_name: wallabag2readwise
    restart: unless-stopped
    environment:
      READWISE_TOKEN: ''
      WALLABAG_URL: ''
      WALLABAG_USER: ''
      WALLABAG_PASSWORD: ''
      WALLABAG_CLIENT_ID: ''
      WALLABAG_CLIENT_SECRET: ''
    # env_file:
    #  - .env
docker-compose up -d && docker-compose logs -f

Usage

Commands

wallabag2readwise push

Daemon

Run continuously and push new annotations to Readwise every 60 minutes. (The container is automatically in daemon mode.)

wallabag2readwise daemon --wait-time 60

Import all Wallabag entries to Readwise Reader

wallabag2readwise reader

Import all Readwise Reader Documents to Wallabag

wallabag2readwise wallabag

Configuration

Get a new Readwise API Token from https://readwise.io/access_token.

Create a new wallabag API client in your instance https://my-wallabag.com/developer/client/create.

ENV Vars

READWISE_TOKEN=''
WALLABAG_URL=''
WALLABAG_USER=''
WALLABAG_PASSWORD=''
WALLABAG_CLIENT_ID=''
WALLABAG_CLIENT_SECRET=''

CLI Options

Secrets can also be used with cli options.

All cli options can be viewed with wallabag2readwise --help

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

wallabag2readwise-1.5.0.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

wallabag2readwise-1.5.0-py3-none-any.whl (9.0 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