Skip to main content

The programmable feed reader

Project description

feed2exec is a simple program that runs custom actions on new RSS feed items (or whatever feedparser can read). It currently has support for writing into mailboxes (Maildir folders) or executing commands, but more actions can be easily implemented through plugins. Email are saved as multipart plain/HTML and can be sent to arbitrary folders.

Example

The user interface is still a bit rough, but this should get you started:

feed2exec add "NASA breaking news" https://www.nasa.gov/rss/dyn/breaking_news.rss --folder nasa
feed2exec fetch

An equivalent configuration file which may be more descriptive in ~/.config/feed2exec/feed2exec.ini:

[DEFAULT]
output = feed2exec.plugins.maildir
mailbox = '~/Maildir'

[NASA breaking news]
folder = nasa
url = https://www.nasa.gov/rss/dyn/breaking_news.rss

Another example, to send files into the Transmission program:

feed2exec add "Example torrent list" http://example.com/torrents/feed --output feed2exec.plugins.exec --args 'transmission-remote marcos.anarc.at -a %(link)s -w /srv/incoming'

Using a standard OPML file, you can also import multiple feeds using the feed2exec import command. See the complete usage page for more information.

Installation

This can be installed using the normal Python procedures:

pip install .

It can also be ran straight from the source, using:

python -m feed2exec

Why the name?

There are already feed2tweet and feed2imap out there so I figured I would just reuse the prefix and extend both programs at once.

Design and known issues

See the design document for more information about how and why the program was built and its limitations. The design document also features a comparison with other similar software.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

feed2exec-0.3-py3-none-any.whl (37.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page