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.

AGPLv3 licensed pipeline status coverage report feed2exec version on PyPI feed2exec version in stable feed2exec version in unstable Say thanks to the author

Examples

Simple run with no side effects:

feed2exec parse https://www.nasa.gov/rss/dyn/breaking_news.rss --output echo --args '{item.title'}

Saving feed items to a Maildir folder:

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

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

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

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

Send new feed items to Transmission:

feed2exec add "Example torrent list" http://example.com/torrents/feed --output transmission --folder /srv/incoming

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

feed2exec add "My site" http://example.com/blog/feed --output exec --args 'toot post "{item.title} {item.link}"'

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

feed2exec add "My site on twitter" http://example.com/blog/feed --output exec --args 'tweet "{item.title:40s} {item.link:100s}"'

Show feed contents:

feed2exec add "NASA breaking news" https://www.nasa.gov/rss/dyn/breaking_news.rss --output echo --args "{item.title} {item.link}"
feed2exec fetch

Multiple feeds can also be added with the OPML import command. See the usage document for more information including known issues and limitations.

Installation

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

Important

feed2exec is explicitly written for Python 3. It may be possible to backport it to Python 2 if there is sufficient demand, but there are too many convenient Python3 constructs to make this useful. Furthermore, all dependencies are well-packaged for Py3 and the platform is widely available. Upgrade already.

The program may also be available as an official package from your Linux distribution.

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 information

See the design document for more information about how and why the program was built. 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.

Filename, size & hash SHA256 hash help File type Python version Upload date
feed2exec-0.12.0-py3-none-any.whl (102.4 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page