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!

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:

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:

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.

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.

mac:

brew install cairo pango gdk-pixbuf libffi

ubuntu-flavored:

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.

and then:

From inside the goosepaper repo,

pip3 install -e .

get started

You can customize your goosepaper by editing config.json. (More instructions, and customization tools, all coming soon!)

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:

Home directory global configs
Local directory from which goosepaper is called
Specified on the command line.

An example config file is included here: example-config.json.

Check out this example PDF, generated on Nov 1 2020.

existing story providers (want to write your own?)

Wikipedia Top News / Current Events
Mastodon Toots
Weather. These stories appear in the "ear" of the front page, just like a regular ol' newspaper
RSS Feeds
Reddit Subreddits

j6k4m8 / goosepaper

readme