Description: Ruby-Feedparser is an RSS and Atom parser for Ruby
Keywords: feed,rss,atom,parser,ruby

# Ruby-Feedparser

Ruby-Feedparser is an RSS and Atom parser for Ruby. It was initially developed for Feed2Imap, but it is now a standalone library.

Ruby-feedparser is :

- based on REXML
- built for robustness : most feeds are not valid, a parser can't ignore that
- fully unit-tested
- easy to use (it can output text or HTML easily)

To learn more about syndication, RSS and Atom, read :

- Wikipedia: Web feed
- Wikipedia: RSS (file format)
- Wikipedia: Atom (standard)
- Wikipedia: Aggregator

Similar projects : Simple-RSS, Blog Harvester.

## Download

Latest release: ruby-feedparser-0.7.tgz. Other formats and older releases are also available.

## Installation Instructions

- Download it and untar it.
- Run ./setup.rb as root, or figure out how to install it on your account by reading ./setup.rb --help (it's possible, but you have to take care of RUBYPATH.
- Install the needed dependancies. For Debian, it is : ruby libtest-unit-ruby librexml-ruby rake (if you are using Debian Woody, find another solution : ruby is too old on woody)
- (Not mandatory, but a good idea :) run rake test and check that everything is working fine.

## Developers

### Mailing List

ruby-feedparser-devel at gna dot org is a mailing list for development and general discussion.

- Ruby-Feedparser-devel Info Page (to subscribe/unsubscribe, etc)
- Ruby-Feedparser-devel archives

SVN and CVS commits are sent to ruby-feedparser-commits at gna dot org. Discussion about them takes place on ruby-feedparser-devel.

- ruby-feedparser-commits Info Page (to subscribe/unsubscribe, etc)
- ruby-feedparser-commits archives

### (Sort of) Developer Documentation

Development takes place on github.com. Bug reports can be sent using the GNA project page.

Clone the github repository using `git-clone git://github.com/ln/ruby-feedparser.git`.