Metadata-Version: 2.4
Name: rmdocs
Version: 3.5.1
Summary: Convert the file tree from the reMarkable tablet to PDFs
Author-email: Seb-sti1 <noreply@kerbourch.fr>
License: MIT License
        
        Copyright (c) 2024 Sébastien Kerbourc'h
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/Seb-sti1/rmdocs
Project-URL: Issues, https://github.com/Seb-sti1/rmdocs/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pypdf
Requires-Dist: cairosvg
Requires-Dist: rmscene<0.9.0,>=0.8.0
Requires-Dist: rich
Dynamic: license-file

rmdocs
===

A cli tool to convert .rm, .rmdoc and the `xochitl` folder of the [reMarkable 2](https://remarkable.com/) to PDFs.
It aims to reproduce reMarkable 2 output as faithfully as possible.

> [!IMPORTANT]
> It is **only** compatible with `.rm` version 6.
> See [below](#Compatibility)

> [!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](#Compatibility).

## Installation

1. Install [pipx](https://pipx.pypa.io/stable/how-to/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](https://github.com/ricklupton/rmscene), and part of svg creation is based
of [rmc](https://github.com/ricklupton/rmc).

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

Contributions are welcomed :).
