hurry.jqplot
************

Introduction
============

This library packages jqPlot_ for `hurry.resource`_. It is aware of jqPlot's
structure and different modes (normal, minified).

.. _`hurry.resource`: http://pypi.python.org/pypi/hurry.resource
.. _jqPlot: http://www.jqplot.com/

How to use?
===========

You can import jqPlot from ``hurry.jqplot`` and ``.need`` it where you want
these resources to be included on a page::

  from hurry.jqplot import jqplot

  .. in your page or widget rendering code, somewhere ..

  jqplot.need()

This requires integration between your web framework and ``hurry.resource``,
and making sure that the original resources (shipped in the ``jqplot-build``
directory in ``hurry.jqplot``) are published to some URL.

The package has already been integrated for Grok_ and Zope 3. If you depend
on the `hurry.zoperesource`_ package in your ``setup.py``, the above example
should work out of the box. Make sure to depend on the `hurry.zoperesource`_
package in your ``setup.py``.
For grok, depending on `megrok.resource`_ should do it

.. _`hurry.zoperesource`: http://pypi.python.org/pypi/hurry.zoperesource
.. _`megrok.resource`: http://pypi.python.org/pypi/megrok.resource
.. _Grok: http://grok.zope.org

Preparing hurry.jqplot before release
=====================================

This section is only relevant to release managers of ``hurry.jqplot``.

When releasing ``hurry.jqplot``, an extra step should be taken. Follow the
regular package `release instructions`_, but before egg generation (``python
setup.py register sdist upload``) first execute ``bin/jqplotprepare``. This
will download the jqPlot library and place it in the egg.  (The version number
is currently hardcoded in the hurry.jqplot.prepare module).

.. _`release instructions`: http://grok.zope.org/documentation/how-to/releasing-software
