README.txt

   1 # PlanetFilter
   2
   3 PlanetFilter uses a blacklist to filter a blog aggregator feed. It allows
   4 anyone to subscribe to popular blog aggregators without being overwhelmed by
   5 the noise.
   6
   7 It supports the RSS, RSS 2.0 and Atom formats.
   8
   9 ## Installation
  10
  11 To install using pip, simply do this:
  12
  13     $ pip install planetfilter
  14
  15 ## Usage
  16
  17 To filter a given author out of a blog aggregator, create a config file for
  18 that aggregator:
  19
  20     [feed]
  21     url=http://planet.mozilla.org/rss20.xml
  22
  23     [blacklist]
  24     authors = The Mozilla Blog
  25       Mozilla Release Management Team
  26     titles =
  27       Product Coordination Meeting
  28
  29 and then run:
  30
  31     planetfilter --output filtered.xml planet.conf
  32
  33 Then in your feed reader, add the feed either using a `file:///` URL or
  34 as an `http://localhost/` URL if you serve it using a local web server.
  35
  36 ## Compatibility
  37
  38 PlanetFilter is known to work with the following feed readers:
  39
  40 * [Akregator](https://userbase.kde.org/Akregator) using `file:///` URLs
  41 * [Thunderbird](https://www.mozilla.org/thunderbird/) using `http://localhost/` URLs
  42
  43 ## License
  44
  45 Copyright (C) 2010, 2015  Francois Marier <francois@fmarier.org>
  46
  47 This program is free software: you can redistribute it and/or modify
  48 it under the terms of the GNU Affero General Public License as
  49 published by the Free Software Foundation, either version 3 of the
  50 License, or (at your option) any later version.
  51
  52 This program is distributed in the hope that it will be useful,
  53 but WITHOUT ANY WARRANTY; without even the implied warranty of
  54 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  55 GNU General Public License for more details.
  56
  57 You should have received a copy of the GNU General Public License
  58 along with this program.  If not, see <http://www.gnu.org/licenses/>.