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.


Saving feed items to a Maildir folder:

feed2exec add "NASA breaking news" --folder nasa
feed2exec fetch

This creates the equivalent of this configuration file in ~/.config/feed2exec/feed2exec.ini:

output = feed2exec.plugins.maildir
mailbox = '~/Maildir'

[NASA breaking news]
folder = nasa
url =

Send new feed items to Transmission:

feed2exec add "Example torrent list" --output feed2exec.plugins.exec --args 'transmission-remote -a '{}' -w /srv/incoming'

Send new feed items to Mastodon, using the toot commandline client:

feed2exec add "My torrent" --output feed2exec.plugins.exec --args 'toot post "{item.title} {}"'

Send new feed items to Twitter, using the tweet commandline client from python-twitter:

feed2exec add "My torrent" --output feed2exec.plugins.exec --args 'tweet "{item.title:40s} {}"'

Show feed contents:

feed2exec add "NASA breaking news" --output feed2exec.plugins.echo --args "{item.title} {}"
feed2exec fetch

Multiple feeds can also be added with the OPML import command. See the usage document for more information.


This can be installed using the normal Python procedures:

pip install feed2exec

It can also be installed from source, using:

pip install .

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

python -m feed2exec


Make sure you use Python 3. feed2exec is written to also support Python 2.7, but there may be performance or security issues in that older version. For example, Python 2.7 seems to suffer from a header injection flaw that currently makes tests fail.

Source, documentation and issues are available on GitLab.

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.

Built Distribution

feed2exec-0.4-py3-none-any.whl (41.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page