Metadata-Version: 2.1
Name: pivottablejs
Version: 0.9.0
Summary: PivotTable.js integration for Jupyter/IPython Notebook
Home-page: https://github.com/nicolaskruchten/jupyter_pivottablejs
Author: Nicolas Kruchten
Author-email: nicolas@kruchten.com
License: MIT
Keywords: pivot table grid pivottable pivotgrid pivotchart crosstab
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Utilities
Classifier: Environment :: Web Environment
Classifier: Framework :: IPython
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: JavaScript

``pivottablejs``: the Python module
===================================

Drag’n’drop Pivot Tables and Charts for `Jupyter/IPython Notebook`_,
care of `PivotTable.js`_

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

``pip install pivottablejs``

Usage
-----

.. code:: python

    import pandas as pd
    df = pd.read_csv("some_input.csv")

    from pivottablejs import pivot_ui

    pivot_ui(df)

Advanced Usage
--------------

Include any `option to PivotTable.js's pivotUI() function`_ as a keyword argument.

.. code:: python

    pivot_ui(df, rows=['row_name'], cols=['col_name'])

Independently control the output file path and the URL used to access it from Jupyter, in case the default relative-URL behaviour is incompatible with Jupyter's settings.

.. code:: python

    pivot_ui(df, outfile_path="/x/y.html", url="http://localhost/a/b/x.html")

.. _Jupyter/IPython Notebook: http://jupyter.org/
.. _PivotTable.js: https://github.com/nicolaskruchten/pivottable
.. _option to PivotTable.js's pivotUI() function: https://github.com/nicolaskruchten/pivottable/wiki/Parameters#options-object-for-pivotui
