Skip to content
This repository was archived by the owner on Aug 29, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
node_modules/
*.egg-info/
.ipynb_checkpoints
*/__pycache__/*
*/__pycache__/*
lib/
12 changes: 8 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# Change Log

All notable changes to this project will be documented in this file.
This project strives to adheres to [Semantic Versioning](http://semver.org/).


## [0.1.0a2] - 2019-03-24

### Added
- conda recipe

- conda recipe

### Fixed
- Don't crash when imported in a non-IPython context

- Don't crash when imported in a non-IPython context

## [0.1.0a1] - 2019-03-24
Initial release

Initial release
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,29 @@ A JupyterLab extension for rendering Plotly Dash apps as a separate window in Ju

## Prerequisites

- JupyterLab. `jupyterlab-dash` version 0.1.0a2 has been tested and works with version 0.35.0 of `jupyterlab` on mac and linux.
- JupyterLab 1.0.0
- Dash

## Installation

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

First, install the Python package using either pip...

```
$ pip install jupyterlab-dash==0.1.0a2
$ pip install "jupyterlab>=1.0" jupyterlab-dash==0.1.0a3
```

or conda (but not both!).

```
$ conda install -c plotly jupyterlab-dash=0.1.0a2
$ conda install -c plotly -c defaults -c conda-forge "jupyterlab>=1.0" jupyterlab-dash=0.1.0a3
```

Then, install the JupyterLab extension. v6.17.1 of node works to install `jupyterlab-dash@0.1.0-alpha.2` and node 8.x.x or 10+ should also work.
Then, install the JupyterLab extension. v6.17.1 of node works, and node 8.x.x or 10+ should also work.
```
$ jupyter labextension install jupyterlab-dash@0.1.0-alpha.2
$ jupyter labextension install jupyterlab-dash@0.1.0-alpha.3
```

## Development Installation
Expand Down
9 changes: 9 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
## Check out the most recent version of master

```
$ git checkout master
$ git stash
$ git pull
```

## Update CHANGELOG and README

Update the `CHANGELOG.md` file with changes since the last release.

Update the README with the new version numbers, and push README updates.

Commit and push these updates.

## Release jupyterlab-dash to PyPI

Install `twine`

```
Expand All @@ -23,16 +26,19 @@ Update version in `jupyterlab_dash/__version__.py`.
This will be referred to as version `A.B.C` below.

Build and upload

```
$ python setup.py upload
```

## Release jupyterlab-dash to anaconda cloud

From a conda environment, install `anaconda-client`.

Run `anaconda login` from the terminal and enter the plotly channel credentials.

Build the conda package

```
$ conda build recipe/
```
Expand All @@ -41,14 +47,17 @@ Upload conda package by running the `anaconda upload ...` command displayed at
then end of the conda build command above.

## Release jupyterlab-dash to NPM

First [install yarn](https://yarnpkg.com/lang/en/docs/install/).

To publish a pre-release

```
yarn publish --access public --tag next
```

To publish a final release

```
yarn publish --access public
```
Expand Down
2 changes: 1 addition & 1 deletion jupyterlab_dash/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '0.1.0a2'
__version__ = '0.1.0a3'
7 changes: 0 additions & 7 deletions lib/index.d.ts

This file was deleted.

128 changes: 0 additions & 128 deletions lib/index.js

This file was deleted.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jupyterlab-dash",
"version": "0.1.0-alpha.2",
"version": "0.1.0-alpha.3",
"description": "A JupyterLab extensions for rendering Plotly Dash apps",
"keywords": [
"jupyter",
Expand Down Expand Up @@ -31,9 +31,9 @@
"watch": "tsc -w"
},
"dependencies": {
"@jupyterlab/application": "^0.19.1",
"@jupyterlab/console": "^0.19.1",
"@jupyterlab/notebook": "^0.19.2"
"@jupyterlab/application": "^1.0.0",
"@jupyterlab/notebook": "^1.0.0",
"@jupyterlab/console": "^1.0.0"
},
"devDependencies": {
"prettier": "^1.11.1",
Expand Down
14 changes: 7 additions & 7 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {
ILayoutRestorer,
JupyterLab,
JupyterLabPlugin
JupyterFrontEnd,
JupyterFrontEndPlugin
} from '@jupyterlab/application';

import { PageConfig } from '@jupyterlab/coreutils';
Expand Down Expand Up @@ -69,7 +69,7 @@ interface DashMessageData {
* Activate the xckd widget extension.
*/
function activate(
app: JupyterLab,
app: JupyterFrontEnd,
restorer: ILayoutRestorer,
notebooks: INotebookTracker,
consoles: IConsoleTracker
Expand Down Expand Up @@ -115,7 +115,7 @@ function activate(
function registerCommTarget(
kernel: Kernel.IKernelConnection,
widgets: Map<string, DashIFrameWidget>,
app: JupyterLab
app: JupyterFrontEnd
) {
kernel.registerCommTarget(
'dash_viewer',
Expand Down Expand Up @@ -145,7 +145,7 @@ function registerCommTarget(
// Attach the widget to the main work area
// if it's not there
console.log('Widget was not attached, adding to main area');
app.shell.addToMainArea(widget);
app.shell.add(widget, 'main');
widget.update();
} else {
// Refresh the widget
Expand All @@ -167,8 +167,8 @@ function registerCommTarget(
/**
* Initialization data for the jupyterlab-dash extension.
*/
const extension: JupyterLabPlugin<void> = {
id: 'jupyterlab-dash',
const extension: JupyterFrontEndPlugin<void> = {
id: 'jupyterlab_dash',
autoStart: true,
requires: [ILayoutRestorer, INotebookTracker, IConsoleTracker],
activate: activate
Expand Down
Loading