代码改变世界

A Trac Feeds Screen Plugin is added

2010-05-23 12:39  Tower Joo  阅读(409)  评论(0编辑  收藏  举报

A Trac Feeds Screen Plugin is added

An old sentence goes like this, "It's best to mock it when you want to learn something new". And  this sentence proves to be correct to me after my implementing the trac feeds screen plugin for Touch Screen.

Background

I'm a newbie to the GSoC and I'm lucky that I can work with the osuosl project. This project is a Django based project, which employs some other Python related technologies, including twistedmuddle and etc.

The whole framework is like this(quoted from my proposal)
(notice: the diagram may be not so precise and maybe misleading, and I will draw another diagram when I know better to this project).

Week One

After reading some codes of Touch Screen and its plugins examples, I try to write a Trac feeds plugin, which has the following features:
  1. support all Trac Rss feeds
  2. a good UI
  3. a good performance(acceptable response time)
  4. fault tolerance
  5. loose coupling with current codes
With hours' coding, the usable plugin can be found in this checkin, which currently supports:
  1. timeline, tickets,  changeset Rss feeds 
  2. to boost performance by
    • cache the requested feeds in client side(javascript), --this  feature is configurable(enable/disable) 
    • limit the feeds number in server side(add a max=50 to limit the number)
  3. it's kind of loose coupling, which means you only need to add the app to the settings.py and add a url dispatcher to the urls.py. See README for more information
  4. See the below screenshot about the plugin



Tips

If you want to check out the codes and run it by yourself, you can follow the steps as below:
  1. check out the codes using git (git://github.com/topman/touchscreen.git)
  2. setup the enviroment
  3. edit the settings.py and urls.py(see screens/trac_feeds/README to know more)
  4. run it as an ordinary django project
  5. go to http://127.0.0.1:8000/plugins (adjust to your running url) to enable the plugin and set the configuration as you need
  6. and go to http://127.0.0.1:8000/, then you should see the screen
  7. use arrow-left and arrow-right to request more feeds

Plan

Next week, I will follow the plan as below:
  1. Refine the plugin to make it more robust and a better UI.
    • fault tolerance
    • a self-adjustable UI
    • stable enough to release as a plugin
  2. Read more codes and try to understand the core logic of the project