feed2maildir: 9940c5e4e04e239b7d9ac24c335aa709dc238bf6

     1: # Feed2MaildirSimple #
     2: 
     3: Read RSS/Atom feeds in your favourite, maildir-compatible email client.
     4: 
     5: A simplified fork of Feed2Maildir, which doesn't use config files or databases.
     6: 
     7: ## Requirements ##
     8: 
     9: -   Python 2.7+ / 3.2+
    10: -   `feedparser`
    11: -   `python-dateutil`
    12: 
    13: ## Usage ##
    14: 
    15: Run the `feed2maildir` command. The content of the feed should be sent into the
    16: command's standard input; if the feed is online, you might want to use `curl` or
    17: `wget` to fetch it. The following options are available:
    18: 
    19:     -h, --help  show this help message and exit (optional)
    20:     -m <dir>    maildir location
    21:     -n <name>   name to use for this feed
    22:     -s          strip HTML from the feeds (optional)
    23: 
    24: To convert a feed, the `-m` and `-n` options are required. Only a single feed
    25: will be processed at a time; if you want to process multiple feeds, invoke the
    26: command inside a loop.
    27: 
    28: To prevent the same items being added over and over, each generated maildir
    29: entry is given an extra header `X-feed2maildirsimple-hash`, which stores the
    30: given feed name and some stable identifiers from the item. Before creating a new
    31: message, the given maildir is scanned for existing hashes, and the item is
    32: skipped if a corresponding message already exists.
    33: 
    34: Once the process has finished, no further work will be performed. If you want to
    35: fetch updates at regular intervals, run the command via a system like `cron`.