Skip to content

Commit 73272de

Browse files
committed
DOCS-quantopian#22: Remove dependencies and demo notebook sections
Signed-off-by: Richard Lin <richard.lin.047@berkeley.edu>
1 parent df0c4cb commit 73272de

File tree

1 file changed

+0
-42
lines changed

1 file changed

+0
-42
lines changed

README.rst

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -74,48 +74,6 @@ Qgrid now displays multi-indexed DataFrames with some of the index cells merged
7474
:target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png
7575
:width: 100px
7676

77-
Dependencies
78-
------------
79-
80-
Qgrid runs on `Python 2 or 3 <https://www.python.org/downloads/>`_. You'll also need
81-
`pip <https://pypi.python.org/pypi/pip>`_ for the installation steps below.
82-
83-
Qgrid depends on the following three Python packages:
84-
85-
`Jupyter notebook <https://github.com/jupyter/notebook>`_
86-
This is the interactive Python environment in which qgrid runs.
87-
88-
`ipywidgets <https://github.com/ipython/ipywidgets>`_
89-
In order for Jupyter notebooks to be able to run widgets, you have to also install this ipywidgets package.
90-
It's maintained by the Jupyter organization, the same people who created Jupyter notebook.
91-
92-
`Pandas <http://pandas.pydata.org/>`_
93-
A powerful data analysis / manipulation library for Python. Qgrid requires that the data to be rendered as an
94-
interactive grid be provided in the form of a pandas DataFrame.
95-
96-
These are listed in `requirements.txt <https://github.com/quantopian/qgrid/blob/master/requirements.txt>`_
97-
and will be automatically installed (if necessary) when qgrid is installed via pip.
98-
99-
Running the demo notebooks locally
100-
----------------------------------
101-
102-
There are a couple of demo notebooks in the `qgrid-notebooks <https://github.com/quantopian/qgrid-notebooks/>`_ repository
103-
which will help you get familiar with the functionality that qgrid provides. Here are the steps to clone the
104-
qgrid-notebooks repository and open a demo notebook:
105-
106-
#. Install qgrid by following the instructions in the `Installation`_ section above, if you haven't already
107-
108-
#. Clone the qgrid-notebooks repository from GitHub::
109-
110-
git clone https://github.com/quantopian/qgrid-notebooks.git
111-
112-
#. Install the dev requirements for the repository and start the notebook server::
113-
114-
cd qgrid-notebooks
115-
pip install -r requirements_dev.txt
116-
jupyter notebook
117-
118-
#. Click on one of the two notebooks (`index.ipynb <https://github.com/quantopian/qgrid-notebooks/blob/master/index.ipynb>`_ or `experimental.ipynb <https://github.com/quantopian/qgrid-notebooks/blob/master/experimental.ipynb>`_) that you see listed in the notebook UI in your browser.
11977

12078
Running from source & testing your changes
12179
------------------------------------------

0 commit comments

Comments
 (0)