sthagen · sthagen · Mar 12, 2020 · Feb 5, 2020 · Feb 25, 2020 · Feb 25, 2020
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -409,7 +409,7 @@ jobs:
               cd ../../../doc
             fi
             echo 'export PATH="/home/circleci/project/doc/node_modules/.bin:$PATH"' >> $BASH_ENV
-            sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2
+            sudo apt-get install -y poppler-utils libxtst6 xvfb libgtk2.0-0 libgconf-2-4 libnss3 libasound2 rename
             cd ..
 
       - save_cache:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,23 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.5.4] - 2020-03-11
+
+### Updated
+
+- The documentation of the API https://plot.ly/python-api-reference/ now
+  documents the full API [#2243](https://github.com/plotly/plotly.py/pull/2243)
+- New documentation examples for facets [#2235](https://github.com/plotly/plotly.py/pull/2235), legend [#2227](https://github.com/plotly/plotly.py/pull/2227), subplots [#2226](https://github.com/plotly/plotly.py/pull/2226), axes [#2234](https://github.com/plotly/plotly.py/pull/2234) and histograms [#2242](https://github.com/plotly/plotly.py/pull/2242). 
+  Thanks to [@SylwiaOliwia2](https://github.com/@SylwiaOliwia2) for all these great
+  examples!
+
+### Fixed
+
+- Jupyterlab extension now compatible with both Jupyterlab 1.2 and 2.0 [#2261](https://github.com/plotly/plotly.py/pull/2261) with thanks to [@consideRatio](https://github.com/consideRatio) for the contribution!
+- Fixed a bug when using boolean values for the color argument of px functions [#2127](https://github.com/plotly/plotly.py/pull/2127)
+- Corrected import bug which was occuring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
+- Fixed python 3.8 syntax warning [#2262](https://github.com/plotly/plotly.py/pull/2262), with thanks to [@sgn](https://github.com/sgn) for the contribution!
+
 ## [4.5.3] - 2020-03-05
 
 ### Updated

diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@
 
 ## Quickstart
 
-`pip install plotly==4.5.3`
+`pip install plotly==4.5.4`
 
 Inside [Jupyter notebook](https://jupyter.org/install) (installable with `pip install "notebook>=5.3" "ipywidgets>=7.2"`):
 
@@ -75,13 +75,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.5.3
+pip install plotly==4.5.4
 ```
 
 or conda.
 
 ```
-conda install -c plotly plotly=4.5.3
+conda install -c plotly plotly=4.5.4
 ```
 
 ### Jupyter Notebook Support
@@ -128,10 +128,10 @@ set NODE_OPTIONS=--max-old-space-size=4096
 jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
 
 # FigureWidget support
-jupyter labextension install plotlywidget@1.5.3 --no-build
+jupyter labextension install plotlywidget@1.5.4 --no-build
 
 # and jupyterlab renderer support
-jupyter labextension install jupyterlab-plotly@1.5.3 --no-build
+jupyter labextension install jupyterlab-plotly@1.5.4 --no-build
 
 # Build extensions (must be done to activate extensions since --no-build is used above)
 jupyter lab build

diff --git a/binder/requirements.txt b/binder/requirements.txt
@@ -1,5 +1,5 @@
 jupytext
-plotly==4.5.1
+plotly==4.5.4
 jupyter
 notebook
 pandas==0.23.0

diff --git a/contributing.md b/contributing.md
@@ -1,6 +1,6 @@
 # Contributing
 
-Thank you for contributing to plotly.py! 
+Thank you for contributing to plotly.py!
 
 ## Code of Conduct
 
@@ -271,10 +271,12 @@ specified below.
    + Update `__frontend_version__` to `^A.B.C-rc.1` (Note the `^` prefix)
  - `packages/javascript/plotlywidget/package.json`
    + Update `"version"` to `A.B.C-rc.1`
-   + Run `npm install && npm run build`
+   + Ensure you're using `node` version 8 and `npm` version 6 to minimize diffs to `package-lock.json`
+   + Run `rm -rf node_modules && npm install && npm run build`
  - `packages/javascript/jupyterlab-plotly/package.json`
    + Update `"version"` to `A.B.C-rc.1`
-   + Run `npm install && npm run build`
+   + Ensure you're using `node` version 8 and `npm` version 6 to minimize diffs to `package-lock.json`
+   + Run `rm -rf node_modules && npm install && npm run build`
 
  2) Commit the changes
 
@@ -375,7 +377,9 @@ Update CHANGELOG with release date and update README with final versions.
 In the conda installation instructions, be sure to change the
 "-c plotly/label/test" argument to "-c plotly"
 
-Commit updates.
+Update the doc/python/getting-started.md file with the same version numbers.
+
+Commit Changelog, README and getting-started updates.
 
 ### Finalize versions
 When no problems are identified in the release candidate, remove the
@@ -385,12 +389,15 @@ release candidate suffix from the following version strings:
    + Update `__frontend_version__` to `^A.B.C` (Note the `^` prefix)
  - `packages/javascript/plotlywidget/package.json`
    + Update `"version"` to `A.B.C`
-   + Run `npm install && npm run build`
+   + Ensure you're using `node` version 8 and `npm` version 6 to minimize diffs to `package-lock.json`
+   + Run `rm -rf node_modules && npm install && npm run build`
  - `packages/javascript/jupyterlab-plotly/package.json`
    + Update `"version"` to `A.B.C`
-   + Run `npm install && npm run build`
-
-Commit and push to the release branch.
+   + Ensure you're using `node` version 8 and `npm` version 6 to minimize diffs to `package-lock.json`
+   + Run `rm -rf node_modules && npm install && npm run build`
+ - Run `git diff` and ensure that only the files you modified and the build artifacts have changed
+ - Ensure that the diff in `package-lock.json` seems sane
+ - Commit and push to the release branch.
 
 ### Merge release into master
 Make sure the integration tests are passing on the release branch, then merge

diff --git a/doc/apidoc/Makefile b/doc/apidoc/Makefile
@@ -15,5 +15,14 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+# For sphinx-apidoc the first positional path is the module to document
+# then all the other ones are paths to exclude for the doc generation
 %: Makefile
+	sphinx-apidoc -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
+	sed -i 's/graph_objs/graph_objects/g' _build/html/*.html 
+	sed -i 's/graph_objs/graph_objects/g' _build/html/*.inv 
+	sed -i 's/graph_objs/graph_objects/g' _build/html/*.js 
+	sed -i 's/graph_objs/graph_objects/g' _build/html/generated/*.html 
+	sed -i 's/graph_objs/graph_objects/g' _build/html/generated/generated/*.html
diff --git a/doc/apidoc/_templates/class.rst b/doc/apidoc/_templates/class.rst
diff --git a/doc/apidoc/_templates/trace.rst b/doc/apidoc/_templates/trace.rst
@@ -10,7 +10,6 @@
    .. automethod:: __init__
    {% endblock %}
 
-
 :mod:`{{module}}`.{{objname.lower()}}
 {{ underline }}================================
 
@@ -20,6 +19,7 @@
 
 .. automodule:: plotly.graph_objects.{{ objname.lower() }}
    :members:
+   :undoc-members:
 
 
 .. raw:: html

diff --git a/doc/apidoc/conf.py b/doc/apidoc/conf.py
@@ -28,7 +28,7 @@
 # The short X.Y version
 version = ""
 # The full version, including alpha/beta/rc tags
-release = "4.5.1"
+release = "4.5.4"
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/doc/apidoc/plotly.graph_objects.rst b/doc/apidoc/plotly.graph_objects.rst
@@ -3,7 +3,7 @@
 `plotly.graph_objects`: low-level interface to figures, traces and layout
 =========================================
 
-.. currentmodule:: plotly.graph_objects
+.. currentmodule:: plotly.graph_objs
 
 :mod:`plotly.graph_objects` contains the building blocks of plotly :class:`Figure`: traces
 (:class:`Scatter`, :class:`Bar`, ...) and :class:`Layout`
@@ -31,7 +31,6 @@ Layout
    Layout
 
 
-
 Simple charts
 --------------
 

diff --git a/doc/python/getting-started.md b/doc/python/getting-started.md
@@ -49,13 +49,13 @@ Thanks to deep integration with the [orca](https://github.com/plotly/orca) image
 plotly.py may be installed using pip...
 
 ```
-$ pip install plotly==4.5.3
+$ pip install plotly==4.5.4
 ```
 
 or conda.
 
 ```
-$ conda install -c plotly plotly=4.5.3
+$ conda install -c plotly plotly=4.5.4
 ```
 
 This package contains everything you need to write figures to standalone HTML files.
@@ -144,10 +144,10 @@ set NODE_OPTIONS=--max-old-space-size=4096
 jupyter labextension install @jupyter-widgets/jupyterlab-manager@1.1 --no-build
 
 # jupyterlab renderer support
-jupyter labextension install jupyterlab-plotly@1.5.3 --no-build
+jupyter labextension install jupyterlab-plotly@1.5.4 --no-build
 
 # FigureWidget support
-jupyter labextension install plotlywidget@1.5.3 --no-build
+jupyter labextension install plotlywidget@1.5.4 --no-build
 
 # Build extensions (must be done to activate extensions since --no-build is used above)
 jupyter lab build

diff --git a/doc/python/histograms.md b/doc/python/histograms.md
@@ -69,6 +69,23 @@ fig = px.histogram(df, x="total_bill", nbins=20)
 fig.show()
 ```
 
+#### Accessing the counts (y-axis) values
+
+JavaScript calculates the y-axis (count) values on the fly in the browser, so it's not accessible in the `fig`. You can manually calculate it using `np.histogram`.
+
+```python
+import plotly.express as px
+import numpy as np
+
+df = px.data.tips()
+# create the bins
+counts, bins = np.histogram(df.total_bill, bins=range(0, 60, 5))
+bins = 0.5 * (bins[:-1] + bins[1:])
+
+fig = px.bar(x=bins, y=counts, labels={'x':'total_bill', 'y':'count'})
+fig.show()
+```
+
 #### Type of normalization
 
 The default mode is to represent the count of samples in each bin. With the `histnorm` argument, it is also possible to represent the percentage or fraction of samples in each bin (`histnorm='percent'` or `probability`), or a density histogram (the sum of bars is equal to 100, `density`), or a probability density histogram (sum equal to 1, `probability density`).

diff --git a/doc/python/sunburst-charts.md b/doc/python/sunburst-charts.md
@@ -326,7 +326,7 @@ def build_hierarchical_dataframe(df, levels, value_column, color_columns=None):
     df_all_trees = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
     for i, level in enumerate(levels):
         df_tree = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
-        dfg = df.groupby(levels[i:]).sum(numerical_only=True)
+        dfg = df.groupby(levels[i:]).sum()
         dfg = dfg.reset_index()
         df_tree['id'] = dfg[level].copy()
         if i < len(levels) - 1:

diff --git a/doc/python/treemaps.md b/doc/python/treemaps.md
@@ -278,7 +278,7 @@ def build_hierarchical_dataframe(df, levels, value_column, color_columns=None):
     df_all_trees = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
     for i, level in enumerate(levels):
         df_tree = pd.DataFrame(columns=['id', 'parent', 'value', 'color'])
-        dfg = df.groupby(levels[i:]).sum(numerical_only=True)
+        dfg = df.groupby(levels[i:]).sum()
         dfg = dfg.reset_index()
         df_tree['id'] = dfg[level].copy()
         if i < len(levels) - 1:

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,4 +1,4 @@
-plotly==4.5.1
+plotly==4.5.4
 jupytext==1.1.1
 jupyter
 notebook

diff --git a/packages/javascript/jupyterlab-plotly/package-lock.json b/packages/javascript/jupyterlab-plotly/package-lock.json
diff --git a/packages/javascript/jupyterlab-plotly/package.json b/packages/javascript/jupyterlab-plotly/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-plotly",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "The plotly JupyterLab extension",
   "author": "The plotly.py team",
   "license": "MIT",

diff --git a/packages/javascript/plotlywidget/package-lock.json b/packages/javascript/plotlywidget/package-lock.json
diff --git a/packages/javascript/plotlywidget/package.json b/packages/javascript/plotlywidget/package.json
@@ -1,6 +1,6 @@
 {
   "name": "plotlywidget",
-  "version": "1.5.3",
+  "version": "1.5.4",
   "description": "The plotly JupyterLab extension",
   "author": "The plotly.py team",
   "license": "MIT",
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "plotly.js": "^1.52.2",
-    "@jupyter-widgets/base": "^2.0.0",
+    "@jupyter-widgets/base": "^2.0.0 || ^3.0.0",
     "lodash": "^4.17.4"
   },
   "jupyterlab": {

diff --git a/packages/python/plotly/_plotly_utils/basevalidators.py b/packages/python/plotly/_plotly_utils/basevalidators.py
@@ -2421,7 +2421,7 @@ def description(self):
             """\
     The '{plotly_name}' property is an instance of {class_str}
     that may be specified as:
-      - An instance of {module_str}.{class_str}
+      - An instance of :class:`{module_str}.{class_str}`
       - A dict of string/value properties that will be passed
         to the {class_str} constructor
 

diff --git a/packages/python/plotly/_plotly_utils/utils.py b/packages/python/plotly/_plotly_utils/utils.py
@@ -211,7 +211,7 @@ class NotEncodable(Exception):
 def iso_to_plotly_time_string(iso_string):
     """Remove timezone info and replace 'T' delimeter with ' ' (ws)."""
     # make sure we don't send timezone info to plotly
-    if (iso_string.split("-")[:3] is "00:00") or (iso_string.split("+")[0] is "00:00"):
+    if (iso_string.split("-")[:3] == "00:00") or (iso_string.split("+")[0] == "00:00"):
         raise Exception(
             "Plotly won't accept timestrings with timezone info.\n"
             "All timestrings are assumed to be in UTC."

diff --git a/packages/python/plotly/codegen/__init__.py b/packages/python/plotly/codegen/__init__.py
@@ -259,9 +259,9 @@ def perform_codegen():
     from distutils.version import LooseVersion
     if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
         from ._figurewidget import FigureWidget
+        __all__.append("FigureWidget")
     del LooseVersion
     del ipywidgets
-    __all__.append("FigureWidget")
 except ImportError:
     pass
 """

diff --git a/packages/python/plotly/codegen/datatypes.py b/packages/python/plotly/codegen/datatypes.py
@@ -293,7 +293,7 @@ def __init__(self"""
         (
             f"arg",
             f"dict of properties compatible with this constructor "
-            f"or an instance of {class_name}",
+            f"or an instance of :class:`{class_name}`",
         )
     ]
 
@@ -321,7 +321,7 @@ def __init__(self"""
             raise ValueError(\"\"\"\\
 The first argument to the {class_name} 
 constructor must be a dict or 
-an instance of {class_name}\"\"\")
+an instance of :class:`{class_name}`\"\"\")
 
         # Handle skip_invalid
         # -------------------

diff --git a/packages/python/plotly/codegen/figure.py b/packages/python/plotly/codegen/figure.py
@@ -94,7 +94,7 @@ class {fig_classname}({base_classname}):\n"""
     def __init__(self, data=None, layout=None,
                  frames=None, skip_invalid=False, **kwargs):
         \"\"\"
-        Create a new {fig_classname} instance
+        Create a new :class:{fig_classname} instance
 
         Parameters
         ----------

diff --git a/packages/python/plotly/codegen/utils.py b/packages/python/plotly/codegen/utils.py
@@ -941,7 +941,7 @@ def get_constructor_params_docstring(self, indent=12):
                         f"{subtype_node.name_datatype_class}"
                     )
                 subtype_description = (
-                    f"A tuple of {class_name} instances or "
+                    f"A tuple of :class:`{class_name}` instances or "
                     "dicts with compatible properties"
                 )
             elif subtype_node.is_compound:
@@ -958,7 +958,7 @@ def get_constructor_params_docstring(self, indent=12):
                     )
 
                 subtype_description = (
-                    f"{class_name} instance or dict with compatible properties"
+                    f":class:`{class_name}` instance or dict with compatible properties"
                 )
             else:
                 subtype_description = ""