Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jessfraz/morningpaper2remarkable
A bot to sync the morning paper to a remarkable tablet.
https://github.com/jessfraz/morningpaper2remarkable
remarkable remarkable-tablet
Last synced: 10 days ago
JSON representation
A bot to sync the morning paper to a remarkable tablet.
- Host: GitHub
- URL: https://github.com/jessfraz/morningpaper2remarkable
- Owner: jessfraz
- License: mit
- Created: 2018-12-19T18:55:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T23:56:12.000Z (over 1 year ago)
- Last Synced: 2024-08-04T01:23:38.223Z (3 months ago)
- Topics: remarkable, remarkable-tablet
- Language: Go
- Homepage:
- Size: 5.29 MB
- Stars: 218
- Watchers: 11
- Forks: 21
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - morningpaper2reMarkable - A bot to sync the morning paper to a reMarkable tablet. (Other / Launchers)
README
# morningpaper2remarkable
[](https://github.com/jessfraz/morningpaper2remarkable/actions?query=workflow%3A%22make+all%22)
[](https://github.com/jessfraz/morningpaper2remarkable/actions?query=workflow%3A%22make+image%22)
[](https://godoc.org/github.com/jessfraz/morningpaper2remarkable)
[](https://github.com/jessfraz/morningpaper2remarkable/releases)
A bot to sync the [morning paper](https://blog.acolyer.org/) to a remarkable tablet.
This authenticates with your remarkable cloud account via the command line on
start. I hope to eventually make it run on my remarkable and not have to deal
with the cloud.
**Table of Contents**
- [Installation](#installation)
- [Binaries](#binaries)
- [Via Go](#via-go)
- [Running with Docker](#running-with-docker)
- [Usage](#usage)
- [Hidden Command](#hidden-command)
## Installation
#### Binaries
For installation instructions from binaries please visit the [Releases Page](https://github.com/jessfraz/morningpaper2remarkable/releases).
#### Via Go
```console
$ go get github.com/jessfraz/morningpaper2remarkable
```
#### Running with Docker
**Authentication**
```console
$ touch ${HOME}/.rmapi
$ docker run --rm -it \
--name morningpaper2remarkable \
-v "${HOME}/.rmapi:/home/user/.rmapi:rw" \
r.j3ss.co/morningpaper2remarkable --once
# Enter your one time auth code.
```
**Run it in daemon mode with our auth code**
```console
# You need to have already authed and have a .rmapi api file for this to
# work in daemon mode.
$ docker run -d --restart always \
--name morningpaper2remarkable \
-v "${HOME}/.rmapi:/home/user/.rmapi:rw" \
r.j3ss.co/morningpaper2remarkable --interval 20h
```
## Usage
```console
$ morningpaper2remarkable -h
morningpaper2remarkable - A bot to sync the morning paper to a remarkable tablet.
Usage: morningpaper2remarkable
Flags:
-d, --debug enable debug logging (default: false)
--dir directory to store the downloaded papers in (default: morningpaper)
--interval update interval (ex. 5ms, 10s, 1m, 3h) (default: 18h)
--once run once and exit, do not run as a daemon (default: false)
--pages number of pages of papers to download (default: 1)
Commands:
version Show the version information.
```
### Hidden Command
I use the bot on my server but sometimes I just want a way to get a paper from
a URL to my remarkable from the command line.
I added a hidden command for that `download`.
You can use it like the following:
```bash
$ morningpaper2remarkable download http://nickm.com/trope_tank/10_PRINT_121114.pdf "10 PRINT"
```
This will download the PDF from the URL at `arg[0]` put it in a folder, default
named `papers` and name the PDF in that folder `arg[1]`, which above is `"10
PRINT"`.
You can change the folder name with the `--dataDir` flag.