Metadata-Version: 1.1
Name: django-nvd3
Version: 0.7.3
Summary: Django NVD3 - Chart Library for d3.js
Home-page: http://github.com/areski/django-nvd3
Author: Belaid Arezqui
Author-email: areski@gmail.com
License: MIT License
Description: Django Wrapper for NVD3 - It's time for beautiful charts
        ========================================================
        
        :Description: Django-nvd3 is a wrapper for NVD3 graph library
        :nvd3: NVD3 http://nvd3.org/
        :d3: Data-Driven Documents http://d3js.org/
        
        
        NVD3 is an attempt to build re-usable charts and chart components
        for d3.js without taking away the power that d3.js gives you.
        
        
        .. image:: https://www.travis-ci.org/areski/django-nvd3.png?branch=master
        
        
        Installation
        ------------
        
        Install, upgrade and uninstall django-nvd3 with these commands::
        
            $ pip install django-nvd3
            $ pip install --upgrade django-nvd3
            $ pip uninstall django-nvd3
        
        Then edit settings.py from your django project and add 'django_nvd3' in your 'INSTALLED_APPS' setting.
        
        
        Dependencies
        ------------
        
        Django-nvd3 have one major dependencie:
        
        * python-nvd3 : https://github.com/areski/python-nvd3
        
        
        Bower will be used to install D3 and NvD3, see bower website for futher info : http://bower.io/
        
        Bower depends on Node and npm. It's installed globally using npm::
        
            npm install -g bower
        
        To easy the integration with Django we will advice you to use django-bower.
        
        For instance to run our demo project, you will install the dependencies from requirements.txt and then
        install django-bower. Django-bower is not a mandatory dependencies as the user should be free to install JS files
        using different method.
        
        To install django-bower::
        
            $ pip install django-bower
        
        Read the documentation about Django-bower to find out how to configure it properly for your project: https://github.com/nvbn/django-bower
        
        Then in the demo project directory just type the following::
        
            $ python manage.py bower_install
            $ python manage.py collectstatic
        
        This will create a directory "components" where d3 & nvd3 will be installed.
        
        You can see example settings file in `demoproject <https://github.com/areski/django-nvd3/blob/master/demoproject/demoproject/settings.py>`_.
        
        
        
        Example how to create a pieChart
        --------------------------------
        
        Let’s say we have a simple view in which we want to display the amount of calories per fruit.
        
        So to achieve this, we will edit our view.py, we will prepare the data that will be displayed::
        
            xdata = ["Apple", "Apricot", "Avocado", "Banana", "Boysenberries", "Blueberries", "Dates", "Grapefruit", "Kiwi", "Lemon"]
            ydata = [52, 48, 160, 94, 75, 71, 490, 82, 46, 17]
            chartdata = {'x': xdata, 'y': ydata}
            charttype = "pieChart"
            chartcontainer = 'piechart_container'
            data = {
                'charttype': charttype,
                'chartdata': chartdata,
                'chartcontainer': chartcontainer,
                'extra': {
                    'x_is_date': False,
                    'x_axis_format': '',
                    'tag_script_js': True,
                    'jquery_on_ready': False,
                }
            }
            return render_to_response('piechart.html', data)
        
        
        We will render the template 'piechart.html' with a dictionary 'data' which contains 'charttype' and 'chartdata'.
        'extra' will contains a list of additional settings::
            * ``x_is_date`` - if enabled the x-axis will be display as date format
            * ``x_axis_format`` - set the x-axis date format, ie. "%d %b %Y"
            * ``tag_script_js`` - if enabled it will add the javascript tag '<script>'
            * ``jquery_on_ready`` - if enabled it will load the javascript only when page is loaded
                this will use jquery library, so make sure to add jquery to the template.
            * ``color_category`` - Define color category (eg. category10, category20, category20c)
        
        
        Our template piechart.html could look like this::
        
            {% load nvd3_tags %}
            <head>
                {% include_chart_jscss %}
                {% load_chart charttype chartdata chartcontainer extra %}
            </head>
            <body>
                <h1>Fruits vs Calories</h1>
                {% include_container chartcontainer 400 600 %}
            </body>
        
        We use include the Javascript and CSS code for D3/NVD3.
        We start preparing and display the javascript code needed to render our pieChart::
        
            {% load_chart charttype chartdata "piechart_container" %}
        
        Finally we create a div container which will be used to display the chart.
        
        
        The result will be a beautiful and interactive chart:
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/piechart_fruits_vs_calories.png
        
        
        For more examples, please look at the demoproject directory in our repository, it shows an simple example for all the supported
        charts by django-nvd3.
        
        
        Live demo of NVD3
        -----------------
        
        See a live demo on jsfiddle : http://jsfiddle.net/areski/z4zuH/3/
        
        
        Supported nvd3 charts
        ---------------------
        
        Charts list:
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/lineWithFocusChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/lineChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/multiBarChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/pieChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/stackedAreaChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/multiBarHorizontalChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/linePlusBarChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/cumulativeLineChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/discreteBarChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/scatterChart.png
        
        .. image:: https://raw.github.com/areski/django-nvd3/master/docs/source/_static/screenshot/linePlusBarWithFocusChart.png
        
        
        Projects using Django-nvd3
        --------------------------
        
        * CDR-Stats : http://www.cdr-stats.org
        * Newfies-Dialer : http://www.newfies-dialer.org
        
        
        Documentation
        -------------
        
        Documentation is available on 'Read the Docs':
        http://django-nvd3.readthedocs.org
        
        
        Changelog
        ---------
        
        Changelog summary : https://github.com/areski/django-nvd3/blob/master/CHANGELOG.rst
        
        
        License
        -------
        
        Django-nvd3 is licensed under MIT, see `MIT-LICENSE.txt`.
        
Keywords: django,nvd3,chart,graph,d3
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
