Skip to content

Update readme and API docs #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TimShawver merged 3 commits into from
Jun 21, 2018
+45 −12
Merged

Update readme and API docs #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bd75265
Updates to announce mult-index support and to link to Quantopian wher…
Jun 21, 2018
f46a6b1
Update links to point to actual forum post and notebook.
Jun 21, 2018
358b22e
FIll in copyright in license correctly.
Jun 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]
Copyright 2018 Quantopian, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
34 changes: 27 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,46 @@ Qgrid is a Jupyter notebook widget which uses `SlickGrid <https://github.com/mle
DataFrames within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
filtering controls, as well as edit your DataFrames by double clicking cells.

What's New in 1.0.3 - Introducing Qgrid Events
----------------------------------------------
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>`_).
Qgrid was developed for use in `Quantopian's hosted research environment
<https://www.quantopian.com/posts/qgrid-now-available-in-research-an-interactive-grid-for-sorting-and-filtering-dataframes?utm_source=github&utm_medium=web&utm_campaign=qgrid-repo>`_
and is available for use in that environment as of June 2018.

What's New
----------
**Improved MultiIndex Support (as of 1.0.6-beta.6)**:
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>`_:

.. figure:: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
:align: left
:target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
:width: 100px

**Qgrid Events (as of 1.0.3)**:
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>`_).

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

Demo
----
Click the badge below to try out qgrid in a live sample notebook:
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):

.. image:: https://img.shields.io/badge/launch-quantopian-red.svg?colorB=d33015
:target: https://www.quantopian.com/clone_notebook?id=5b2baee1b3d6870048620188&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo
|
Click the badge below to try out qgrid using binder:

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

.. image:: https://mybinder.org/badge.svg
.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?urlpath=lab
|
*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.*

*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.*

For people who would rather not go to another page to try out qgrid for real, here's the tldr; version:

.. figure:: docs/images/filtering_demo.gif
Expand Down
21 changes: 17 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@
Qgrid API Documentation
=======================

Qgrid is an `Jupyter notebook widget <https://github.com/ipython/ipywidgets>`_ which uses
`SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render `pandas <https://github.com/pydata/pandas>`_ DataFrames
as interactive grid controls.
Qgrid is a Jupyter notebook widget which uses `SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render pandas
DataFrames within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
filtering controls, as well as edit your DataFrames by double clicking cells.

Qgrid was developed for use in `Quantopian's hosted research environment
<https://www.quantopian.com/posts/qgrid-now-available-in-research-an-interactive-grid-for-sorting-and-filtering-dataframes?utm_source=readthedocs&utm_medium=web&utm_campaign=qgrid-repo>`_
and is available for use in that environment as of June 2018.


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

`qgrid demo on Quantopian <https://www.quantopian.com/clone_notebook?id=5ae9cff15230100046c3958d&utm_source=readthedocs&utm_medium=web&utm_campaign=qgrid-repo>`_
Click the badge below 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):

.. image:: https://img.shields.io/badge/launch-quantopian-red.svg?colorB=d33015
:target: https://www.quantopian.com/clone_notebook?id=5b2baee1b3d6870048620188&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo

`qgrid demo on binder <https://beta.mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?filepath=index.ipynb>`_
Click the badge below or the link above to try out qgrid in your browser. You'll see a brief loading screen and
Click the badge below or the link above to try out qgrid using binder. You'll see a brief loading screen and
then a notebook will appear:

.. image:: https://beta.mybinder.org/badge.svg
Expand Down