Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rwxd/wallabag2readwise
Export / synchronize wallabag annotations to readwise highlights
https://github.com/rwxd/wallabag2readwise
export readwise sync wallabag
Last synced: 1 day ago
JSON representation
Export / synchronize wallabag annotations to readwise highlights
- Host: GitHub
- URL: https://github.com/rwxd/wallabag2readwise
- Owner: rwxd
- License: mit
- Created: 2022-10-01T20:56:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T10:38:20.000Z (7 days ago)
- Last Synced: 2024-11-06T11:38:38.080Z (7 days ago)
- Topics: export, readwise, sync, wallabag
- Language: Python
- Homepage: https://rwxd.github.io/wallabag2readwise/
- Size: 96.7 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-readwise - wallabag2readwise - Export / synchronize Wallabag annotations to Readwise highlights. (Tools / Wallabag)
README
# wallabag2readwise
## Description
Exports / synchronizes annotations from [wallabag](https://github.com/wallabag/wallabag) to [Readwise](https://readwise.io/) 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
```bash
pip install -U wallabag2readwise
```
or with [pipx](https://github.com/pypa/pipx)
```bash
pipx install wallabag2readwise
```
### Docker / Container
```bash
docker pull ghcr.io/rwxd/wallabag2readwise:latest
```
```bash
docker run ghcr.io/rwxd/wallabag2readwise:latest --wait-time 60 ...
```
#### Docker-Compose
```yaml
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
```
```bash
docker-compose up -d && docker-compose logs -f
```
## Usage
### Commands
```bash
wallabag2readwise push
```
#### Daemon
Run continuously and push new annotations to Readwise every 60 minutes.
(The container is automatically in daemon mode.)
```bash
wallabag2readwise daemon --wait-time 60
```
#### Import all Wallabag entries to Readwise Reader
```bash
wallabag2readwise reader
```
#### Import all Readwise Reader Documents to Wallabag
```bash
wallabag2readwise wallabag
```
### Configuration
Get a new Readwise API Token from .
Create a new wallabag API client in your instance .
#### ENV Vars
```bash
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`