Regittable

Regittable (or reGittable) is a watchdog script, designed for the reMarkable 2 tablet to automatically commit sync'd files to desired git repositories.

Regittable is fundamentally designed for use with the Dropbox integration using a json config file and run from an always-on device (or one that runs the script upon startup, see below), but can be used in a variety of other circumstances and setups as well.

It is designed for use on a Windows or OSX machine.

Usage

Place your config .json file anywhere on the machine, and reference it when running regittable:

$ python3 /path/to/regittable/regittable.py --help
$ python3 /path/to/regittable/regittable.py /path/to/regittable-config.json

If your computer may restart, consider setting the script to run on startup (eg: Windows).

Use cases

In the simplest case, Regittable can be configured to automatically move a remarkable file after sync to a specified destination folder from your Dropbox root where it will be synced, on the device running Regittable.

Note: the destination can be a Dropbox subfolder, as a workaround to the reMarkable Dropbox integration limitation where it can only sync to the Dropbox root folder.

The core intended use case is to commit a pdf (or an update to it) to a git repo at a different path for version control and use in different projects.

Setup

If you will be running the .py file, you need to install python dependencies:

pip install munch
pip install watchdog

I would use sh (a superior sub-process module for running command line calls) to circumvent the git dependency but it is not supported on windows.

Configuration

You need to point regittable.py to a JSON config file. By default, regittable looks for regittable-config.json adjacent to the regittable.py file, but it can be any JSON file, placed anywhere with a path passed in at invocation.

Set the db_root_rel_path var to the absolute (or relative to the regittable.py location) path to your local Dropbox folder root contents.

Create a configuration object for each reMarkable notebook or file you sync to Dropbox.

{
  "watch_path": "C:\\Users\\keerthik\\Dropbox\\",
  "files": [
    {
      "name": "quick notes",
      "destination": "./reMarkableNotes/*",
      "git_mode": "none",
      "auto_delete": "false"
    }
  ]
}

Append /* to your destination path if you want to preserve the filename as set by your reMarkable sync. You can hard-code this filename too.

Note: All absolute and relative paths should be safe to mix between Windows and *nix styles, however special paths like / and ~/ probably won't resolve correctly cross-platform.

Set git_mode to any of

• none: no git operations. Can be used to move files
• pull-request: submits a pull-request to the repo, from a branch named as in commit-branch.
• commit-branch: commits in a branch. Default branch name is of format $filename$hhmm$ddmmyyyy. Multiple updates within this minute will be committed to the same branch
• commit-current: makes a commit in the current repo branch
• push-current: makes a commit and attempts a push to the current repo branch

Only checked features are implemented.

A sample regittable-config.json file is included in the repository demonstrating existing features.