Browse files

upgrade to venus

  • Loading branch information...
1 parent 9ceefd5 commit bdae35c754d30632eb4e891d08f8a3c71180e29a @alexott alexott committed Dec 26, 2010
Showing 432 changed files with 63,215 additions and 4,086 deletions.
@@ -1,2 +1,7 @@
+Sam Ruby <>
+This codebase represents a radical refactoring of Planet 2.0, which lists
+the following authors:
Scott James Remnant <>
Jeff Waugh <>
@@ -1,151 +0,0 @@
-Installing Planet
-You'll need at least Python 2.1 installed on your system, we recommend
-Python 2.3 though as there may be bugs with the earlier libraries.
-Everything Pythonesque Planet needs should be included in the
- i.
- First you'll need to extract the files into a folder somewhere.
- I expect you've already done this, after all, you're reading this
- file. You can place this wherever you like, ~/planet is a good
- choice, but so's anywhere else you prefer.
- ii.
- Make a copy of the files in the 'examples' subdirectory, and either
- the 'basic' or 'fancy' subdirectory of it and put them wherever
- you like; I like to use the Planet's name (so ~/planet/debian), but
- it's really up to you.
- The 'basic' index.html and associated config.ini are pretty plain
- and boring, if you're after less documentation and more instant
- gratification you may wish to use the 'fancy' ones instead. You'll
- want the stylesheet and images from the 'output' directory if you
- use it.
- iii.
- Edit the config.ini file in this directory to taste, it's pretty
- well documented so you shouldn't have any problems here. Pay
- particular attention to the 'output_dir' option, which should be
- readable by your web server and especially the 'template_files'
- option where you'll want to change "examples" to wherever you just
- placed your copies.
- iv.
- Edit the various template (*.tmpl) files to taste, a complete list
- of available variables is at the bottom of this file.
- v.
- Run it: pathto/config.ini
- You'll want to add this to cron, make sure you run it from the
- right directory.
- vi.
- Tell us about it! We'd love to link to you on :-)
-Template files
-The template files used are given as a space separated list in the
-'template_files' option in config.ini. They are named ending in '.tmpl'
-which is removed to form the name of the file placed in the output
-Reading through the example templates is recommended, they're designed to
-pretty much drop straight into your site with little modification
-Inside these template files, <TMPL_VAR xxx> is replaced with the content
-of the 'xxx' variable. The variables available are:
- name .... } the value of the equivalent options
- link .... } from the [Planet] section of your
- owner_name . } Planet's config.ini file
- owner_email }
- url .... link with the output filename appended
- generator .. version of planet being used
- date .... { your date format
- date_iso ... current date and time in { ISO date format
- date_822 ... { RFC822 date format
-There are also two loops, 'Items' and 'Channels'. All of the lines of
-the template and variable substitutions are available for each item or
-channel. Loops are created using <TMPL_LOOP LoopName>...</TMPL_LOOP>
-and may be used as many times as you wish.
-The 'Channels' loop iterates all of the channels (feeds) defined in the
-configuration file, within it the following variables are available:
- name .... value of the 'name' option in config.ini, or title
- title .... title retreived from the channel's feed
- tagline .... description retreived from the channel's feed
- link .... link for the human-readable content (from the feed)
- url .... url of the channel's feed itself
- Additionally the value of any other option specified in config.ini
- for the feed, or in the [DEFAULT] section, is available as a
- variable of the same name.
- Depending on the feed, there may be a huge variety of other
- variables may be available; the best way to find out what you
- have is using the 'planet-cache' tool to examine your cache files.
-The 'Items' loop iterates all of the blog entries from all of the channels,
-you do not place it inside a 'Channels' loop. Within it, the following
-variables are available:
- id .... unique id for this entry (sometimes just the link)
- link .... link to a human-readable version at the origin site
- title .... title of the entry
- summary .... a short "first page" summary
- content .... the full content of the entry
- date .... { your date format
- date_iso ... date and time of the entry in { ISO date format
- date_822 ... { RFC822 date format
- If the entry takes place on a date that has no prior entry has
- taken place on, the 'new_date' variable is set to that date.
- This allows you to break up the page by day.
- If the entry is from a different channel to the previous entry,
- or is the first entry from this channel on this day
- the 'new_channel' variable is set to the same value as the
- 'channel_url' variable. This allows you to collate multiple
- entries from the same person under the same banner.
- Additionally the value of any variable that would be defined
- for the channel is available, with 'channel_' prepended to the
- name (e.g. 'channel_name' and 'channel_link').
- Depending on the feed, there may be a huge variety of other
- variables may be available; the best way to find out what you
- have is using the 'planet-cache' tool to examine your cache files.
-There are also a couple of other special things you can do in a template.
- - If you want HTML escaping applied to the value of a variable, use the
- <TMPL_VAR xxx ESCAPE="HTML"> form.
- - If you want URI escaping applied to the value of a variable, use the
- <TMPL_VAR xxx ESCAPE="URI"> form.
- - To only include a section of the template if the variable has a
- non-empty value, you can use <TMPL_IF xxx>....</TMPL_IF>. e.g.
- <TMPL_IF new_date>
- <h1><TMPL_VAR new_date></h1>
- </TMPL_IF>
- You may place a <TMPL_ELSE> within this block to specify an
- alternative, or may use <TMPL_UNLESS xxx>...</TMPL_UNLESS> to
- perform the opposite.
@@ -1,4 +0,0 @@
-Planet 1.0
- * First release!
@@ -1,10 +0,0 @@
-Metadata-Version: 1.0
-Name: planet
-Version: 2.0
-Summary: The Planet Feed Aggregator
-Author: Planet Developers
-License: Python
-Description: UNKNOWN
-Platform: UNKNOWN
@@ -0,0 +1,20 @@
+Planet is a flexible feed aggregator. It downloads news feeds published by
+web sites and aggregates their content together into a single combined feed,
+latest news first. This version of Planet is named Venus as it is the
+second major version. The first version is still in wide use and is
+also actively being maintained.
+It uses Mark Pilgrim's Universal Feed Parser to read from CDF, RDF, RSS and
+Atom feeds; Leonard Richardson's Beautiful Soup to correct markup issues;
+and either Tomas Styblo's templating engine or Daniel Viellard's implementation
+of XSLT to output static files in any format you can dream up.
+To get started, check out the documentation in the docs directory. If you have
+any questions or comments, please don't hesitate to use the planet mailing list:
+Keywords: feed, blog, aggregator, RSS, RDF, Atom, OPML, Python
@@ -1,35 +0,0 @@
-Planet Clojure
-This is the source code of [Planet Clojure](
-Planet Clojure runs on [Planet]( which is
-written in [Python]( (a *fine* programming language).
-The template of Planet Clojure was designed by
-[Brajeshwar](; so all credit goes to him.
-Adding yourself to Planet Clojure
-If you have a blog on Clojure and want to feature on Planet Clojure,
-fork this project on Github, edit the file `clojure/config.ini` and
-add your blog feed URL and your name in the following format -
- [http://path/to/your/blog/feed/]
- name = Your Name
-After you are done, commit the change to your repository and send me a
-pull request. I will be happy to add you to Planet Clojure.
-Note: Please add the feed which contains only those posts which are
-Clojure/Lisp related. As a policy we do not put generic feeds on Planet
-Reporting Bugs
-If you have an issue with the design or even Planet, feel free to send
-me pull requests of your fixes. I will be happy to merge those into
-my tree.
@@ -1,3 +1,26 @@
+DeWitt Clinton - Mac OSX
+Mary Gardiner - PythonPath
+Elias Torres - FOAF OnlineAccounts
+Jacques Distler - Template patches
+Michael Koziarski - HTTP Auth fix
+Brian Ewins - Win32 / Portalocker
+Joe Gregorio - python versioning for filters, verbose tests, spider_threads
+Harry Fuecks - Pipe characters in file names, filter bug
+Eric van der Vlist - Filters to add language, category information
+Chris Dolan - mkdir cache; default template_dirs; fix xsltproc
+David Sifry - rss 2.0 xslt template based on
+Morten Frederiksen - Support WordPress LinkManager OPML
+Harry Fuecks - default item date to feed date
+Antonio Cavedoni - Django templates
+Morten Frederiksen - expungeCache
+Lenny Domnitser - Coral CDN support for URLs with non-standard ports
+Amit Chakradeo - Allow read-only files to be overwritten
+Matt Brubeck - fix new_channel
+Aristotle Pagaltzis - ensure byline_author filter doesn't drop foreign markup
+This codebase represents a radical refactoring of Planet 2.0, which lists
+the following contributors:
Patches and Bug Fixes
@@ -1,22 +1,7 @@
- * Expire feed history
- The feed cache doesn't currently expire old entries, so could get
- large quite rapidly. We should probably have a config setting for
- the cache expiry, the trouble is some channels might need a longer
- or shorter one than others.
* Allow display normalisation to specified timezone
Some Planet admins would like their feed to be displayed in the local
timezone, instead of UTC.
- * Support OPML and foaf subscriptions
- This might be a bit invasive, but I want to be able to subscribe to OPML
- and FOAF files, and see each feed as if it were subscribed individually.
- Perhaps we can do this with a two-pass configuration scheme, first to pull
- the static configs, second to go fetch and generate the dynamic configs.
- The more I think about it, the less invasive it sounds. Hmm.
Oops, something went wrong.

0 comments on commit bdae35c

Please sign in to comment.