Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j6k4m8/goosepaper
generate and deliver a daily newspaper to you or your remarkable tablet
https://github.com/j6k4m8/goosepaper
epub frof newspaper ohp pdf pdf-generation remarkable remarkable-tablet tablet weather
Last synced: 9 days ago
JSON representation
generate and deliver a daily newspaper to you or your remarkable tablet
- Host: GitHub
- URL: https://github.com/j6k4m8/goosepaper
- Owner: j6k4m8
- License: apache-2.0
- Created: 2020-03-10T01:36:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T22:15:51.000Z (about 1 month ago)
- Last Synced: 2024-10-11T09:24:52.329Z (28 days ago)
- Topics: epub, frof, newspaper, ohp, pdf, pdf-generation, remarkable, remarkable-tablet, tablet, weather
- Language: Python
- Homepage:
- Size: 1.22 MB
- Stars: 267
- Watchers: 11
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-reMarkable - Goosepaper - formatted RSS feeds, news articles, Wikipedia articles-of-the-day, and more to your reMarkable tablet. (Other / Launchers)
- awesome-github-repos - j6k4m8/goosepaper - generate and deliver a daily newspaper to you or your remarkable tablet (Python)
README
a daily newsfeed delivered to your remarkable tablet
## what's up
goosepaper is a utility that delivers a daily newspaper to your remarkable tablet. that's cute!
you can include RSS feeds, Mastodon feeds, news articles, wikipedia articles-of-the-day, weather, and more. I read it when I wake up so that I can feel anxious without having to get my phone.
## survey
**[New!]** In response to feedback, I'm collecting anonymous survey responses. Do you want a goosepaper delivered but without requiring any code? Please [let me know your thoughts!](https://forms.gle/t3PUp2TxDQnzzs8x9)
## get started with docker
By far the easiest way to get started with Goosepaper is to use Docker.
### step 0: write your config file
Write a config file to tell Goosepaper what news you want to read. An example is provided in `example-config.json`.
### step 1: generate your paper
From the directory that has the config file in it, run the following:
```shell
docker run -it --rm -v $(pwd):/goosepaper/mount j6k4m8/goosepaper goosepaper -c mount/example-config.json -o mount/Goosepaper.pdf
```
(where `example-config.json` is the name of the config file to use).
### step 2: you are done!
If you want to both generate the PDF as well as upload it to your reMarkable tablet, you can pass the `--upload` flag to the docker command above. You must additionally mount your `~/.rmapy` file:
```shell
docker run -it --rm \
-v $(pwd):/goosepaper/mount \
-v $HOME/.rmapy:/root/.rmapy \
j6k4m8/goosepaper \
goosepaper -c mount/example-config.json -o mount/Goosepaper.pdf --upload
```
Otherwise, you can now email this PDF to your tablet, perhaps using [ReMailable](https://github.com/j6k4m8/remailable).
## get started without docker: installation
### dependencies:
this tool uses `weasyprint` to generate PDFs. You can install all of the python libraries you need with `pip3 install -r ./requirements.txt` from this repo, but you may need these prerequisites before getting started.
more details [here](https://weasyprint.readthedocs.io/en/latest/install.html).
#### mac:
```shell
brew install cairo pango gdk-pixbuf libffi
```
#### ubuntu-flavored:
```shell
sudo apt-get install build-essential python3-dev python3-pip python3-setuptools python3-wheel python3-cffi libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 libffi-dev shared-mime-info
```
#### windows:
[Follow these instructions carefully](https://weasyprint.readthedocs.io/en/latest/install.html#windows).
## and then:
From inside the goosepaper repo,
```shell
pip3 install -e .
```
## get started
You can customize your goosepaper by editing `config.json`. (More instructions, and customization tools, all coming soon!)
```shell
goosepaper --config myconfig.json --output mypaper.pdf
```
If you don't pass an output flag, one will be generated based upon the time of generation.
The output can also be specified by a config file. These are in order of precedence, low to highest:
1. Home directory global configs
2. Local directory from which goosepaper is called
3. Specified on the command line.
An example config file is included here: [example-config.json](example-config.json).
---
Check out [this example PDF](https://github.com/j6k4m8/goosepaper/blob/master/docs/Example-Nov-1-2020.pdf), generated on Nov 1 2020.
## existing story providers ([want to write your own?](https://github.com/j6k4m8/goosepaper/blob/master/CONTRIBUTING.md))
- [Wikipedia Top News / Current Events](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/wikipedia.py)
- [Mastodon Toots](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/mastodon.py)
- [Weather](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/weather.py). These stories appear in the "ear" of the front page, just like a regular ol' newspaper
- [RSS Feeds](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/rss.py)
- [Reddit Subreddits](https://github.com/j6k4m8/goosepaper/blob/master/goosepaper/storyprovider/reddit.py)
# More Questions, Infrequently Asked
### yes but pardon me — i haven't a remarkable tablet
Do you have another kind of tablet? You may generate a print-ready PDF which you can use on another kind of robot as well! Just remove the last line of `main.py`.
### very nice! may i have it in comic sans?
yes! you may do anything that you find to be fun and welcoming :)
Check out the `styles.Styles` enum in the goosepaper library. You will find there what you seek.
### do all dogs' names start with the letter "B"?
I do not think so, but it is a good question!
### may i use this to browse twitter?
~~yes you may! you can add a list of usernames to the feed generator and it will make a print-ready version of twitter. this is helpful for when you are on twitter on your laptop but wish you had Other Twitter as well, in print form.~~
no! twitter has changed and now no one can play nicely with them. sorry! it is sad!
# You May Also Like...
- [remailable](https://github.com/j6k4m8/remailable): Email PDF documents to your reMarkable tablet
- [rmapy fork](https://github.com/j6k4m8/rmapy): My fork of rmapy, with added features and bugfixes