l e w k . o r g

Wed, 19 Dec 2007

TurboFlot 0.0.1

In an effort to clean up bodhi's metrics code a bit, I wrote a TurboFlot plugin that allows you to wield the jQuery plugin flot inside of TurboGears applications. The code is quite trivial -- it's essentially just a TurboGears JSON proxy to the jQuery flot plugin. Breaking this code out into it's own widget makes it really easy to generate shiny graphs in a Pythonic fashon, without having to write a line of javascript.

Check out the README to see the code for the example above.

To use TurboFlot in your own application, you just pass your data and graph options to the widget, and then throw it up to your template. Read the flot API documentation for details on all of the arguments. Here is a simple usage example:

flot = TurboFlot([
    {
        'data'  : [[0, 3], [4, 8], [8, 5], [9, 13]],
        'lines' : { 'show' : True, 'fill' : True }
    }],
    {
        'grid'  : { 'backgroundColor' : '#fffaff' },
        'yaxis' : { 'max' : '850' }
    }
)


Then, to display the widget in your template, you simply use:

${flot.display()}

The code for the widget itself is pretty simple. It just takes your data and graph options, encodes them as JSON and tosses them at flot.

class TurboFlot(Widget):
    """
        A TurboGears Flot Widget.
    """
    template = """
      <div xmlns:py="http://purl.org/kid/ns#" id="turboflot"
           style="width:${width};height:${height};">
        <script>
          $.plot($("#turboflot"), ${data}, ${options});
        </script>
      </div>
    """
    params = ["data", "options", "height", "width"]
    javascript = [JSLink('turboflot', 'excanvas.js'),
                  JSLink("turboflot", "jquery.js"),
                  JSLink("turboflot", "jquery.flot.js")]

    def __init__(self, data, options={}, height="300px", width="600px"):
        self.data = simplejson.dumps(data)
        self.options = simplejson.dumps(options)
        self.height = height
        self.width = width


You can download the latest releases from the Python Package Index:

http://pypi.python.org/pypi/TurboFlot

Or you can grab my latest development tree out of mercurial:

http://hg.lewk.org/TurboFlot

As always, patches are welcome :)

posted at: 20:21 | link | Tags: code, TurboFlot, TurboGears, Python | 4 comments

jQuery Red Hat code Fedora TurboGears boston random openbox irssi vim hardware ToscaWidgets college compression mutt linux tea OLPC l00t web code statistics open source fedora TurboGears Python encryption RIT presentations fastestmirror business music TurboFlot hilarious yum halloween linji email InfoVis life SXSW func web LiveUSB Windows hackery collaboration Linux TeachingOpenSource gobby holidays metrics virus bodhi Yum FUDCon wtf thinkpad humor badass hacks honeypot Moksha liveusb-creator filesystems Pyramid mugshot windows science fedmsg spam hosting presentations OpenShift optimization FUDCon nose benchmarks livecd security badass concerts Cloud fishing

Linkage

• Resume
• GitHub
• SoundCloud
• Instagram
• Twitter || identi.ca
• Pinboard
• Fedora Profile
• Facebook
• Freesound
• coderwall
• libre.fm || last.fm
• Blog
  • RSS
  • Atom

Projects

Contact me | Back to top
© 2007-2013 Luke Macken