rawdog: RSS Aggregator Without Delusions Of Grandeur
Adam Sampson <ats@offog.org>
-rawdog is an extensible feed aggregator for Unix-like systems, based on
-the Python feedparser module (originally developed by Mark Pilgrim).
+rawdog is a feed aggregator, capable of producing a personal "river of
+news" or a public "planet" page. It supports all common feed formats,
+including all versions of RSS and Atom. By default, it is run from cron,
+collects articles from a number of feeds, and generates a static HTML
+page listing the newest articles in date order. It supports per-feed
+customizable update times, and uses ETags, Last-Modified, gzip
+compression, and RFC3229+feed to minimize network bandwidth usage. Its
+behaviour is highly customisable using plugins written in Python.
-(Important: If you're upgrading from rawdog 1.x to rawdog 2.x, please
-read the NEWS file to find out how to convert your rawdog state file.)
+rawdog has the following dependencies:
-rawdog requires Python 2.6 or later. rawdog itself doesn't need any
-additional modules to be installed, but it uses distutils for
-installation, so if you're on a Debian system you'll need to install the
-"python-dev" package first.
+- Python 2.7 or later (but not Python 3)
+- feedparser 5.1.2 or later
+- PyTidyLib 0.2.1 or later (optional but strongly recommended)
To install rawdog on your system, use distutils -- "python setup.py
-install". This will install the library modules that rawdog needs, and
-will install the "rawdog" command that you can use to run it. (If you
-want to install to a non-standard prefix, read the help provided by
-"python setup.py install --help".)
+install". This will install the "rawdog" command and the "rawdoglib"
+Python module that it uses internally. (If you want to install to a
+non-standard prefix, read the help provided by "python setup.py install
+--help".)
rawdog needs a config file to function. Make the directory ".rawdog" in
your $HOME directory, copy the provided file "config" into that
files, if you've got the "splitstate" option turned on).
If you don't like the appearance of rawdog, then customise the style.css
-file. If you come up with one that looks much better than the existing
+file. If you come up with one that looks much better than the existing
one, please send it to me!
This should, hopefully, be all you need to know. If rawdog breaks in
projects / rawdog / .git / blobdiff