ipydatagrid


Nameipydatagrid JSON
Version 1.3.1 PyPI version JSON
download
home_pageNone
SummaryFast Datagrid widget for the Jupyter Notebook and JupyterLab
upload_time2024-04-25 14:59:04
maintainerNone
docs_urlNone
authorBloomberg
requires_python>=3.8
licenseNone
keywords ipython jupyter widgets
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ipydatagrid

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bloomberg/ipydatagrid/HEAD?urlpath=lab%2Ftree%2Fexamples%2FDataGrid.ipynb)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)

Fast Datagrid widget for the Jupyter Notebook and JupyterLab

## Menu

- [Usage and Examples](#Usage-and-Examples)
- [Installation](#Installation)
- [Development installation](#Development-installation)
- [Contributions](#Contributions)
- [License](#License)
- [Code of Conduct](#Code-of-Conduct)
- [Security Vulnerability reporting](#Security-Vulnerability-reporting)

## Usage and Examples

A fully-featured DataGrid interface
[![DataGrid](./static/ipydatagrid_1.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)

Highly performant and fully integrated with ipywidgets
[![DataGrid](./static/ipydatagrid_2.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)

Customize the way data is represented in your grid using a variety of renderers
[![DataGrid](./static/ipydatagrid_3.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)

Enjoy a sophisticated selections model with two-way data binding
[![DataGrid](./static/ipydatagrid_4.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/Selections.ipynb)

Conditional formatting powered by Vega Expressions
[![DataGrid](./static/ipydatagrid_5.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/ConditionalFormatting.ipynb)

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`:

```bash
pip install ipydatagrid
```

Using `conda`:

```bash
conda install -c conda-forge ipydatagrid
```

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
the nbextension:

```bash
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](https://github.com/bloomberg/bqplot) for installation instructions:

## Development installation

For a development installation:

```bash
git clone https://github.com/Bloomberg/ipydatagrid.git
cd ipydatagrid
conda install ipywidgets=8 jupyterlab
pip install -ve .
```

Enabling development install for Jupyter notebook:

```bash
jupyter nbextension install --py --symlink --sys-prefix ipydatagrid
jupyter nbextension enable --py --sys-prefix ipydatagrid
```

Enabling development install for JupyterLab:

```bash
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
```bash
jlpm watch
```
in one terminal and
```bash
jupyter lab
```
(or `jupyter notebook` or similar) in another.

## Contributions

We :heart: contributions.

Have you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?

We welcome issue reports [here](../../issues); be sure to choose the proper issue template for your issue, so that we can be sure you're providing the necessary information.

Before sending a [Pull Request](../../pulls), please make sure you read our
[Contribution Guidelines](https://github.com/bloomberg/.github/blob/master/CONTRIBUTING.md).

## License

Please read the [LICENSE](LICENSE.txt) file.

## Code of Conduct

This project has adopted a [Code of Conduct](https://github.com/bloomberg/.github/blob/master/CODE_OF_CONDUCT.md).
If you have any concerns about the Code, or behavior which you have experienced in the project, please
contact us at opensource@bloomberg.net.

## Security Vulnerability Reporting

If you believe you have identified a security vulnerability in this project, please send email to the project
team at opensource@bloomberg.net, detailing the suspected issue 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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ipydatagrid",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "IPython, Jupyter, Widgets",
    "author": "Bloomberg",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/31/fa/5100bd4d89d20f12cab2822476460dbbd51e045ab466c70b4d9048ad26b8/ipydatagrid-1.3.1.tar.gz",
    "platform": null,
    "description": "# ipydatagrid\n\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/bloomberg/ipydatagrid/HEAD?urlpath=lab%2Ftree%2Fexamples%2FDataGrid.ipynb)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://github.com/facebook/jest)\n\nFast Datagrid widget for the Jupyter Notebook and JupyterLab\n\n## Menu\n\n- [Usage and Examples](#Usage-and-Examples)\n- [Installation](#Installation)\n- [Development installation](#Development-installation)\n- [Contributions](#Contributions)\n- [License](#License)\n- [Code of Conduct](#Code-of-Conduct)\n- [Security Vulnerability reporting](#Security-Vulnerability-reporting)\n\n## Usage and Examples\n\nA fully-featured DataGrid interface\n[![DataGrid](./static/ipydatagrid_1.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)\n\nHighly performant and fully integrated with ipywidgets\n[![DataGrid](./static/ipydatagrid_2.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)\n\nCustomize the way data is represented in your grid using a variety of renderers\n[![DataGrid](./static/ipydatagrid_3.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/DataGrid.ipynb)\n\nEnjoy a sophisticated selections model with two-way data binding\n[![DataGrid](./static/ipydatagrid_4.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/Selections.ipynb)\n\nConditional formatting powered by Vega Expressions\n[![DataGrid](./static/ipydatagrid_5.gif)](https://github.com/bloomberg/ipydatagrid/blob/main/examples/ConditionalFormatting.ipynb)\n\nTutorial and example notebooks can be found in the `/examples` directory.\n\n## Installation\n\nIf using JupyterLab, `ipydatagrid` requires JupyterLab version 3 or higher.\n\nYou can install `ipydatagrid` using `pip` or `conda`:\n\nUsing `pip`:\n\n```bash\npip install ipydatagrid\n```\n\nUsing `conda`:\n\n```bash\nconda install -c conda-forge ipydatagrid\n```\n\nIf you are using Jupyter Notebook 5.2 or earlier, you may also need to enable\nthe nbextension:\n\n```bash\njupyter nbextension enable --py [--sys-prefix|--user|--system] ipydatagrid\n```\n\nNOTE: 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](https://github.com/bloomberg/bqplot) for installation instructions:\n\n## Development installation\n\nFor a development installation:\n\n```bash\ngit clone https://github.com/Bloomberg/ipydatagrid.git\ncd ipydatagrid\nconda install ipywidgets=8 jupyterlab\npip install -ve .\n```\n\nEnabling development install for Jupyter notebook:\n\n```bash\njupyter nbextension install --py --symlink --sys-prefix ipydatagrid\njupyter nbextension enable --py --sys-prefix ipydatagrid\n```\n\nEnabling development install for JupyterLab:\n\n```bash\njupyter labextension develop . --overwrite\n```\n\nNote 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.\n\nIf you are changing TypeScript code you can watch for code changes and automatically rebuild using\n```bash\njlpm watch\n```\nin one terminal and\n```bash\njupyter lab\n```\n(or `jupyter notebook` or similar) in another.\n\n## Contributions\n\nWe :heart: contributions.\n\nHave you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?\n\nWe welcome issue reports [here](../../issues); be sure to choose the proper issue template for your issue, so that we can be sure you're providing the necessary information.\n\nBefore sending a [Pull Request](../../pulls), please make sure you read our\n[Contribution Guidelines](https://github.com/bloomberg/.github/blob/master/CONTRIBUTING.md).\n\n## License\n\nPlease read the [LICENSE](LICENSE.txt) file.\n\n## Code of Conduct\n\nThis project has adopted a [Code of Conduct](https://github.com/bloomberg/.github/blob/master/CODE_OF_CONDUCT.md).\nIf you have any concerns about the Code, or behavior which you have experienced in the project, please\ncontact us at opensource@bloomberg.net.\n\n## Security Vulnerability Reporting\n\nIf you believe you have identified a security vulnerability in this project, please send email to the project\nteam at opensource@bloomberg.net, detailing the suspected issue and any methods you've found to reproduce it.\n\nPlease do NOT open an issue in the GitHub repository, as we'd prefer to keep vulnerability reports private until\nwe've had an opportunity to review and address them.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Fast Datagrid widget for the Jupyter Notebook and JupyterLab",
    "version": "1.3.1",
    "project_urls": {
        "Homepage": "https://github.com/bloomberg/ipydatagrid"
    },
    "split_keywords": [
        "ipython",
        " jupyter",
        " widgets"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b18f35396a5006b8d772976fc8a67e1eb181a368f0e6d312de9dc8ac33e8bcbf",
                "md5": "e919103725b085cf84d34bd37d0978a3",
                "sha256": "6aa6e6a20705e8884a63fc802bbfb2d588302717fe20ac4b7ba0fdac04903ad5"
            },
            "downloads": -1,
            "filename": "ipydatagrid-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e919103725b085cf84d34bd37d0978a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1926657,
            "upload_time": "2024-04-25T14:59:01",
            "upload_time_iso_8601": "2024-04-25T14:59:01.125991Z",
            "url": "https://files.pythonhosted.org/packages/b1/8f/35396a5006b8d772976fc8a67e1eb181a368f0e6d312de9dc8ac33e8bcbf/ipydatagrid-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31fa5100bd4d89d20f12cab2822476460dbbd51e045ab466c70b4d9048ad26b8",
                "md5": "8916b0545781183d43ea7761e82b4dbf",
                "sha256": "ebdb629430da47ac1ab7403aa5f1faaa53961a72eb7179917404745331bcca41"
            },
            "downloads": -1,
            "filename": "ipydatagrid-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8916b0545781183d43ea7761e82b4dbf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7093176,
            "upload_time": "2024-04-25T14:59:04",
            "upload_time_iso_8601": "2024-04-25T14:59:04.295904Z",
            "url": "https://files.pythonhosted.org/packages/31/fa/5100bd4d89d20f12cab2822476460dbbd51e045ab466c70b4d9048ad26b8/ipydatagrid-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 14:59:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bloomberg",
    "github_project": "ipydatagrid",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "ipydatagrid"
}
        
Elapsed time: 0.25124s