Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dnlbauer/sync_zotero_remarkable
sync zotero collections to a remarkable tablet
https://github.com/dnlbauer/sync_zotero_remarkable
Last synced: about 11 hours ago
JSON representation
sync zotero collections to a remarkable tablet
- Host: GitHub
- URL: https://github.com/dnlbauer/sync_zotero_remarkable
- Owner: dnlbauer
- License: other
- Created: 2020-05-14T13:36:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-03T13:38:56.000Z (almost 4 years ago)
- Last Synced: 2024-05-21T04:34:15.097Z (6 months ago)
- Language: Python
- Size: 30.3 KB
- Stars: 42
- Watchers: 4
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-reMarkable - sync_zotero_remarkable - Sync PDFs from Zotero to reMarkable. (Cloud Tools / Launchers)
README
## 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:
``` python
> 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:
```bash
~/.local/bin/sync_zotero_rm
```
Or add ~/.local/bin to your $PATH by adding the following line to your ~/.bashrc file [as described here](https://stackoverflow.com/a/59436732):
> 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:
```bash
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:
```bash
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
- Handle some the corner cases
- Option to not clear the folder
#### LICENSE
Do whatever you want.
Inspired by 