UpSet.js Jupyter Widget
A Jupyter Widget Library around UpSet.js.
This package is part of the UpSet.js ecosystem located at the main Github Monorepo.
Installation
You can install using pip
:
jupyter-lab 1.2.x:
pip install ipywidgets==7.5.1 upsetjs_jupyter_widget
# for notebooks
jupyter nbextension enable --sys-prefix --py upsetjs_jupyter_widget
# for lab
jupyter labextension install @jupyter-widgets/jupyterlab-manager @upsetjs_jupyter_widget
jupyter-lab 2.1.x:
# some ipywidget 8.x.x alpha vesion
pip install ipywidgets upsetjs_jupyter_widget
# for notebooks
jupyter nbextension enable --sys-prefix --py upsetjs_jupyter_widget
# for lab
jupyter labextension install @jupyter-widgets/jupyterlab-manager@3.0.0-alpha.0 @upsetjs_jupyter_widget
Usage
from ipywidgets import interact
from upsetjs_jupyter_widget import UpSetWidget
import pandas as pd
w = UpSetWidget[str]()
w.from_dict(dict(one = ['a', 'b', 'c', 'e', 'g', 'h', 'k', 'l', 'm'], two = ['a', 'b', 'd', 'e', 'j'], three = ['a', 'e', 'f', 'g', 'h', 'i', 'j', 'l', 'm']))
w
df = pd.DataFrame(dict(
one=[1, 1, 1, 0, 1, 0, 1, 1, 0, 0, 1, 1, 1],
two=[1, 1, 0, 1, 1, 0, 0, 0, 0, 1, 0, 0, 0],
three=[1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 0, 1, 1]
), index=['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm'])
w.from_dataframe(df)
w
it support the ipywidget
interact method to get notified about the user input
def selection_changed(s):
return s.name if s else None
interact(selection_changed, s=w)
see also introduction.ipynb
see also ]nbviewer-url ][binder-url]
Dev Environment
npm i -g yarn
yarn set version berry
yarn
yarn pnpify --sdk
pipenv
pipenv shell
pip install -e .
jupyter nbextension install --sys-prefix --overwrite --py upsetjs_jupyter_widget
jupyter nbextension enable --sys-prefix --py upsetjs_jupyter_widget
jupyter labextension install @jupyter-widgets/jupyterlab-manager@3.0.0-alpha.0
pipenv run jupyter labextension install .
Commands
Testing
yarn test
Linting
yarn lint
Building
yarn install
yarn build
Release
based on release-it
within the pipenv
yarn release:major
yarn release:minor
yarn release:patch
Privacy Policy
UpSet.js is a client only library. The library or any of its integrations doesn't track you or transfers your data to any server. The uploaded data in the app are stored in your browser only using IndexedDB. The Tableau extension can run in a sandbox environment prohibiting any server requests. However, as soon as you export your session within the app to an external service (e.g., Codepen.io) your data will be transferred.
License / Terms of Service
Commercial license
If you want to use Upset.js for a commercial application the commercial license is the appropriate license. Contact @sgratzl for details.
Open-source license
This library is released under the GNU AGPLv3
version to be used for private and academic purposes. In case of a commercial use, please get in touch regarding a commercial license.