https://github.com/U2Ft/RSS-filter

Marks-as-read feed entries that match a specified filter.
https://github.com/U2Ft/RSS-filter

Last synced: 2 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/U2Ft/RSS-filter
• Owner: U2Ft
• License: mit
• Created: 2012-12-27T03:15:18.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-09-28T18:22:33.000Z (about 11 years ago)
• Last Synced: 2024-08-01T16:43:10.819Z (3 months ago)
• Language: Python
• Homepage:
• Size: 189 KB
• Stars: 20
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• my-awesome-github-stars - U2Ft/RSS-filter - Marks-as-read feed entries that match a specified filter. (Python)

README

        
# RSS Filter

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

## Services supported

 - [Feedbin](https://feedbin.me/)

Is the service you use not supported? Open an [issue](https://github.com/U2Ft/RSS-filter/issues/new).

## 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 

```js

{

    // Every feed

    "*": ["regex"],

    // Specific feeds

    "feed title": ["regex"]

}

```

where `regex` is a [Python Regular Expression](http://docs.python.org/2/library/re.html#regular-expression-syntax).

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.