From 73272de2caad1dc4fde1ccbdcafe8729a15861c9 Mon Sep 17 00:00:00 2001 From: Richard Lin Date: Thu, 25 Mar 2021 19:18:59 -0400 Subject: [PATCH] DOCS-#22: Remove dependencies and demo notebook sections Signed-off-by: Richard Lin --- README.rst | 42 ------------------------------------------ 1 file changed, 42 deletions(-) diff --git a/README.rst b/README.rst index 0ea66f0d..7b0a6e74 100644 --- a/README.rst +++ b/README.rst @@ -74,48 +74,6 @@ Qgrid now displays multi-indexed DataFrames with some of the index cells merged :target: https://s3.amazonaws.com/quantopian-forums/pipeline_with_qgrid.png :width: 100px -Dependencies ------------- - -Qgrid runs on `Python 2 or 3 `_. You'll also need -`pip `_ for the installation steps below. - -Qgrid depends on the following three Python packages: - - `Jupyter notebook `_ - This is the interactive Python environment in which qgrid runs. - - `ipywidgets `_ - In order for Jupyter notebooks to be able to run widgets, you have to also install this ipywidgets package. - It's maintained by the Jupyter organization, the same people who created Jupyter notebook. - - `Pandas `_ - A powerful data analysis / manipulation library for Python. Qgrid requires that the data to be rendered as an - interactive grid be provided in the form of a pandas DataFrame. - -These are listed in `requirements.txt `_ -and will be automatically installed (if necessary) when qgrid is installed via pip. - -Running the demo notebooks locally ----------------------------------- - -There are a couple of demo notebooks in the `qgrid-notebooks `_ repository -which will help you get familiar with the functionality that qgrid provides. Here are the steps to clone the -qgrid-notebooks repository and open a demo notebook: - -#. Install qgrid by following the instructions in the `Installation`_ section above, if you haven't already - -#. Clone the qgrid-notebooks repository from GitHub:: - - git clone https://github.com/quantopian/qgrid-notebooks.git - -#. Install the dev requirements for the repository and start the notebook server:: - - cd qgrid-notebooks - pip install -r requirements_dev.txt - jupyter notebook - -#. Click on one of the two notebooks (`index.ipynb `_ or `experimental.ipynb `_) that you see listed in the notebook UI in your browser. Running from source & testing your changes ------------------------------------------