dnlbauer / sync_zotero_remarkable

sync zotero collections to a remarkable tablet
Other
43 stars 5 forks source link

Transfer files from a Zotero collection to a folder on a reMarkable.

This uses the Zotero and reMarkable API to keep your reMarkable updated with a folder from Zotero. In short, it fetches a collection from zotero, uses CalDAV to download all corresponding .pdf and .epub files and finally uploads them to the reMarkable cloud. Finally, the zotero collection is cleared to prevent uploading the same file multiple times (so dont use it on your main library but create a separate fodler!)

Installation & Usage

Install via pip:

> pip install git+https://github.com/danijoo/sync_zotero_remarkable

If you're using Debian or Ubuntu, you either need to execute the script with its exact location:

~/.local/bin/sync_zotero_rm 

Or add ~/.local/bin to your $PATH by adding the following line to your ~/.bashrc file as described here:

export PATH="$HOME/.local/bin:$PATH"

On first run, you will be asked to provide login information to zotero, your associated caldav api and remarkable:

sync_zotero_rm

zot_api_key: *******
zot_user_id: *******
zot_collection: unread_files
webdav_url: *******
webdav_user: *******
webdav_password: *******
rm_folder: Read me!

Caution: All login credentials are stored in clear text in your home folder (~/.zotero_remarkable.yaml). So you probably do not want to use this on publicly accessible devices. If you later want to adjust the configuration, e.g. changing the Zotero collection or the folder on your reMarkable, simply change ~/.zotero_remarkable.yaml accordingly.

And then:

Fetching collection from Zotero... Done.
Fetching item list... Done.
Items to sync: 1

#### Processing files ####

Kunzmann et al_2020_Substitution matrix based color schemes for sequence alignment visualization.pdf download, unzip, upload, done.

Removing uploaded items from zotero collection...Done.
Sync complete.

# let's see if it worked.
> rmapi            
ReMarkable Cloud API Shell
[/]>cd Read\ me!/
[/Read me!]>ls

[f] Kunzmann et al_2020_Substitution matrix based color schemes for sequence alignment visualization

TODO

LICENSE

do whatever you want

Do whatever you want.

Inspired by Michael Mior's Zotero reMarkable sync (PHP)