areski/django-admin-tools-stats

NOTE: This project was rewritten to be more flexible and to work with common Django admin and released as django-admin-charts <https://github.com/PetrDlouhy/django-admin-charts>_. The django-admin-charts project is backward-compatible with django-admin-tools-stats, so you can migrate to that. All development and maintanence continues on django-admin-charts repository.

Django-admin-tools-stats

:Description: Django-admin module to create charts and stats in your dashboard :Documentation: http://django-admin-tools-stats.readthedocs.org/en/latest/

.. image:: https://travis-ci.org/areski/django-admin-tools-stats.svg?branch=master :target: https://travis-ci.org/areski/django-admin-tools-stats

.. image:: https://img.shields.io/pypi/v/django-admin-tools-stats.svg :target: https://pypi.python.org/pypi/django-admin-tools-stats/ :alt: Latest Version

.. image:: https://img.shields.io/pypi/dm/django-admin-tools-stats.svg :target: https://pypi.python.org/pypi/django-admin-tools-stats/ :alt: Downloads

.. image:: https://img.shields.io/pypi/pyversions/django-admin-tools-stats.svg :target: https://pypi.python.org/pypi/django-admin-tools-stats/ :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/l/django-admin-tools-stats.svg :target: https://pypi.python.org/pypi/django-admin-tools-stats/ :alt: License

Django-admin-tools-stats is a Django admin module that allow you to create easily charts on your dashboard based on specific models and criterias.

It will query your models and provide reporting and statistics graphs, simple to read and display on your Dashboard.

.. image:: https://github.com/areski/django-admin-tools-stats/raw/master/docs/source/_static/admin_dashboard.png

Installation

Install, upgrade and uninstall django-admin-tools-stats with these commands::

$ pip install django-admin-tools-stats

Dependencies

django-admin-tools-stats is a django based application, the major requirements are :

- python-dateutil
- django-jsonfield
- django-qsstats-magic
- django-cache-utils
- django-admin-tools
- django-nvd3
- django-bower

Configure

Configure admin_tools
Configure django-bower
- Add django-bower to INSTALLED_APPS in settings.py::
  
  INSTALLED_APPS = ( ... 'djangobower' )
- Add the following properties to you settings.py file::
  
  Specifie path to components root (you need to use absolute path)
  
  BOWER_COMPONENTS_ROOT = os.path.join(PROJECT_ROOT, 'components')
  
  BOWER_INSTALLED_APPS = ( 'jquery#3.4.1', 'jquery-ui#1.12.1', 'd3#3.3.13', 'nvd3#1.7.1', )
- Add django-bower finder to your static file finders::
  
  STATICFILES_FINDERS = ( ... 'djangobower.finders.BowerFinder', )
- Run the following commands. These will download nvd3.js and its dependencies using bower and throw them in to you static folder for access by your application::
  
  $ python manage.py bower_install $ python manage.py collectstatic
Add admin_tools_stats & django_nvd3 into INSTALLED_APPS in settings.py::

INSTALLED_APPS = ( ... 'admin_tools_stats', 'django_nvd3', )
Add following code to dashboard.py::

from admin_tools_stats.modules import DashboardCharts, get_active_graph

append an app list module

self.children.append(modules.AppList( _('Dashboard Stats Settings'), models=('admin_tools_stats.*', ), ))

Copy following code into your custom dashboard

append following code after recent actions module or

a link list module for "quick links"

graph_list = get_active_graph() for i in graph_list: kwargs = {} kwargs['require_chart_jscss'] = True kwargs['graph_key'] = i.graph_key
```
for key in context['request'].POST:
    if key.startswith('select_box_'):
        kwargs[key] = context['request'].POST[key]

self.children.append(DashboardCharts(**kwargs))
```
To create the tables needed by Django-admin-tools-stats, run the following command::

$ python manage.py syncdb
You may also need to add some includes to your template admin base, see an example on the demo project:

demoproject/demoproject/templates/admin/base_site.html
Open admin panel, configure Dashboard Stats Criteria & Dashboard Stats respectively

Contributing

If you've found a bug, add a feature or improve django-admin-tools-stats and think it is useful then please consider contributing. Patches, pull requests or just suggestions are always welcome!

Source code: http://github.com/areski/django-admin-tools-stats

Bug tracker: https://github.com/areski/django-admin-tools-stats/issues