Skip to content

Commit

Permalink
Version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonmmease committed Oct 25, 2018
1 parent 7b79d8d commit 4332eae
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 37 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,17 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 1.0.0 - 2018-10-25
Initial stable release of the `jupyterlab-chart-editor` extension
for editing plotly charts in JupyterLab

### Added
- Extension registers itself as a mime-type renderer for files with the
`'.plotly'` and `'.plotly.json'` extension. These files can be created from
Python using the `plotly.io.write_json` function in
[plotly.py](https://github.com/plotly/plotly.py) version 3.3.0+.
- Edited charts can be saved back to the same file, or saved as a new file
using the standard "File->Save" and "File->Save As" menu commands.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,26 @@
## Development

```bash
# Clone the repo to your local environment
git clone https://github.com/plotly/jupyterlab-chart-editor.git
cd jupyterlab-chart-editor
# Install dependencies
yarn
# Build Typescript source
yarn build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
yarn build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the jupyter-renderers directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
# Watch the jupyter-renderers directory
yarn watch
```
31 changes: 2 additions & 29 deletions README.md
Expand Up @@ -8,8 +8,8 @@ A JupyterLab extension for creating and editing Plotly charts, based on https://

## Prerequisites

* JupyterLab >= 0.31.0
* plotly.py >= 2.0.0
* JupyterLab >= 0.34
* plotly.py >= 3.3.0

## Install

Expand Down Expand Up @@ -47,33 +47,6 @@ fig_styled
```
![](notebooks/scatter-styled.png)

## Development

```bash
# Clone the repo to your local environment
git clone https://github.com/plotly/jupyterlab-chart-editor.git
cd jupyterlab-chart-editor
# Install dependencies
yarn
# Build Typescript source
yarn build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
yarn build
# Rebuild JupyterLab after making any changes
jupyter lab build
```

You can watch the jupyter-renderers directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

```bash
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
# Watch the jupyter-renderers directory
yarn watch
```

## Uninstall

```bash
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "jupyterlab-chart-editor",
"version": "0.3.0",
"version": "1.0.0",
"description": "A JupyterLab extension for creating and editing Plotly charts",
"keywords": [
"jupyter",
Expand Down
14 changes: 7 additions & 7 deletions yarn.lock
Expand Up @@ -2774,9 +2774,9 @@ rc-util@^4.0.4, rc-util@^4.4.0:
prop-types "^15.5.10"
shallowequal "^0.2.2"

react-chart-editor@^0.31.1:
version "0.31.1"
resolved "https://registry.yarnpkg.com/react-chart-editor/-/react-chart-editor-0.31.1.tgz#500c3c39205b70dfdbc140ffa1c555dbd109eca1"
react-chart-editor@^0.32.1:
version "0.32.1"
resolved "https://registry.yarnpkg.com/react-chart-editor/-/react-chart-editor-0.32.1.tgz#f91198275b0aaa78dee6a78de97ad13e4ac74b54"
dependencies:
"@plotly/draft-js-export-html" "1.2.0"
classnames "^2.2.5"
Expand All @@ -2790,7 +2790,7 @@ react-chart-editor@^0.31.1:
prop-types "^15.5.10"
raf "^3.4.0"
react-color "^2.13.8"
react-colorscales "0.6.1"
react-colorscales "0.7.2"
react-dropzone "^5.0.1"
react-plotly.js "^2.2.0"
react-rangeslider "^2.2.0"
Expand All @@ -2810,9 +2810,9 @@ react-color@^2.13.8:
reactcss "^1.2.0"
tinycolor2 "^1.4.1"

react-colorscales@0.6.1:
version "0.6.1"
resolved "https://registry.yarnpkg.com/react-colorscales/-/react-colorscales-0.6.1.tgz#8a33812d257f26918eda4bcad33ede98d049c9dc"
react-colorscales@0.7.2:
version "0.7.2"
resolved "https://registry.yarnpkg.com/react-colorscales/-/react-colorscales-0.7.2.tgz#33ad471a1506dc8396fc4cadc3b5ace04e8a4da5"
dependencies:
chroma-js "^1.3.4"
rc-slider "^8.4.0"
Expand Down

0 comments on commit 4332eae

Please sign in to comment.