This is a fork of qgrid and it has been created for the sole purpose of supporting Jupyterlab 3. However, over time, it may be used for more than that.
qgrid is licensed under the Apache License, Version 2.0. We did our best to track all modifiaction we did to the original source code to comply with the Apache License standard. If you find we could improve our modification tracking, please do let us know how. We're happy to get your feedback.
- Clone the repository from GitHub and cd into the top-level directory:
git clone https://github.com/8080labs/ipyslickgrids.git
cd ipyslickgrids- Install the current project in editable mode:
pip install -e .- Install the node packages that ipyslickgrids depends on and build ipyslickgrids's javascript using webpack:
cd js && npm install .- Install and enable ipyslickgrids's javascript in your local jupyter notebook environment:
jupyter nbextension install --py --symlink --sys-prefix ipyslickgrids && jupyter nbextension enable --py --sys-prefix ipyslickgrids- If desired, install the labextension:
jupyter labextension link js/- Run the notebook as you normally would with the following command:
jupyter notebookIf the code you need to change is in ipyslickgrids's python code, then restart the kernel of the notebook you're in and rerun any ipyslickgrids cells to see your changes take effect.
If the code you need to change is in ipyslickgrids's javascript or css code, repeat step 3 to rebuild ipyslickgrids's npm package, then refresh the browser tab where you're viewing your notebook to see your changes take effect.
There is a small python test suite which can be run locally by running the command pytest in the root folder of the repository.