Metadata-Version: 2.1
Name: remarkable-cli
Version: 0.3.2
Summary: An unofficial CLI for interacting with the Remarkable tablet.
Home-page: https://github.com/awwong1/remarkable-cli
Author: Alexander Wong
Author-email: alex@udia.ca
License: Apache-2.0
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
Requires-Dist: paramiko
Requires-Dist: requests
Requires-Dist: svglib
Requires-Dist: reportlab

# remarkable-cli

![PyPI](https://img.shields.io/pypi/v/remarkable-cli)

An unofficial command line interface (CLI) for interacting with the Remarkable paper tablet written in pure Python.

## Features

* pull raw reMarkable `xochitl` files directly to the local machine
* convert raw `.rm` payloads into readable `.pdf`
* pull reMarkable web-interface `pdf` documents directly to the local machine

### In the works

* push/pull `pdf` files to reMarkable for annotation & reading
* push/pull `epub` files to reMarkable for annotation & reading
* live-share reMarkable screen to local machine
* ... and more!

## Getting Started

```bash
pip install remarkable-cli

# Pull raw xochitl files and render them into readable pdf
remarkable-cli -a pull

# with DEBUG logging, clean the local backup directory before pulling all the raw xochitl files and rendering pdf
remarkable-cli -vvvv -a clean-local -a pull

# show the CLI usage/help
remarkable-cli -h
```

## License

[Apache-2.0](./LICENSE)

```text
Copyright 2021, Alexander Wong

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```


