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.

Source Distribution

django-report-tools-0.2.2.tar.gz (32.5 kB view details)

Uploaded Source

File details

Details for the file django-report-tools-0.2.2.tar.gz.

File metadata

File hashes

Hashes for django-report-tools-0.2.2.tar.gz
Algorithm Hash digest
SHA256 aa5478c793ba728c657361e9167b20eb5d2bf045ec7519d458511f7898d60b54
MD5 1de17b79e4089a5a46088d416d4e7ae6
BLAKE2b-256 12658a24237f99ac7e3ca846de8a1b9a5299ed7a42028a6431c0c241c998cc7b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page