Metadata-Version: 2.4
Name: ipyprogressivis
Version: 0.3.3
Summary: A Custom Jupyter Widget Library for Progressivis
Project-URL: Homepage, https://github.com/progressivis/ipyprogressivis
Project-URL: Documentation, https://progressivis.readthedocs.io/en/latest/notebooks.html
Project-URL: Repository, https://github.com/progressivis/ipyprogressivis.git
Author-email: "INRIA, Jean-Daniel Fekete, Christian Poli" <jean-daniel.fekete@inria.fr>
License-Expression: BSD-2-Clause
License-File: LICENSE
Keywords: IPython,Jupyter,Widgets
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: ipytablewidgets
Requires-Dist: ipywidgets<9,>=7.6
Requires-Dist: jupyter-client>=8.6.0
Requires-Dist: lz4
Requires-Dist: numpy>=1.26.4
Requires-Dist: pandas<4.0.0,>=1.0.0
Requires-Dist: pillow
Requires-Dist: sidecar>=0.7.0
Requires-Dist: traitlets>=4.3.0
Requires-Dist: traittypes>=0.0.6
Requires-Dist: vega>=4.0.0
Provides-Extra: dev
Requires-Dist: jupyterlab>=4.0.0; extra == 'dev'
Provides-Extra: progressivis
Requires-Dist: progressivis; extra == 'progressivis'
Provides-Extra: test
Requires-Dist: nbval; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest>=6.0; extra == 'test'
Provides-Extra: typing
Requires-Dist: duckdb; extra == 'typing'
Requires-Dist: ipython; extra == 'typing'
Requires-Dist: jinja2; extra == 'typing'
Requires-Dist: mypy>=1.0.1; extra == 'typing'
Requires-Dist: numpy; extra == 'typing'
Requires-Dist: pandas-stubs; extra == 'typing'
Requires-Dist: scipy-stubs; extra == 'typing'
Requires-Dist: sqlalchemy-stubs; extra == 'typing'
Requires-Dist: traits-stubs; extra == 'typing'
Requires-Dist: traittypes; extra == 'typing'
Requires-Dist: typeguard; extra == 'typing'
Requires-Dist: types-pillow; extra == 'typing'
Requires-Dist: types-pytz; extra == 'typing'
Requires-Dist: types-pyyaml; extra == 'typing'
Requires-Dist: types-requests; extra == 'typing'
Requires-Dist: types-setuptools; extra == 'typing'
Requires-Dist: types-urllib3; extra == 'typing'
Requires-Dist: typing-extensions; extra == 'typing'
Description-Content-Type: text/markdown

# IpyProgressiVis: A Custom Jupyter Widget Library for ProgressiVis

[![Python Tests](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml/badge.svg?branch=main&event=push)](https://github.com/progressivis/ipyprogressivis/actions/workflows/ui.yml)
[![Documentation Status](https://readthedocs.org/projects/progressivis/badge/?version=latest)](https://progressivis.readthedocs.io/en/latest/?badge=latest)
[![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![License](https://img.shields.io/badge/License-BSD_2--Clause-orange.svg)](https://opensource.org/licenses/BSD-2-Clause)


## Installation

See the installation instructions [provided here](https://progressivis.readthedocs.io/en/latest/install.html).

## Running demos (on your computer)

After installing `ipyprogressivis` do:

```
cd ipyprogressivis/notebooks
jupyter lab
```
then run the notebooks of your choice

<!--
### Running under Voilà

Install voilà :

$ conda install -c conda-forge voila

#### As a standalone app :

voila --enable_nbextensions=True YourNotebook.ipynb

#### As a server extension to notebook or jupyter_server

First, you have to enable the extension:

$ jupyter serverextension enable voila --sys-prefix


Then run:

$jupyter lab --VoilaConfiguration.enable_nbextensions=True

or

$jupyter notebook --VoilaConfiguration.enable_nbextensions=True

When running the Jupyter server, the Voilà app is accessible from the base url suffixed with voila

#### Using a JupyterLab extension to render a notebook with voila

Install the extension :

jupyter labextension install @jupyter-voila/jupyterlab-preview

Display the notebook with Voilà like showed here: https://user-images.githubusercontent.com/591645/59288034-1f8d6a80-8c73-11e9-860f-c3449dd3dcb5.gif
-->