remarkable-layers - GitLite

KO | EN

gitlite — search

#javascript #ai #llm #android #rust #deep-learning #linux #java #awesome #awesome-list #pytorch #security #mcp #open-source

remarkable-layers

(★ 120)

Python module for reading and writing Remarkable Lines files

File Explorer

Download Latest Version (.zip)

- HersheySans1.svg
- - __init__.py
  - base.py
  - layer.py
  - lines.py
  - segment.py
  - stroke.py
- __init__.py
- constants.py
- empty.jpg
- rmcloud.py
- svg.py
- 03f23a6e-c14b-4dba-836d-828707979356.rm
- 736a2a4e-dd0e-4a6e-9326-797508bcb84d.rm
- 8d75db7b-7716-4899-9ec5-1f89bcb88e10.rm
- c9c8f92c-772e-49f6-b320-71ce0bbe1862.rm
- ca59e6e3-a850-45e3-94dc-64bb1b1ed254.rm
- pdf_converter.py
- pen_gallery.py
- samples.py
- __init__.py
- test_sample.py
.flake8
.gitignore
LICENSE
pdf_to_rm_format.gif
poetry.lock
pyproject.toml
README.md
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/bsdz/remarkable-layers

Downloads the entire project code from GitHub to your computer.

cd remarkable-layers

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Python 3 Python is required to use pip.

pip install git+https://github.com/bsdz/remarkable-layers.git#master

Installs the package published on PyPI directly — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install git+https://github.com/bsdz/remarkable-layers.git#master

Installs the package published on PyPI directly — no need to clone the source.

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Note: I am no longer using this project and I have archived it. Feel free to fork.

# remarkable-layers

Python module for reading and writing Remarkable Lines files (*.rm).

Currently only supports version 5 of Remarkable Lines files.

This module and supporting routines are experimental.

## Installation

The module is still in development.

You can install it with the following pip command.

```bash
pip install git+https://github.com/bsdz/remarkable-layers.git#master
```

Alternatively, you can install it by cloning this repository and using the [poetry install](https://python-poetry.org/docs/cli/#install) command.

## Core Dependencies

The core module for reading & writing rm line files only uses core python standard library.

The SVG conversion module utilises numpy and lxml.

The example scripts introduce other dependencies.

## Usage

Read a RM Lines binary file.

```python
from pathlib import Path
from rmlines import RMLines

p = Path("./samples/03f23a6e-c14b-4dba-836d-828707979356.rm")
rm0 = RMLines.from_bytes(p.open("rb"))
```

Dump internal structure of RM Lines to logger.

```python
import logging
logging.basicConfig(level="DEBUG")
# To reduce logging for some binary types, eg:
# logging.getLogger('rmlines.rmobject.segment').setLevel(logging.INFO)

rm0.dump()
```

Convert to SVG (as strokes).

```python
from io import StringIO
from IPython.display import SVG

sbuffer = StringIO()
rm0.to_svg(sbuffer)
SVG(sbuffer.getvalue().encode())
```

Convert simple SVG file into RM Lines format. Can only contain paths with simple line segments. For conversion of PDF to simple SVG see pdf_converter.py below.

```python
p = Path("./my_simple.svg")
rm0 = RMLines.from_svg(f.open("rb")
```

## Example Scripts

### rmlines_pdf_converter

This script converts a pdf to several intermediate SVG files, one per page, then generates RM Lines notebook that is uploaded to Remarkable Cloud. The SVG output files are simplified SVG that the RM Lines module can process. That is all beziers have been linearized and raster images traced into paths. This can be time consuming.

Typical usage:

```bash
rmlines_pdf_converter my_file.pdf --first 10 --last 25
```

Use "--help" flag for more options.

#### Additional Dependencies

Applications: inkscape and pdfinfo. 
Python modules: potrace, svgpathtools, svgwrite, pillow and rmapy. Note that in pyproject.toml some dependencies reference git branches / revisions and/or forks.

### pen_gallery

This script uses hershey stroke fonts to place text in Remarkable lines files with different pen styles. More fonts are available at [SVG Fonts repo](ttps://gitlab.com/oskay/svg-fonts).

## Obtaining a cloud token for upload

Currently, one should initialize their connection to Remarkable Cloud using rmapy directly. You can obtain a one time token from [Remarkable's Mobile Connect](https://my.remarkable.com/connect/mobile) page.

Then follow example as [described here](https://rmapy.readthedocs.io/en/latest/quickstart.html#registering-the-api-client). Eg,

```python
from rmapy.api import Client
rmapy = Client()
rmapy.register_device("<YOUR ONE TIME TOKEN>")
```
You should only need to do this once.

## Known issues

Conversion from RM to SVG is very basic and doesn't support the Remarkable pen tips that are stored as PNG images.

Conversion from PDF to RM shows all text and objects as outlines. This is a bit annoying but a limitation of Remarkable's Lines format that doesn't support fills. I think the reason for Remarkable's decision to not support SVG directly is because they actually map PNG images over the stroke paths and this might be difficult/impossible to do with SVG.

The round trip mapping, eg read RM to binary and convert back to again, does not support all pen configurations.

This has only be tested on Linux and not Windows.

This is a very experimental package created so I can properly take notes and test mathematical texts. I'm still not sure if it will solve my use case.

## Demo

![demo](https://raw.githubusercontent.com/bsdz/remarkable-layers/master/pdf_to_rm_format.gif "Demo")