Skip to content

Commit 077bf76

Browse files
richardlin047richardlin047
committed
DOCS-quantopian#22: Remove unnecessary content from README
Signed-off-by: Richard Lin <richard.lin.047@berkeley.edu>
1 parent c2875b1 commit 077bf76

File tree

1 file changed

+3
-93
lines changed

1 file changed

+3
-93
lines changed

‎README.rst‎

Lines changed: 3 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,11 @@ Modin-spreadsheet is a Jupyter notebook widget which uses `SlickGrid <https://gi
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-
Qgrid was developed for use in `Quantopian's hosted research environment
15-
<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>`_
16-
and is available for use in that environment as of June 2018.
17-
Quantopian also offers a `fully managed service for professionals <https://factset.quantopian.com>`_
18-
that includes Qgrid, Zipline, Alphalens, Pyfolio, FactSet data, and more.
14+
TODO: Add about history
1915

20-
Announcements: Qgrid Webinar
21-
----------------------------
22-
Qgrid author Tim Shawver recently did a live webinar about Qgrid, and the recording of the webinar is `now available on YouTube <https://www.youtube.com/watch?v=AsJJpgwIX0Q>`_.
16+
Modin-spreadsheet is forked from Qgrid, which was developed by Quantopian. To learn more about Qgrid, here is an `introduction on YouTube <https://www.youtube.com/watch?v=AsJJpgwIX0Q>`_.
2317

24-
This talk will be interesting both for people that are new to Qgrid, as well as longtime fans that are interested in learning more about the project.
25-
26-
Demo
27-
----
28-
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):
29-
30-
.. image:: https://img.shields.io/badge/launch-quantopian-red.svg?colorB=d33015
31-
:target: https://www.quantopian.com/clone_notebook?id=5b2baee1b3d6870048620188&utm_source=github&utm_medium=web&utm_campaign=qgrid-repo
32-
|
33-
Click the badge below to try out qgrid using binder:
34-
35-
.. image:: https://beta.mybinder.org/badge.svg
36-
:target: https://mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?filepath=index.ipynb
37-
|
38-
Click the following badge to try out qgrid in Jupyterlab, also using binder:
39-
40-
.. image:: https://mybinder.org/badge.svg
41-
:target: https://mybinder.org/v2/gh/quantopian/qgrid-notebooks/master?urlpath=lab
42-
|
43-
*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.*
44-
45-
*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.*
46-
47-
For people who would rather not go to another page to try out modin-spreadsheet for real, here's the tldr; version:
18+
Here is an example of the Modin-spreadsheet widget in action.
4819

4920
.. figure:: docs/images/filtering_demo.gif
5021
:align: left
@@ -68,33 +39,6 @@ Installing with pip::
6839
# only required if you have not enabled the ipywidgets nbextension yet
6940
jupyter nbextension enable --py --sys-prefix widgetsnbextension
7041

71-
Installing with conda::
72-
73-
# only required if you have not added conda-forge to your channels yet
74-
conda config --add channels conda-forge
75-
76-
conda install modin_spreadsheet
77-
78-
Jupyterlab Installation
79-
-----------------------
80-
81-
First, go through the normal installation steps above as you normally would when using modin-spreadsheet in the notebook.
82-
If you haven't already install jupyterlab and enabled ipywidgets, do that first with the following lines::
83-
84-
pip install jupyterlab
85-
jupyter labextension install @jupyter-widgets/jupyterlab-manager
86-
87-
Install the modin_spreadsheet jupyterlab extension and enable::
88-
89-
jupyter labextension install modin_spreadsheet
90-
91-
At this point if you run jupyter lab normally with the 'jupyter lab' command, you should be
92-
able to use modin-spreadsheet in notebooks as you normally would.
93-
94-
*Please Note: Jupyterlab support has been tested with jupyterlab 0.30.5 and jupyterlab-manager 0.31.3, so if you're
95-
having trouble, try installing those versions. Feel free to file an issue if you find that modin-spreadsheet isn't working
96-
with a newer version of either dependency.*
97-
9842
What's New
9943
----------
10044
**Column-specific options (as of 1.1.0)**:
@@ -152,22 +96,6 @@ Qgrid depends on the following three Python packages:
15296
These are listed in `requirements.txt <https://github.com/quantopian/qgrid/blob/master/requirements.txt>`_
15397
and will be automatically installed (if necessary) when qgrid is installed via pip.
15498

155-
Compatibility
156-
-------------
157-
158-
================= =========================== ============================== ==============================
159-
qgrid IPython / Jupyter notebook ipywidgets Jupyterlab
160-
================= =========================== ============================== ==============================
161-
0.2.0 2.x N/A N/A
162-
0.3.x 3.x N/A N/A
163-
0.3.x 4.0 4.0.x N/A
164-
0.3.x 4.1 4.1.x N/A
165-
0.3.2 4.2 5.x N/A
166-
0.3.3 5.x 6.x N/A
167-
1.0.x 5.x 7.x 0.30.x
168-
================= =========================== ============================== ==============================
169-
170-
17199
Running the demo notebooks locally
172100
----------------------------------
173101

@@ -295,24 +223,6 @@ to use in conjunction with other visualizations (in this case, a couple of ``Out
295223

296224
A brief demo showing modin-spreadsheet's events api
297225

298-
Continuing to use qgrid 0.3.3
299-
-----------------------------
300-
If you're looking for the installation and usage instructions for qgrid 0.3.3 and the sample notebook that goes
301-
along with it, please see the `qgrid 0.3.3 tag <https://github.com/quantopian/qgrid/tree/v0.3.3>`_ in this
302-
repository. The installation steps will be mostly the same. The only difference is that when you run "pip install"
303-
you'll have to explicitly specify that you want to install version 0.3.3, like this::
304-
305-
pip install qgrid==0.3.3
306-
307-
If you're looking for the API docs, you can find them on the
308-
`readthedocs page for qgrid 0.3.3 <http://qgrid.readthedocs.io/en/v0.3.3/>`_.
309-
310-
If you're looking for the demo notebook for 0.3.3, it's still availabe `in nbviewer
311-
<http://nbviewer.jupyter.org/gist/TimShawver/8fcef51dd3c222ed25306c002ab89b60>`_.
312-
313-
Qgrid 0.3.3 is not compatible with ipywidgets 7, so if you need support for ipywidgets 7, you'll need to use
314-
qgrid 1.0.
315-
316226
Contributing
317227
------------
318228
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. See the

0 commit comments

Comments
 (0)