rmdocs

A cli tool to convert .rm, .rmdoc and the xochitl folder of the reMarkable 2 to PDFs. It aims to reproduce reMarkable 2 output as faithfully as possible.

[!IMPORTANT] It is only compatible with .rm version 6. See below

[!CAUTION] I still consider this in early development.

Usage

  • Convert a single .rm file using rmdocs my_page.rm [destination folder]. [destination folder] defaults to current folder.
  • Convert a single .rmdoc file using rmdocs my_document.rmdoc [destination folder]. [destination folder] defaults to current folder.
  • Convert a folder containing a collection of .rm or .rmdoc (can't be mixed) using rmdocs [source folder] [destination folder]. [destination folder] is required.
  • Convert the xochitl folder at /home/root/.local/share/remarkable/xochitl/ on the remarkable using rmdocs [source folder] [destination folder]. [destination folder] is required.

If you have compatibility or assertions issues, please refer to below.

Installation

  1. Install pipx
  2. Install libcairo2. For instance, on debian based system use apt install libcairo2.
  3. Install rmdocs via pipx install rmdocs

[!NOTE]
Alternatively, you can use regular venv.

Compatibility

This software is only compatible with page version 6, and I do not plan on making it support other page version. For non-compatible pages a warning text will be shown instead of your strokes. Going to each of these pages individually and drawing (even if removing afterward) makes the reMarkable updates the page to v6.

Additionally, as there is no official API for reMarkable file structure, many assertion are made based on the files available while developing this software. The output of the software will show them as AssertionException. Please consider opening an issue when you have such errors.

Acknowledgment, contributions and license

This uses rmscene, and part of svg creation is based of rmc.

This software is mainly released under the MIT license. Certains files (from rmc) regarding the svg creation are under LGPL.

Contributions are welcomed :).

Project links

Data verified by PyPI on Jun 15, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.5.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Seb-sti1 from gravatar.com Seb-sti1

Credits

Author: Seb-sti1

GitHub Statistics

Data verified by PyPI on Jun 15, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT License)

Requires

Python >=3.10

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rmdocs-3.5.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rmdocs-3.5.0-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file rmdocs-3.5.0.tar.gz.

File metadata

  • Download URL: rmdocs-3.5.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rmdocs-3.5.0.tar.gz
Algorithm Hash digest
SHA256 c795a6000fe4b448f5466880fc45dd1b2a26398ba208f9d97f1b71022c7dc149
MD5 0ac2adfca2e47132c347bf92bc97fe63
BLAKE2b-256 b7983e4bf1d5e20bd8139287ce6d4202ba2b5431539fff11594b7fb456befa7d

See more details on using hashes here.

Provenance

The following attestation bundles were made for rmdocs-3.5.0.tar.gz:

Publisher: release.yml on Seb-sti1/rmdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rmdocs-3.5.0-py3-none-any.whl.

File metadata

  • Download URL: rmdocs-3.5.0-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for rmdocs-3.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eecd6d56c4abdd4cf5eb0e00693eb5a5a4a008985976f3fd88f1f4f8a2ab691b
MD5 6c323dbbac7d6076b185ca9cd828cbce
BLAKE2b-256 b7e2c5bfb6bce158ed71d9c14b40ad3d6198e0eeed5c9423859814e84729e6b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for rmdocs-3.5.0-py3-none-any.whl:

Publisher: release.yml on Seb-sti1/rmdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page