Source

community_codeswarm / readme.mdwn

Full commit
Shared Codeswarm
================

Project goal
------------

This project aims towards producing shared code_swarm videos across free software 
projects - and the long-term goal tracking the progress of software projects visually 
in near-realtime. 

If you read [Otherland][otherland-amazon]: code_swarm should be quite capable of 
delivering a codegarden which tracks the progress and dynamics of our free software 
community (in analogy to the Otherland 
[packet garden](http://www.selectparks.net/~julian/pg/) ). 

[otherland-amazon]: http://www.amazon.com/gp/product/0886777631?ie=UTF8&tag=draketo-20&linkCode=as2&camp=1789&creative=9325&creativeASIN=0886777631

The movies should look similar to the following, but with a smaller timeframe (a 
week instead of half a year) and more projects: 

![codeswarm-example](code_swarm-image.png)

[watch a shared codeswarm example video](shared_codeswarm-example.avi)

You can find additional information on its 
[website](http://rakjar.de/shared_codeswarm) and in the [code 
repository](http://bitbucket.org/ArneBab/community_codeswarm/) 
(if you're on the website right now: you're reading the automatically parsed 
and uploaded readme :) ). 

Usage
-----

In the directory containing the 
[simple.config](http://www.bitbucket.org/ArneBab/community_codeswarm/src/6bfa4ea3dce3/simple.config) 
file: 

* python community_codeswarm.py --codeswarm-path "absolute path to the codeswarm dir"

For it to work, you need [pyyaml](http://pyyaml.org/), 
[Mercurial](http://selenic.com/mercurial) with [code swarm style][hg_style_codeswarm] 
and naturally [code_swarm](http://vis.cs.ucdavis.edu/~ogawa/codeswarm/) installed. 

[hg_style_codeswarm]: http://www.nabble.com/How-to-exactly-mirror-"svn-log--v"---to18402630.html#a18430641

An example of an automatically created shared_codeswarm website is
[my_codeswarms](http://rakjar.de/my_codeswarms) which tracks the activity some of my 
other projects. 

Contact
-------

Please tell me if you use this script - and more so if you have ideas how to improve it. 

You can reach me via the [contact form](http://draketo.de/contact) on my website. 

Implementation plan
-------------------

- *A simple list (config) which maps repository names to repository update commands. - done*
- *A directory with incoming repositories. - done*
- *A directory with already parsed repositories. - done*
- *Codeswarm-creation from combined logs. - done*
- *Automated website creation with the codeswarms. - done*
- Automated codeswarm config creation from the simple.config. 

The ultimate goal is to create an almost real time codeswarm movie which tracks how 
your favorite free software projects evolve _right now_.