ipydatagrid
Fast Datagrid widget for the Jupyter Notebook and JupyterLab
Menu
- Usage and Examples
- Installation
- Development installation
- Contributions
- License
- Code of Conduct
- Security Vulnerability reporting
Usage and Examples
A fully-featured DataGrid interface
Highly performant and fully integrated with ipywidgets
Customize the way data is represented in your grid using a variety of renderers
Enjoy a sophisticated selections model with two-way data binding
Conditional formatting powered by Vega Expressions
Tutorial and example notebooks can be found in the /examples directory.
Installation
If using JupyterLab, ipydatagrid requires JupyterLab version 3 or higher.
You can install ipydatagrid using pip or conda:
Using pip:
pip install ipydatagrid
Using conda:
conda install -c conda-forge ipydatagrid
If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:
jupyter nbextension enable --py [--sys-prefix|--user|--system] ipydatagrid
NOTE: For examples using Scales from bqplot to work as intended, the bqplot notebook and lab extensions must be installed as well. See the bqplot repo for installation instructions:
Development installation
For a development installation:
git clone https://github.com/jupyter-widgets/ipydatagrid.git
cd ipydatagrid
conda install ipywidgets=8 jupyterlab
pip install -ve .
Enabling development install for Jupyter notebook:
jupyter nbextension install --py --symlink --sys-prefix ipydatagrid
jupyter nbextension enable --py --sys-prefix ipydatagrid
Enabling development install for JupyterLab:
jupyter labextension develop . --overwrite
Note for developers: the --symlink argument on Linux or OS X allows one to modify the JavaScript code in-place. This feature is not available with Windows.
If you are changing TypeScript code you can watch for code changes and automatically rebuild using
jlpm watch
in one terminal and
jupyter lab
(or jupyter notebook or similar) in another.
Contributions
We :heart: contributions.
The ipydatagrid package is under the Jupyter-Widgets software subproject.
We appreciate contributions from the community.
We follow the IPython Contributing Guide and Jupyter Contributing Guides
License
Please read the LICENSE file.
Code of Conduct
This project has adopted a Project Jupyter's Code of Conduct.
Security Vulnerability Reporting
If you believe you have identified a security vulnerability in this project, please raise an issue to the project, detailing the suspected problem and any methods you've found to reproduce it.
Please do NOT open an issue in the GitHub repository, as we'd prefer to keep vulnerability reports private until we've had an opportunity to review and address them.
2 maintainers
Metadata
2 maintainers
Release files for ipydatagrid 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ipydatagrid-1.4.0.tar.gz | 7.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ipydatagrid-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.0 MB
Release files / ipydatagrid-1.4.0.tar.gz
| Download URL | ipydatagrid-1.4.0.tar.gz |
|---|---|
| Size | 7.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
210fc57e595a618d76c0cb28d34b1ef9716e10c64c9c5955e07e6d10aaaa12ee
|
|
BLAKE2b-256 checksum How to use checksums |
91389e8e4dafba7d3f63c2fbee2d0d661420d354ce5962ebbcfd02e54f987ee6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.21
|
Release files / ipydatagrid-1.4.0-py3-none-any.whl
| Download URL | ipydatagrid-1.4.0-py3-none-any.whl |
|---|---|
| Size | 1.9 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1d1d1804df8ca6f07dea8e8f5e0fd9f0010af1d91f1705778f19f4d94c110fcf
|
|
BLAKE2b-256 checksum How to use checksums |
ac218b81f5368120ff44b11dcdf2517fc0c2cbefda61893c4f9049c2ee838c98
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.9.21
|
