Skip to main content

Dash support for the Jupyter notebook interface

Project description

Jupyter Dash

Binder

This library makes it easy to develop Plotly Dash apps interactively from within Jupyter environments (e.g. classic Notebook, JupyterLab, Visual Studio Code notebooks, nteract, PyCharm notebooks, etc.).

jupterlab example

See the notebooks/getting_started.ipynb for more information and example usage.

Installation

You can install the JupyterDash Python package using pip...

$ pip install jupyter-dash

or conda

$ conda install -c conda-forge -c plotly jupyter-dash

JupyterLab support

When used in JupyterLab, JupyterDash depends on the jupyterlab-dash JupyterLab extension, which requires JupyterLab version 2.0 or above.

This extension is included with the Python package, but in order to activate it JupyterLab must be rebuilt. JupyterLab should automatically produce a popup dialog asking for permission to rebuild, but the rebuild can also be performed manually from the command line using:

$ jupyter lab build

To check that the extension is installed properly, call jupyter labextension list.

Colab support

As of version 0.3.0, JupyterDash works in Colab with no additional configuration. Just install jupyter-dash using pip in a Colab notebook cell

!pip install jupyter-dash

Features

To learn more about the features of JupyterDash, check out the announcement post.

Development

To develop JupyterDash, first create and activate a virtual environment using virtualenv or conda.

Then clone the repository and change directory to the repository root:

$ git clone https://github.com/plotly/jupyter-dash.git
$ cd jupyter-dash

Then install the dependencies:

$ pip install -r requirements.txt -r requirements-dev.txt 

Then install the Python package in editable mode. Note: this will require nodejs to be installed.

$ pip install -e .

Then install the classic notebook extension in development mode:

$ jupyter nbextension install --sys-prefix --symlink --py jupyter_dash
$ jupyter nbextension enable --py jupyter_dash

Then install the JupyterLab extension in development mode:

$ jupyter labextension link extensions/jupyterlab

For release, build the JupyterLab extension to bundle with the Python package (see RELEASE.md for the full process):

$ python setup.py build_js

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-dash-0.4.2.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

jupyter_dash-0.4.2-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyter-dash-0.4.2.tar.gz.

File metadata

  • Download URL: jupyter-dash-0.4.2.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5

File hashes

Hashes for jupyter-dash-0.4.2.tar.gz
Algorithm Hash digest
SHA256 d546c7c25a2867c14c95a48af0ad572803b26915a5ce6052158c9dede4dbf48c
MD5 91f7fa23a63cece012e0f5bb8866b634
BLAKE2b-256 d6491f99474c4d22c7bc05a96ee9d1301ed5eda6aee27f0bce0d9761f3759e49

See more details on using hashes here.

Provenance

File details

Details for the file jupyter_dash-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: jupyter_dash-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.5

File hashes

Hashes for jupyter_dash-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b07d90ccf38d4dfb04efd630a2b2627f367b79fa4296ee3912d0c4e21e73e9b2
MD5 cd632d8932636c06fbb145f0ecabdc4f
BLAKE2b-256 38622c51aeb18c6d765c03c911e4d70f029ccb9de1a991d88cf30e362d2433c9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page