Merge branch 'doc-prod' into bar-chart-data-formats

Author: nicolaskruchten

.gitignore

@@ -46,3 +46,4 @@ temp-plot.html
 doc/python/.ipynb_checkpoints
 doc/python/.mapbox_token
 doc/.ipynb_checkpoints
+doc/check-or-enforce-order.py

CHANGELOG.md

@@ -2,6 +2,57 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.10.0] - unreleased
+
+
+## [4.9.1] - unreleased
+
+
+## [4.9.0] - 2020-07-16
+
+### Added
+
+- Added image export support using [Kaleido](https://github.com/plotly/Kaleido). The image export backend can be configured using the new `engine` argument to `plotly.io.to_image` and `plotly.io.write_image`. The `engine` argument may be set to `"kaleido"`, `"orca"`, or `"auto"`. The default is `engine="auto"`, in which case the Kaleido backend is enabled if the `kaleido` package from PyPI is installed, otherwise Orca is used. ([#2613](https://github.com/plotly/plotly.py/pull/2613)).
+- `plotly.express.timeline()` added as an official alternative to `plotly.figure_factories.create_gantt()` ([#2626](https://github.com/plotly/plotly.py/pull/2626))
+- `create_hexbin_mapbox()` added to Figure Factories, with thanks to [@RenaudLN](https://github.com/RenaudLN) for the impressive contribution!
+- `facet_row_spacing` and `facet_col_spacing` added to Plotly Express cartesian 2d functions ([#2614](https://github.com/plotly/plotly.py/pull/2614))
+- `base` added to Plotly Express `bar` and `bar_polar` functions ([#2626](https://github.com/plotly/plotly.py/pull/2626))
+- `px.NO_COLOR` constant to override wide-form color assignment in Plotly Express ([#2614](https://github.com/plotly/plotly.py/pull/2614))
+
+### Fixed
+
+- trendline traces are now of type `scattergl` when `render_mode="webgl"` in Plotly Express ([#2614](https://github.com/plotly/plotly.py/pull/2614))
+- regression from 4.8.1 whereby `"parent"` was not accepted as part of `path` for `px.sunburst()` and `px.treemap()` ([#2640](https://github.com/plotly/plotly.py/pull/2640))
+- `create_dendrogram()` figure factory now works correctly with `scipy` 1.5.1 ([#2627](https://github.com/plotly/plotly.py/pull/2627))
+
+### Updated
+
+- Updated Plotly.js to version 1.54.6. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/v1.54.6/CHANGELOG.md) for more information.
+- Added all cartesian-2d Plotly Express functions, plus `imshow`, to Pandas backend with `kind` option ([#2541](https://github.com/plotly/plotly.py/pull/2541))
+- `plotly.express.imshow` now uses data frame index and columns names and values to populate axis parameters by default ([#2539](https://github.com/plotly/plotly.py/pull/2539))
+- Javascript extensions are now build using Node 12, and have an updated `package-lock.json` with many fewer security warnings ([#2636](https://github.com/plotly/plotly.py/pull/2636))
+
+
+## [4.8.2] - 2020-06-26
+
+### Updated
+
+- Updated Plotly.js to version 1.54.5. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/v1.54.5/CHANGELOG.md) for more information.
+- `add_traces()` now accepts bare `int`-like values for `rows`/`cols` as well as lists thereof ([#2546](https://github.com/plotly/plotly.py/pull/2546)), with thanks to [@MCBoarder289](https://github.com/MCBoarder289) for the contribution!
+
+### Fixed
+
+- `row`/`col` now accept `int`-like values, not strictly `int` values ([#2451](https://github.com/plotly/plotly.py/pull/2451)), with thanks to [@MCBoarder289](https://github.com/MCBoarder289) for the contribution!
+- Fixed special cases with `px.sunburst` and `px.treemap` with `path` input ([#2524](https://github.com/plotly/plotly.py/pull/2524))
+- Fixed bug in `hover_data` argument of `px` functions, when the column name is changed with labels and `hover_data` is a dictionary setting up a specific format for the hover data ([#2544](https://github.com/plotly/plotly.py/pull/2544)).
+- Made the Plotly Express `trendline` argument more robust and made it work with datetime `x` values ([#2554](https://github.com/plotly/plotly.py/pull/2554))
+- Fixed bug in `px.sunburst` and `px.treemap`: when the `color` and `values` arguments correspond to the same column, a different aggregation function has to be used for the two arguments ([#2591](https://github.com/plotly/plotly.py/pull/2591))
+- Plotly Express wide mode now accepts mixed integer and float columns ([#2598](https://github.com/plotly/plotly.py/pull/2598))
+- Plotly Express `range_(x|y)` should not impact the unlinked range of marginal subplots ([#2600](https://github.com/plotly/plotly.py/pull/2600))
+- `px.line` now sets `line_group=<variable>` in wide mode by default ([#2599](https://github.com/plotly/plotly.py/pull/2599))
+- Corrected some regex warnings ([#2577](https://github.com/plotly/plotly.py/pull/2577)), with thanks to [@georgevdd](https://github.com/georgevdd) for the contribution!
+
+
 ## [4.8.1] - 2020-05-28
 
 ### Fixed

README.md

@@ -33,7 +33,7 @@
 
 ## Quickstart
 
-`pip install plotly==4.8.1`
+`pip install plotly==4.9.0`
 
 Inside [Jupyter notebook](https://jupyter.org/install) (installable with `pip install "notebook>=5.3" "ipywidgets>=7.2"`):
 
@@ -82,13 +82,13 @@ 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==4.8.1
+pip install plotly==4.9.0
 ```
 
 or conda.
 
 ```
-conda install -c plotly plotly=4.8.1
+conda install -c plotly plotly=4.9.0
 ```
 
 ### Jupyter Notebook Support
@@ -125,20 +125,43 @@ Then run the following commands to install the required JupyterLab extensions (n
 
 ```
 # Basic JupyterLab renderer support
-jupyter labextension install jupyterlab-plotly@4.8.1
+jupyter labextension install jupyterlab-plotly@4.9.0
 
 # OPTIONAL: Jupyter widgets extension for FigureWidget support
-jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.8.1
+jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.9.0
 ```
 
 Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
 
 ### Static Image Export
 
-plotly.py supports static image export using the `to_image` and `write_image`
-functions in the `plotly.io` package. This functionality requires the
-installation of the plotly [orca](https://github.com/plotly/orca) command line utility and the
-[`psutil`](https://github.com/giampaolo/psutil) Python package.
+plotly.py supports [static image export](https://plotly.com/python/static-image-export/),
+using the either the [`kaleido`](https://github.com/plotly/Kaleido)
+package (recommended, supported as of `plotly` version 4.9) or the [orca](https://github.com/plotly/orca)
+command line utility (legacy as of `plotly` version 4.9).
+
+#### Kaleido
+
+The [`kaleido`](https://github.com/plotly/Kaleido) package has no dependencies and can be installed
+using pip...
+
+```
+$ pip install -U kaleido
+```
+
+or conda.
+
+```
+$ conda install -c plotly python-kaleido
+```
+
+#### Orca
+
+While Kaleido is now the recommended image export approach because it is easier to install
+and more widely compatible, [static image export](https://plotly.com/python/static-image-export/)
+can also be supported
+by the legacy [orca](https://github.com/plotly/orca) command line utility and the
+ [`psutil`](https://github.com/giampaolo/psutil) Python package.
 
 These dependencies can both be installed using conda:
 
@@ -154,13 +177,6 @@ pip install psutil
 
 and orca can be installed according to the instructions in the [orca README](https://github.com/plotly/orca).
 
-#### Troubleshooting
-
-##### Wrong Executable found
-
-If you get an error message stating that the `orca` executable that was found is not valid, this may be because another executable with the same name was found on your system. Please specify the complete path to the Plotly-Orca binary that you downloaded (for instance in the Miniconda folder) with the following command:
-
-`plotly.io.orca.config.executable = '/home/your_name/miniconda3/bin/orca'`
 
 ### Extended Geo Support
 

binder/requirements.txt

@@ -1,5 +1,5 @@
 jupytext
-plotly==4.8.1
+plotly==4.9.0
 jupyter
 notebook
 pandas==1.0.3
@@ -15,3 +15,4 @@ scikit-image
 datashader
 pyarrow
 cufflinks==0.17.3
+kaleido

contributing.md

@@ -64,7 +64,7 @@ the structure of the code and of the repository.
   https://github.com/plotly/plotly.py/issues/1965. If you have writing skills,
   the wording of existing examples can also be improved in places.
 
-Contributing code or documentation are not the only way to contribute! You can
+Contributing code or documentation is not the only way to contribute! You can
 also contribute to the project by
 
 - reporting bugs (see below).
@@ -128,30 +128,45 @@ conda activate plotly-dev
 [conda-env]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands
 [virtualenv]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
 
-### Install requirements
+### Install requirements - (Non-Windows)
+```bash
+(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
+(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
+ ```   
+### Install requirements - (Windows + Conda)
+Because Windows requires Visual Studio libraries to compile some of the optional dependencies, follow these steps to
+complete installation and avoid gdal-config errors.
 
-    $ pip install -r packages/python/plotly/requirements.txt
-    $ pip install -r packages/python/plotly/optional-requirements.txt
+```bash
+(plotly_dev) $ pip install -r packages/python/plotly/requirements.txt
+(plotly_dev) $ conda install fiona
+(plotly_dev) $ pip install -r packages/python/plotly/optional-requirements.txt
+```
 
 ### Editable install of plotly packages
-
-    $ pip install -e packages/python/plotly/
-    $ pip install -e packages/python/chart-studio/
-    $ pip install -e packages/python/plotly-geo/
-
+```bash
+(plotly_dev) $ pip install -e packages/python/plotly/
+(plotly_dev) $ pip install -e packages/python/chart-studio/
+(plotly_dev) $ pip install -e packages/python/plotly-geo/
+```
 This will ensure that the installed packages links to your local development
 directory, meaning that all changes you make reflect directly in your
-environment (don't forget to restart the Jupyter kernel though!).
+environment (don't forget to restart the Jupyter kernel though!). For more
+information see the
+[`setuptools`](https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode)
+and
+[`pip`](https://pip.pypa.io/en/stable/reference/pip_install/#install-editable)
+documentation on _development mode_.
 
 ### ipywidgets development install
 
 Run the following commands in your virtual environment to use the
 development version of `FigureWidget`,
-
-    $ jupyter nbextension enable --py widgetsnbextension
-    $ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
-    $ jupyter nbextension enable --py --sys-prefix plotlywidget
-
+```bash
+(plotly_dev) $ jupyter nbextension enable --py widgetsnbextension
+(plotly_dev) $ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
+(plotly_dev) $ jupyter nbextension enable --py --sys-prefix plotlywidget
+```
 To make plotly plots show up in JupyterLab, you also need to [install the plotly jupyterlab extensions][plotly-jl].
 
 [plotly-jl]: https://plot.ly/python/getting-started/#jupyterlab-support-python-35

doc/apidoc/conf.py

@@ -28,7 +28,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "4.8.1"
+release = "4.9.0"
 
 
 # -- General configuration ---------------------------------------------------

doc/apidoc/plotly.express.rst

@@ -28,6 +28,7 @@ plotly's high-level API for rapid figure generation. ::
     line_geo
     area
     bar
+    timeline
     bar_polar
     violin
     box

doc/apidoc/plotly.figure_factory.rst

@@ -18,6 +18,7 @@
    create_distplot
    create_facet_grid
    create_gantt
+   create_hexbin_mapbox
    create_ohlc
    create_quiver
    create_scatterplotmatrix

doc/apidoc/plotly.graph_objects.rst

@@ -43,6 +43,7 @@ Simple Traces
    Bar
    Pie
    Heatmap
+   Heatmapgl
    Image
    Contour
    Table

doc/python/2D-Histogram.md

@@ -96,7 +96,7 @@ fig.show()
 
 ### 2D Histograms with Graph Objects
 
-To build this kind of plot without using Plotly Express, we can use the `go.Histogram2d` class.
+To build this kind of figure using [graph objects](/python/graph-objects/) without using Plotly Express, we can use the `go.Histogram2d` class.
 
 
 ### 2D Histogram of a Bivariate Normal Distribution ###
@@ -236,4 +236,4 @@ fig.show()
 ```
 
 #### Reference
-See https://plotly.com/python/reference/#histogram2d for more information and chart attribute options!
+See https://plotly.com/python/reference/#histogram2d for more information and chart attribute options!