Package Exports

clustergrammer2

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (clustergrammer2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

clustergrammer2

An interactive WebGL heatmap Jupyter widget built using the widget-ts-cookiecutter library.

Installation

A typical installation requires the following commands to be run:

pip install clustergrammer2
jupyter nbextension enable --py [--sys-prefix|--user|--system] clustergrammer2

Or, if you use jupyterlab:

pip install clustergrammer2
jupyter labextension install @jupyter-widgets/jupyterlab-manager

jupyter nbconvert --to html notebook.ipynb

Development and Relesaing new Versions

During development run npm run watch for real time updates.

Updating versions

Update the versions in the following files

JavaScript

package.json
widget.ts

Python

_version.py
example.py
requirements.txt
_frontend.py

Webpack

Run the following commands to build the JavaScript bundle:

npm run build
npm run build:nbextension
npm run build:labextension

Publish to npm using

npm publish

These instructions are based on the release instructions from the jupyter-widgets/widget-ts-cookiecutterREADME.

Bundling the Python Package

Next, bundle the python package using

python setup.py sdist bdist_wheel

Then, upload the PYPI:

twine upload dist/*