Code Monkey home page Code Monkey logo

zotrm's Introduction

zotrm.py

A Python script to sync Zotero papers to the ReMarkable tablet.

Inspired by https://github.com/GjjvdBurg/arxiv2remarkable/ and https://github.com/michaelmior/zotero-remarkable. The main difference with the latter is the use of collections as subdirectories and using the locally-stored PDFs instead of requiring the files be synced via Zotero Sync or a WebDAV server.

NEW:

Initial integration with the remarks package for highlight extraction, available on the remarks branch.

Usage

Simply download the repository and run python zotrm.py.

Requirements

  • rmapi. This can be downloaded as a compiled executable from the link, or compiled from source using go (recommended).
  • pyzotero. This can be installed using pip or conda.

Configuration

Place a config.ini file into $USER/.zotrm/.

  • Zotero settings
    • LIBRARY_ID: Can be found here, as the user ID for API calls.
    • API_KEY: Can be obtained here.
    • STORAGE_DIR: Directory that Zotero uses for storing PDFs.
    • ATTACHMENT_DIR: Directory used for linked attachment files.
    • SEND_TAG: Tag to monitor for PDFs to send. Removed from item if successfully sent or if file already existed.
    • REPLACE_TAG: Optional, a tag to add to sent PDFs.
  • RMAPI settings
    • RMAPI_PATH: Path to rmapi executable.
  • Remarkable settings
    • BASE_DIR: If a file is in a collection (or subcollection), it will be placed in a folder(s) of the same name in this directory.
    • DEFAULT_DIR: If a file has no collection, it will be placed in this directory.

zotrm's People

Contributors

samuelyeewl avatar imciner2 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.