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.
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
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file feed2exec-0.20.0-py3-none-any.whl.
File metadata
- Download URL: feed2exec-0.20.0-py3-none-any.whl
- Upload date:
- Size: 682.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de414355c518a79aedab06430a04de1e613d393828aa6ce05ce95e180647990e |
|
| MD5 | 6093e117f78dd62087c654eba57e5355 |
|
| BLAKE2b-256 | 8e3a44c113083a9b7f01dfad6204b942c5b70807a4c2f12436e737649c34a17f |
