1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
# arxiv2remarkable.py
``arxiv2remarkable`` is a command line program to quickly transfer a paper to
your reMarkable.
This script makes it as easy as possible to get a PDF on your reMarkable from
any of the following sources:
- an arXiv url (either ``arxiv.org/abs/...`` or ``arxiv.org/pdf/...``)
- a PubMed Central url (either to the HTML or the PDF)
- an ACM citation page url (``https://dl.acm.org/citation.cfm?id=...``)
- an OpenReview paper (either ``openreview.net/forum?id=...`` or
``openreview.net/pdf?id=...``)
- a Springer paper url (either to the HTML or the PDF)
- a url to a PDF file
- a local file.
The script takes the source and:
1. Downloads the pdf if necessary
2. Removes the arXiv timestamp
3. Crops the pdf to remove unnecessary borders
4. Shrinks the pdf file to reduce the filesize
5. Generates a nice filename based on author/title/year of the paper
6. Uploads it to your reMarkable using ``rMapi``.
Optionally, you can:
- Download a paper but not upload to the reMarkable using the ``-n`` switch.
- Insert a blank page after each page using the ``-b`` switch (useful for note
taking!)
- Center the pdf on the reMarkable (default is left-aligned)
- Provide an explicit filename using the ``--filename`` parameter
- Specify the location on the reMarkable to place the file (default ``/``)
Here's the full help of the script:
```text
usage: arxiv2remarkable.py [-h] [-b] [-v] [-n] [-d] [-c] [--filename FILENAME]
[-p REMARKABLE_DIR] [--rmapi RMAPI]
[--pdfcrop PDFCROP] [--pdftk PDFTK] [--gs GS]
input
positional arguments:
input URL to a paper or the path of a local PDF file
optional arguments:
-h, --help show this help message and exit
-b, --blank Add a blank page after every page of the PDF (default:
False)
-v, --verbose be verbose (default: False)
-n, --no-upload don't upload to the reMarkable, save the output in
current working dir (default: False)
-d, --debug debug mode, doesn't upload to reMarkable (default:
False)
-c, --center Center the PDF on the page, instead of left align
(default: False)
--filename FILENAME Filename to use for the file on reMarkable (default:
None)
-p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR
directory on reMarkable to put the file (created if
missing) (default: /)
--rmapi RMAPI path to rmapi executable (default: rmapi)
--pdfcrop PDFCROP path to pdfcrop executable (default: pdfcrop)
--pdftk PDFTK path to pdftk executable (default: pdftk)
--gs GS path to gs executable (default: gs)
```
And here's an example with verbose mode enabled that shows everything the
script does by default:
```bash
$ python arxiv2remarkable.py -v https://arxiv.org/abs/1811.11242
2019-05-30 00:38:27 - INFO - Starting ArxivProvider
2019-05-30 00:38:27 - INFO - Getting paper info from arXiv
2019-05-30 00:38:27 - INFO - Downloading url: https://arxiv.org/abs/1811.11242
2019-05-30 00:38:27 - INFO - Generating output filename
2019-05-30 00:38:27 - INFO - Created filename: Burg_Nazabal_Sutton_-_Wrangling_Messy_CSV_Files_by_Detecting_Row_and_Type_Patterns_2018.pdf
2019-05-30 00:38:27 - INFO - Downloading file at url: https://arxiv.org/pdf/1811.11242.pdf
2019-05-30 00:38:32 - INFO - Downloading url: https://arxiv.org/pdf/1811.11242.pdf
2019-05-30 00:38:32 - INFO - Removing arXiv timestamp
2019-05-30 00:38:34 - INFO - Cropping pdf file
2019-05-30 00:38:37 - INFO - Shrinking pdf file
2019-05-30 00:38:38 - INFO - Starting upload to reMarkable
2019-05-30 00:38:42 - INFO - Upload successful.
```
## Dependencies
The script requires the following external programs to be available:
- [pdftk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/)
- [pdfcrop](https://ctan.org/pkg/pdfcrop?lang=en): usually included with a
LaTeX installation.
- [GhostScript](https://www.ghostscript.com/)
- [rMAPI](https://github.com/juruen/rmapi)
If these scripts are not available on the ``PATH`` variable, you can supply them
with the relevant options to the script.
The script also needs the following Python packages:
- [BeautifulSoup4](https://pypi.org/project/beautifulsoup4/): parsing HTML
- [requests](https://pypi.org/project/requests/): getting HTML
- [PyPDF2](https://github.com/mstamy2/PyPDF2): verifying urls point to PDF
- [titlecase](https://pypi.org/project/titlecase/): fancy titles
- [pdfplumber](https://github.com/jsvine/pdfplumber): used for better page
cropping
- [unidecode](https://pypi.org/project/Unidecode/): clean accented characters
from the filename
If you use [Poetry](https://poetry.eustace.io/) you can install these
dependencies using ``poetry install`` in the project directory. Alternatively,
you can use ``pip`` with the following command:
```bash
pip install --user bs4 requests PyPDF2 titlecase pdfplumber unidecode
```
## Docker
You can also use our Dockerfile to avoid installing dependencies on your machine. You will need `git` and `docker` installed.
First clone this repository with `git clone` and `cd` inside of it, then build the container:
```bash
docker build -t arxiv2remarkable .
```
### Authorization
If you already have a `~/.rmapi` file, you can skip this section. Otherwise we'll use `rmapi` to create it.
```bash
touch ${HOME}/.rmapi
docker run --rm --it -v "${HOME}/.rmapi:/root/.rmapi:rw" --entrypoint=rmapi arxiv2remarkable version
```
which should end with output like
```bash
ReMarkable Cloud API Shell
rmapi version: 0.0.5
```
### Usage
Use the container by replacing `python arxiv2remarkable.py` with `docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable`, e.g.
```
# print help and exit
docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable --help
# equivalent to above usage via `python`
docker run --rm -v "${HOME}/.rmapi:/root/.rmapi:rw" arxiv2remarkable -v https://arxiv.org/abs/1811.11242
```
# Notes
License: MIT
Author: G.J.J. van den Burg
|
