Metadata-Version: 2.1
Name: jupyterlab-dash
Version: 0.1.0a2
Summary: A JupyterLab extensions for rendering Plotly Dash apps
Home-page: https://github.com/plotly/jupyterlab-dash
Author: Plotly
License: MIT
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.5.0
Description-Content-Type: text/markdown
Requires-Dist: dash
Requires-Dist: jupyter-server-proxy


# jupyterlab-dash

[![Binder](https://beta.mybinder.org/badge.svg)](https://mybinder.org/v2/gh/plotly/jupyterlab-dash/master?urlpath=lab%2Ftree%2Fnotebooks)

A JupyterLab extension for rendering Plotly Dash apps as a separate window in JupyterLab :tada:

![JupyterLab and Dash Demo Video](https://user-images.githubusercontent.com/1280389/47668836-da9f4280-db7f-11e8-8523-8663b6a5347f.gif)

**Note:**: This extension does not currently support Windows or Python 2

## Prerequisites

- JupyterLab

## Installation
The jupyterlab-dash library requires both a Python package and a JupyterLab
extension.

```
$ pip install jupyterlab-dash==0.1.0a2
$ jupyter labextension install jupyterlab-dash@0.1.0-alpha.2
```

## Development Installation

If you'd like to install jupyterlab-dash for development

```bash
git clone https://github.com/plotly/jupyterlab-dash
cd jupyterlab-dash
# Install Python package
pip install -e .
# Install Javascript dependencies
npm install # or yarn
# Build JupyterLab extension
npm run build # or yarn build
jupyter labextension link .
```

To rebuild the JupyterLab extension:

```bash
npm run build
jupyter lab build
```

To rebuild the JupyterLab extension automatically as the source changes:

```bash
# In one terminal tab, watch the jupyterlab-dash directory
npm run watch # or yarn watch
# In another terminal tab, run jupyterlab with the watch flag
jupyter lab --watch
```

## Usage

```python
import jupyterlab_dash
import dash
import dash_html_components as html

viewer = jupyterlab_dash.AppViewer()

app = dash.Dash(__name__)

app.layout = html.Div('Hello World')

viewer.show(app)
```


