Package: r2k
R2K (RSS to Kindle)r2kis a tool that lets you to track your favorite RSS/Atom feeds, and send cleaned-up (i.e. only text
and images) articles received from them directly to your Kindle.InstallationCleaning up the articlesUsageInstallationThe best way to get up and running withr2kus to use pipx. Simply run:pipxinstallr2kIf you're not usingpipx(you should!),pip install r2kwill also do.If you want to addr2kto your Poetry project, runpoetry add r2k.Cleaning up the articlesThere are currently 3 ways to clean up articles:The default is using thereadabilityPython implementation. It doesn't require any extra steps or
installations, and thus is the easiest to use. It is, however, a bit less precise than the other 2 methods.Using thePushToKindleservice. The service works by attaching an email
address that forwards cleaned up versions of URLs to your Kindle. It's free for a certain amount of articles,
but you need to become their supporter afterward.Using a dockerized version of theMercury-Parser.
This method requires Docker, but is marginally better than thereadabilityapproach.UsagePreparationsIf you're using PushToKindle (PTK)The free version of PTK only allows for 25 articles to be sent using their service. After this,
you'll have to become their "sustainer" (for as low as 1$/month) on Patreonhere.Before usingr2kwith PTK you need to:Know your kindle email address (find ithere, under
"Preferences" -> "Personal Document Settings").Addkindle@fivefilters.orgto the list of approved email senders (in the same place in
Amazon's settings).Set up your configuration fileMost of whatr2kdoes involves the configuration file, in which the feeds you're subscribed to
are kept, as well as some other data.After installation, run:r2kconfiginit[-pCONFIG_PATH]The default location for the config YAML file is in~/.r2k/config.yml.During the init you'll be asked several questions (like your kindle email address).To see your configuration run:r2kconfigshow[-pCONFIG_PATH]Adding your GMail credentialsCurrentlyr2krelies on the fact that you have a GMail address, and it requires aGoogle App Password.
These are useful in cases where you don't want to go through 2FA authentication. Gohereto generate anr2kApp Password, and
add it to the configuration.Add some RSS subscriptionsUsing an OPML fileTheOPMLformat is widely used in the RSS/Atom world
(as well as in podcasting and other areas) to represent a collection of feeds. You can export your
existing subscriptions from most feed readers into an OPML file.To load all of your subscriptions in one move run:r2kfeedimportPATH_TO_OPML_FILEManually adding feedsIf you don't have an OPML export, or just want to add a single feed you can run:r2kfeedadd-tFEED_TITLE-uFEED_URLIf theFEED_URLis a proper RSS feed (i.e. an actual XML feed URL), it will be added as is.
If theFEED_URLis a regular URL,r2kwill attempt to find the RSS feed by analyzing the page
source. In the case of multiple candidates (e.g. WordPress content feed and comment feed), you will
be presented with a list of choices.Send updates to your KindleRight now the "periodical" part ofr2kis not yet operational. In order to send updates to your
Kindle you'll have to run:r2kkindlesend[-fFEED_TITLE]If you don't pass the-f/--feed-titleoption, updates will be sent for all of your subscriptions.The first time thatkindle sendis run for any feed, you will be presented with a list of all the
available articles in the feed (note that RSS feeds usually only keep a subset of the most recent
entries), and will be asked to choose the last one you've already read. This is to avoiding sending
you any article you've already consumed.