Skip to content

Commit bd75265

Browse files
author
Tim Shawver
committed
Updates to announce mult-index support and to link to Quantopian where appropriate, now that qgrid is available there. I'm going to update the /notebooks/survey links to point to the forum post once the forum post is created.
1 parent 4a6bdd5 commit bd75265

2 files changed

Lines changed: 42 additions & 11 deletions

File tree

README.rst

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,44 @@ Qgrid is a Jupyter notebook widget which uses `SlickGrid <https://github.com/mle
1111
DataFrames within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
1212
filtering controls, as well as edit your DataFrames by double clicking cells.
1313

14-
What's New in 1.0.3 - Introducing Qgrid Events
15-
----------------------------------------------
16-
Qgrid has some new API methods as of version 1.0.3 which can be used to attach event handlers. Event handlers are callback methods that get called when certain events occur in the qgrid interface. In qgrid 1.0.3, event handlers can be attached with the ``on`` method and detached with the ``off`` method. There are ``on`` and ``off`` methods on both the ``qgrid`` module (see `qgrid.on <https://qgrid.readthedocs.io/en/latest/#qgrid.on>`_), and on individual QgridWidget instances (see `qgrid.QgridWidget.on <https://qgrid.readthedocs.io/en/latest/#qgrid.QgridWidget.on>`_).
14+
Qgrid was developed for use in `Quantopian's hosted research environment <https://www.quantopian.com/notebooks/survey?utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_ and is available for use in that environment as of June 2018.
15+
16+
What's New
17+
----------
18+
**Improved MultiIndex Support (as of 1.0.6-beta.6)**:
19+
Qgrid now displays multi-indexed DataFrames with some of the index cells merged for readability, as is normally done when viewing DataFrames as a static html table. The following image shows qgrid displaying a multi-indexed DataFrame that was returned from Quantopian's `Pipeline API <https://www.quantopian.com/tutorials/pipeline?utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_:
20+
21+
.. figure:: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
22+
:align: left
23+
:target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
24+
:width: 100px
25+
26+
**Qgrid Events (as of 1.0.3)**:
27+
Qgrid has some new API methods which can be used to attach event handlers. Event handlers are callback methods that get called when certain events occur in the qgrid interface. In qgrid 1.0.3, event handlers can be attached with the ``on`` method and detached with the ``off`` method. There are ``on`` and ``off`` methods on both the ``qgrid`` module (see `qgrid.on <https://qgrid.readthedocs.io/en/latest/#qgrid.on>`_), and on individual QgridWidget instances (see `qgrid.QgridWidget.on <https://qgrid.readthedocs.io/en/latest/#qgrid.QgridWidget.on>`_).
1728

1829
To get a better idea of how these methods might be used, see the `Events API`_ section below.
1930

2031
Demo
2132
----
22-
Click the badge below to try out qgrid in a live sample notebook:
33+
Click the badge below to try out the latest beta of qgrid in Quantopian's hosted research environment. If you're already signed into Quantopian you'll be brought directly to the demo notebook. Otherwise you'll be prompted to register (it's free):
34+
35+
.. image:: https://img.shields.io/badge/launch-quantopian-red.svg?colorB=d33015
36+
:target: https://www.quantopian.com/clone_notebook?id=5ae9cff15230100046c3958d&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo
37+
|
38+
Click the badge below to try out qgrid using binder:
2339

24-
.. image:: https://beta.mybinder.org/badge.svg
40+
.. image:: https://beta.mybinder.org/badge.svg
2541
:target: https://mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?filepath=index.ipynb
2642
|
27-
Click the following badge to try out qgrid in Jupyterlab:
43+
Click the following badge to try out qgrid in Jupyterlab, also using binder:
2844

29-
.. image:: https://mybinder.org/badge.svg
45+
.. image:: https://mybinder.org/badge.svg
3046
:target: https://mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?urlpath=lab
3147
|
3248
*For both binder links, you'll see a brief loading screen while a server is being created for you in the cloud. This shouldn't take more than a minute, and usually completes in under 10 seconds.*
3349

50+
*The binder demos generally will be using the most recent stable release of qgrid, so features that were added in a recent beta version may not be available in those demos.*
51+
3452
For people who would rather not go to another page to try out qgrid for real, here's the tldr; version:
3553

3654
.. figure:: docs/images/filtering_demo.gif

docs/index.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@
1212
Qgrid API Documentation
1313
=======================
1414

15-
Qgrid is an `Jupyter notebook widget <https://github.com/ipython/ipywidgets>`_ which uses
16-
`SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render `pandas <https://github.com/pydata/pandas>`_ DataFrames
17-
as interactive grid controls.
15+
Qgrid is a Jupyter notebook widget which uses `SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render pandas
16+
DataFrames within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
17+
filtering controls, as well as edit your DataFrames by double clicking cells.
18+
19+
Qgrid was developed for use in `Quantopian's hosted research environment
20+
<https://www.quantopian.com/notebooks/survey?utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_
21+
and is available for use in that environment as of June 2018.
22+
1823

1924
Other qgrid resources
2025
---------------------
@@ -26,8 +31,16 @@ resources:
2631
This is where you'll find the source code and the rest of the documentation for the project, including the
2732
instructions for installing and running qgrid.
2833

34+
`qgrid demo on Quantopian <https://www.quantopian.com/clone_notebook?id=5ae9cff15230100046c3958d&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_
35+
Click the badge below try out the latest beta of qgrid in Quantopian's hosted research environment. If you're
36+
already signed into Quantopian you'll be brought directly to the demo notebook. Otherwise you'll be prompted
37+
to register (it's free):
38+
39+
.. image:: https://img.shields.io/badge/launch-quantopian-red.svg?colorB=d33015
40+
:target: https://www.quantopian.com/clone_notebook?id=5ae9cff15230100046c3958d&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo
41+
2942
`qgrid demo on binder <https://beta.mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?filepath=index.ipynb>`_
30-
Click the badge below or the link above to try out qgrid in your browser. You'll see a brief loading screen and
43+
Click the badge below or the link above to try out qgrid using binder. You'll see a brief loading screen and
3144
then a notebook will appear:
3245

3346
.. image:: https://beta.mybinder.org/badge.svg

0 commit comments

Comments
 (0)