diff --git a/CHANGELOG.md b/CHANGELOG.md index 779d9dd0c72..1c8406ebf8a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,53 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [3.2.1] - 2018-09-14 +This is a patch release that fixes a few bugs and reintroduces a few +version 2 features that were not supported in version 3. + +The bundled version of plotly.js remains at 1.40.1 + +### JupyterLab Versions +For use with JupyterLab, the following versions of the following packages +must be installed: + + - Python Packages + - plotly==3.2.1 + - ipywidgets>=7.2 + - notebook>=5.3 + - jupyterlab==0.34 + + - JupyterLab Extensions + - plotlywidget@0.3.0 + - @jupyter-widgets/jupyterlab-manager@0.37 + - @jupyterlab/plotly-extension@0.17 + +### Added + - An optional `skip_invalid` argument has been added to the `Figure` and + `FigureWidget` constructors. By default, `skip_invalid` is `False` and invalid + figure properties will result in an exception (this is identical to the + previous behavior). When `skip_invalid` is set to `True`, invalid properties + will instead be silently ignored. This argument replaces the `_raise` + argument that was available in version 2, and makes it possible to import + figure definitions from different plotly versions, where incompatible + properties are ignored rather than causing an exception. + - A `to_ordered_dict` method has been added to the `Figure` and `FigureWidget` + classes. This method returns a representation of the figure as a nested + structure of `OrdererdDict` and `list` instances where the keys in each + `OrderedDict` are sorted alphabetically. This method replaces the + `get_ordered` method that was available in version 2, and makes it possible + to traverse the nested structure of a figure in a deterministic order. + +### Fixed + - Pandas `Series` and `Index` objects storing `datetime` values were + incorrectly cast to numeric arrays + ([plotly/plotly.py#1160](https://github.com/plotly/plotly.py/issues/1160), + [plotly/plotly.py#1163](https://github.com/plotly/plotly.py/pull/1163)) + - Numpy arrays with `uint64` datatype caused a `FigureWidget` error, + and no figure was displayed + ([plotly/plotly.py#1155](https://github.com/plotly/plotly.py/issues/1155), + [plotly/plotly.py#1163](https://github.com/plotly/plotly.py/pull/1163)) + ## [3.2.0] - 2018-09-05 This release introduces the long-anticipated ability to programmatically export figures as high quality static images in both raster and vector diff --git a/README.md b/README.md index be50e916968..d7585094dcf 100644 --- a/README.md +++ b/README.md @@ -54,12 +54,12 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is plotly.py may be installed using pip... ``` -pip install plotly==3.2.0 +pip install plotly==3.2.1 ``` or conda. ``` -conda install -c plotly plotly=3.2.0 +conda install -c plotly plotly=3.2.1 ``` ### Jupyter Notebook Support @@ -70,13 +70,13 @@ packages using pip... pip install "notebook>=5.3" "ipywidgets>=7.2" ``` -of conda. +or conda. ``` conda install "notebook>=5.3" "ipywidgets>=7.2" ``` -### JupyterLab Support +### JupyterLab Support (Python 3.5+) For use in JupyterLab, install the `jupyterlab` and `ipywidgets` packages using pip... @@ -84,7 +84,7 @@ packages using pip... pip install jupyterlab==0.34 "ipywidgets>=7.2" ``` -of conda. +or conda. ``` conda install jupyterlab=0.34 "ipywidgets>=7.2" diff --git a/plotly/version.py b/plotly/version.py index b5dae6a2cd9..7ecda9cad1f 100644 --- a/plotly/version.py +++ b/plotly/version.py @@ -1,4 +1,4 @@ -__version__ = '3.2.0' +__version__ = '3.2.1' __frontend_version__ = '^0.3.0'