pluto

Another planet generator in ruby - lets you build web pages from published web feeds.

• home :: github.com/feedreader/pluto
• bugs :: github.com/feedreader/pluto/issues
• gem :: rubygems.org/gems/pluto
• rdoc :: rubydoc.info/gems/pluto

Usage

Use the pluto command line tool and pass in one or more planet configuration files. Example:

pluto build ruby.yml        or
pluto b ruby

This will

1) fetch all feeds listed in ruby.yml and

2) store all entries in a local database, that is, ruby.db in your working folder and

3) generate a planet web page, that is, ruby.html using the blank template pack in your working folder using all feed entries from the local database.

Open up ruby.html to see your planet web page. Voila!

Command Line Tool

NAME
    pluto - another planet generator - lets you build web pages from published web feeds

SYNOPSIS
    pluto [global options] command [command options] [arguments...]

GLOBAL OPTIONS
    -c, --config=PATH - Configuration Path (default: ~/.pluto)
    -q, --quiet       - Only show warnings, errors and fatal messages
    --verbose         - (Debug) Show debug messages
    --version         - Display the program version
    --help            - Show this message

COMMANDS
    build, b    - Build planet
    install, i  - Install template pack
    list, ls, l - List installed template packs
    about, a    - (Debug) Show more version info
    help        - Shows a list of commands or help for one command

build Command

NAME
    build - Build planet

SYNOPSIS
    pluto [global options] build [command options] FILE

COMMAND OPTIONS
    -o, --output=PATH       - Output Path (default: .)
    -t, --template=MANIFEST - Template Manifest (default: blank)

EXAMPLE
    pluto build ruby.yml
    pluto b ruby

list Command

NAME
    list - List installed template packs

SYNOPSIS
    pluto [global options] list

EXAMPLE
   pluto list
   pluto ls

install Command

NAME
    install - Install template pack

SYNOPSIS
    pluto [global options] install MANIFEST

EXAMPLE
   pluto install news      # install "river of news" template pack

Planet Configuration Sample

ruby.yml:

title: Planet Ruby

feeds:
  - rubyflow
  - edgerails
  - rubyonrails
  - railstutorial

rubyflow:
  title: Ruby Flow
  feed_url: http://feeds.feedburner.com/Rubyflow?format=xml
  url: http://rubyflow.com

edgerails:
  title: What's new in Edge Rails?
  feed_url:  http://www.edgerails.info/blog.atom
  url: http://www.edgerails.info

rubyonrails:
  title: Ruby on Rails Blog
  feed_url: http://weblog.rubyonrails.org/feed/atom.xml
  url: http://weblog.rubyonrails.org

railstutorial:
  title: Rails Tutorial News
  feed_url: http://feeds.feedburner.com/railstutorial?format=xml
  url: http://news.railstutorial.org

For more samples, see nytimes.yml, js.yml, dart.yml.

Install

Just install the gem:

$ gem install pluto

Real World Usage

pluto.live - sample planet site; sinatra web app/starter template in ruby using the pluto gem

Alternatives

Ruby

planet.rb by Akira Yamada (Site)

Planet.rb by Pablo Astigarraga (Site) - used with jekyll/octopress site generator

Python

Planet Planet by Scott James Remnant n Jeff Waugh (Site) - uses Mark Pilgrim's universal feed parser (RDF, RSS and Atom) and Tomas Styblo's templating engine

Planet Venus by Sam Ruby (Site) - cleaned up Planet Planet code

License

The pluto scripts are dedicated to the public domain. Use it as you please with no restrictions whatsoever.