Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tmsmr/rmrl-aas
reMarkable Rendering Library - as a Service
https://github.com/tmsmr/rmrl-aas
pdf python remarkable-tablet
Last synced: 24 days ago
JSON representation
reMarkable Rendering Library - as a Service
- Host: GitHub
- URL: https://github.com/tmsmr/rmrl-aas
- Owner: tmsmr
- License: gpl-3.0
- Created: 2022-08-23T16:07:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-27T18:03:15.000Z (over 2 years ago)
- Last Synced: 2024-12-17T03:02:39.224Z (about 2 months ago)
- Topics: pdf, python, remarkable-tablet
- Language: Python
- Homepage:
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rmrl-aas
*reMarkable Rendering Library - as a Service*
[](https://github.com/tmsmr/rmrl-aas/actions)
## What is this?
This is basically a wrapper for [@rschroll](https://www.github.com/rschroll)'s `rmrl` Python package (https://github.com/rschroll/rmrl) to make the `render` call available via HTTP. So, whole credits go to him - I just put things together 😀.
## WARNING
There are NO security checks / validations whatsoever. This service is NOT intended to be hosted publicly!
## Run
### Python / `pip`
- Install dependencies: `pip install -r requirements`
- Run: `waitress-serve --host=127.0.0.1 rmrl_aas:app`
### Docker
- Build image: `docker build -t rmrl-aas .`
- Run: `docker run -d -p 127.0.0.1:8080:8080 rmrl-aas`
- Or use the prebuilt image ([GitHub Workflow](.github/workflows/docker-publish.yml)): `docker run -d -p 127.0.0.1:8080:8080 ghcr.io/tmsmr/rmrl-aas:v0.2.1`
## Use
`curl -X POST -F [email protected] localhost:8080/render -o xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx.pdf`
**Yes, the file is submitted as form input!**
*Or, use your favorite programming language to build a client...*
*Or, use the minimal Web-GUI at `localhost:8080/` for tryout purposes...*