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 details)

Uploaded Source

Built Distribution

wallabag2readwise-1.5.0-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file wallabag2readwise-1.5.0.tar.gz.

File metadata

  • Download URL: wallabag2readwise-1.5.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for wallabag2readwise-1.5.0.tar.gz
Algorithm Hash digest
SHA256 9b9ef772e55d70cd7616d0f3f00383c09602d3976c02586c76f88d25fe730bc1
MD5 ddf28c7c628e3f253c2bddd30c5e84a6
BLAKE2b-256 4dbcf8d70916b3c21d8d72d02cdd0b9f436fa928b899610793251c97ac7dc115

See more details on using hashes here.

File details

Details for the file wallabag2readwise-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wallabag2readwise-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e8ca4577748ef0ff586e9de349363e29040e95d3e5c540baedc85921d980051
MD5 0c10d52d3bb64e0ba0b269c43612dd8e
BLAKE2b-256 c274745fd5dd267e871e9d298c6e4422af15dbe50f2d68fd780ab8a68abb2ce2

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