Skip to main content

Class-based reports for elegant data views.

Project description

django-report-tools
===================

Django Report Tools aims to take the pain out of putting charts, graphs
and tables into your Django projects. It provides a nice class-based
framework to restore a little bit of elegance to your application's
complex data views.


Features
--------

* Define your reports using the same syntax as Django forms and models
* Use built-in 'renderers' to avoid the hassle of dealing with various
charting technologies (currently only the Google Visualization Toolkit is supported)
* Enter chart data in a standardised format
* Build a simple API, allowing for the creation of chart exports or a 'save to dashboard' feature.


Release Notes - 0.2.1
---------------------

* Fixed a JSON encoding bug that broke Python 2.6 compatibility.
* Added a tox.ini and setup.py test support so I can test and prevent these sorts of
bug in the future.

Release Notes - 0.2
-------------------

* Updated for Django 1.5 compatibility
* Fixed an XSS vector in the Google Charts renderer
* Updated to the most recent GViz API


A fully-functional example report
-----------------

The following example implements a report with a simple pie chart, rendered
using the Google Visualization Toolkit.

::

from report_tools.reports import Report
from report_tools.chart_data import ChartData
from report_tools.renderers.googlecharts import GoogleChartsRenderer
from report_tools import charts


class MyReport(Report):
renderer = GoogleChartsRenderer

pie_chart = charts.PieChart(
title="A nice, simple pie chart",
width=400,
height=300
)

def get_data_for_pie_chart(self):
data = ChartData()

data.add_column("Pony Type")
data.add_column("Population")

data.add_row(["Blue", 20])
data.add_row(["Pink", 20])
data.add_row(["Magical", 1])

return data

Read on in the documentation for a full explanation and lots more examples.


Links
-----

Project Home: http://github.com/evanbrumley/django-report-tools

Documentation: http://django-report-tools.readthedocs.org


Installation
------------

To install django-report-tools simply use: ::

$ pip install django-report-tools

Or alternatively: ::

$ easy_install django-report-tools

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-report-tools-0.2.2.tar.gz (32.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page