Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tlatsas/darui

Parses rss feeds and emails entries matched against supplied keywords
https://github.com/tlatsas/darui

Last synced: 23 days ago
JSON representation

Parses rss feeds and emails entries matched against supplied keywords

Awesome Lists containing this project

README

        

Darui
-----

### Description

Darui is a simple program written in python. It parses rss feeds and matches
feed entries against supplied keywords. Matched entries are sent to your email using
python's smtplib.
It undertakes to do the tedious work of filtering your rss entries, that's why it is
named after an [anime character](http://naruto.wikia.com/wiki/Darui) who is constantly
referring to things or events as being "dull".

### Dependencies

* python >= 3
* feedparser >= 5.1

### Command line parameters

#### Synopsis

darui.py [-h] [-v] [-p] [-f CFG_FILE] [--no-email]

#### Options

`-h`, `--help`

Show help message.

`-v`, `--version`

Show version.

`-p`, `--print`

Print results to stdout. Silent by default.

`-f `, `--file `

Override standard search path and use specified configuration file.

`--no-mail`

Skip sending email report. Useful for debug in conjunction with `--print`.

### Configuration

Darui uses the [JSON](http://json.org/example.html) file format for its configuration
file. It expects a file named `darui.json` in one of the following paths:

* path stored in `$XDG_CONFIG_HOME` (defaults to ~/.config)
* path from where program runs

Sample configuration file:

{
"email": {
"from": "",
"to": ""
},
"feeds": [
{ "rss" : "http://www.archlinux.org/feeds/packages/", "rules": [
"gstreamer",
"udev",
"sqlite"
]
},
{ "rss" : "http://rss.feedsportal.com/c/32569/f/491735/index.rss", "rules": [
"kernel log",
"new in linux"
]
}
]
}

The first entry, matches all archlinux packages with `gstreamer`, `udev` or `sqlite` in their name.
The second entry matches all articles at [H-Online](http://www.h-online.com/open/)
relevant to new linux kernel releases. Note that searches are **not** case-sensitive.

The "from" and "to" field are used for email sending and are self explanatory.

### License

This program is free software; you can redistribute it and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation version 3 of the License.

A copy of theGNU General Public License can be found in [GNU Licence Page](http://www.gnu.org/licenses/gpl.html)

### Authors

2011-2012 Tasos Latsas