Marks-as-read feed entries that match a specified filter.
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
LICENSE.txt
README.md
README.rst
setup.py

README.md

RSS Filter

Marks-as-read feed entries that match a specified filter.

Services supported

Is the service you use not supported? Open an issue.

Installation

pip install git+git://github.com/U2Ft/RSS-filter.git

Usage

RSS Filter

Usage:
  RSS-filter
  RSS-filter -e | --edit
  RSS-filter -h | --help
  RSS-filter -l | --list
  RSS-filter -s | --starred

Options:
  -h --help       Show this message.
  -e --edit       Edit the filters with your default editor.
  -l --list       List feed titles.
  -s --starred    Apply filters to starred entries only.

Specify some filters, then run manually or write a cron job—something like

0 6,4 * * * RSS-filter > /dev/null

Run summaries are logged to a file in the config directory.

Filters

The filters file is JSON. Comments are allowed. The format is

{
    // Every feed
    "*": ["regex"],

    // Specific feeds
    "feed title": ["regex"]
}

where regex is a Python Regular Expression. Items in the named feed with titles that match the regex are marked as read.

Filters for the feed title * are applied to every feed.

Note the irregular behaviour of backslash-escapes—in practice, repeat them. E.g. to match a [ in the item title, the regex should be "\\[".

Watch out for HTML entities (e.g. &) in item and feed titles. If a regex that should be matching isn't, that's probably why.