README.rst

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

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

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/nicolaskruchten/jupyter_pivottablejs/master?filepath=example%2Fjupyter_pivottablejs_example.ipynb


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

``pip install pivottablejs`` or ``conda install pivottablejs``

**Note** in the past, the ``conda`` command above installed `pivottablejs-airgap`_ instead of this library; apologies for any confusion this change may cause.

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 `JSON-serializable 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
.. _pivottablejs-airgap: https://github.com/ContinuumIO/pivottablejs-airgap
=======
.. _option to PivotTable.js's pivotUI() function: https://github.com/nicolaskruchten/pivottable/wiki/Parameters#options-object-for-pivotui

FORK Additions
--------------
Allow for custom *title* on the output html file
=======
Allow for custom `Title`

.. code:: python

    pivot_ui(df, outfile_path="/x/y.html", url="http://localhost/a/b/x.html", title="Custom Title Here")
.. _JSON-serializable option to PivotTable.js's pivotUI() function: https://github.com/nicolaskruchten/pivottable/wiki/Parameters#options-object-for-pivotui