Merge branch 'main' into fix/broken-license-link-readme

Author: LiamConnors

.github/pull_request_template.md

@@ -1,38 +1,30 @@
 <!--
-Please uncomment this block and fill in this checklist if your PR makes substantial changes to documentation in the `doc` directory.
-Not all boxes must be checked for every PR:
-check those that apply to your PR and leave the rest unchecked to discuss with your reviewer.
-
-If your PR modifies code of the `plotly` package, we have a different checklist below.
-
-## Documentation PR
-
-- [ ] I have seen the [`doc/README.md`](https://github.com/plotly/plotly.py/blob/main/doc/README.md) file.
-- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `main` branch.
-- [ ] If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible.
-- [ ] Every new/modified example has a descriptive title and motivating sentence or paragraph.
-- [ ] Every new/modified example is independently runnable.
-- [ ] Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized.
-- [ ] Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible.
-- [ ] The random seed is set if using randomly-generated data.
-- [ ] New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets.
-- [ ] Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations.
-- [ ] Imports are `plotly.graph_objects as go`, `plotly.express as px`, and/or `plotly.io as pio`.
-- [ ] Data frames are always called `df`.
-- [ ] `fig = <something>` is called high up in each new/modified example (either `px.<something>` or `make_subplots` or `go.Figure`).
-- [ ] Liberal use is made of `fig.add_*` and `fig.update_*` rather than `go.Figure(data=..., layout=...)`.
-- [ ] Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls.
-- [ ] `fig.show()` is at the end of each example.
-- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any example.
-- [ ] Named colors are used instead of hex codes wherever possible.
-- [ ] Code blocks are marked with `&#96;&#96;&#96;python`.
-
-## Code PR
-
-- [ ] I have read through the [contributing notes](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the code generator and *not* the generated files.
-- [ ] I have added tests or modified existing tests.
-- [ ] For a new feature, I have added documentation examples (please see the doc checklist as well).
-- [ ] I have added a CHANGELOG entry if changing anything substantial.
-- [ ] For a new feature or a change in behavior, I have updated the relevant docstrings in the code.
+Thank you for your contribution to plotly.py!
 
+Please complete each section below.
 -->
+
+### Link to issue
+<!-- Link to the issue closed by this PR. If the issue doesn't exist yet, create it. -->
+
+Closes #(issue number)
+
+### Description of change
+<!-- Provide a clear 1-2 sentence description of what this PR does. -->
+
+### Demo
+
+<!-- Include screenshots or screen recordings of this PR in action. -->
+
+### Testing strategy
+
+<!-- Provide 1-2 sentences explaining tests added or changed by this PR. If testing changes are not needed, explain why. -->
+
+### Additional information (optional)
+
+<!-- Include any additional context, background, or explanation which doesn't fit in the previous sections. -->
+
+### Guidelines
+
+- [ ] I have reviewed the [pull request guidelines](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md#opening-a-pull-request) and the [Code of Conduct](https://github.com/plotly/plotly.py/blob/main/CODE_OF_CONDUCT.md) and confirm that this PR follows them.
+- [ ] I have added an entry to the [changelog](https://github.com/plotly/plotly.py/blob/main/CHANGELOG.md) if needed (not required for documentation PRs).

.github/workflows/check-js-build.yml

@@ -2,61 +2,60 @@ on: push
 
 jobs:
   check-js-build:
-    name: Check JS build artifacts
+    name: Check JS version number and build artifacts
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
         python-version: "3.x"
-        
+
+    - name: Check that version number for JS project matches version number for Python project
+      run: |
+        PYPROJECT_PATH="pyproject.toml"
+        PKGJSON_PATH="js/package.json"
+        PYPROJECT_VERSION=$(awk -F'"' '/^version/ {print $2; exit}' $PYPROJECT_PATH)
+        JSPROJECT_VERSION=$(cat $PKGJSON_PATH | jq -r '.version')
+        if [ "$PYPROJECT_VERSION" != "$JSPROJECT_VERSION" ]; then
+          echo "❌ Version number $JSPROJECT_VERSION in $PKGJSON_PATH does not match version number $PYPROJECT_VERSION in $PYPROJECT_PATH"
+          exit 1
+        else
+          echo "✅ Version number $JSPROJECT_VERSION in $PKGJSON_PATH matches version number $PYPROJECT_VERSION in $PYPROJECT_PATH"
+        fi
     - name: Install Node
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v4
       with:
         node-version: '22'
 
     - name: Copy current files to a temporary directory
       run: |
-        cp -R plotly/labextension/ plotly/labextension-tmp/
+        mv plotly/labextension/ plotly/labextension-tmp/
 
     - name: Install dependencies and build
       run: |
         curl -LsSf https://astral.sh/uv/install.sh | sh
         uv venv
         source .venv/bin/activate
-        uv pip install jupyter
+        uv pip install jupyterlab
         cd js
         npm ci
         npm run build
         npm ls
     - name: Check JupyterLab build artifacts
       run: |
-        # 1. Hash contents of all static files, sort by content hash
-        find plotly/labextension/static -type f -exec sha256sum {} \; | awk '{print $1}' | sort > new_hashes.txt
-        find plotly/labextension-tmp/static -type f -exec sha256sum {} \; | awk '{print $1}' | sort > old_hashes.txt
-
-        # 2. Compare the sorted content hashes
-        diff old_hashes.txt new_hashes.txt > content_diff.txt
-
-        # Remove the "load" line from both package.json files before comparing
-        grep -v '"load": "static/' plotly/labextension/package.json > pkg1.json
-        grep -v '"load": "static/' plotly/labextension-tmp/package.json > pkg2.json
-
-        # Compare stripped versions
-        diff pkg1.json pkg2.json > package_json_diff.txt
+        # Compare the plotly/labextension and plotly/labextension-tmp directories
+        diff -r --brief plotly/labextension/ plotly/labextension-tmp/ > labextension_diff.txt
 
-        # 5. Final check
-        if [ -s content_diff.txt ] || [ -s package_json_diff.txt ]; then
+        # Check for differences
+        if [ -s labextension_diff.txt ]; then
         echo "❌ Build artifacts differ:"
         echo "--- Unexpected diffs ---"
-        cat content_diff.txt
-        echo "--- Unexpected package.json diffs ---"
-        cat package_json_diff.txt
+        cat labextension_diff.txt
         echo "Please replace the 'plotly/labextension' directory with the artifacts of this CI run."
         exit 1
         else
-        echo "✅ Build artifacts match expected output (ignoring known 'load' hash in package.json)."
+        echo "✅ Build artifacts match expected output"
         fi
 
     - name: Store the build artifacts from plotly/labextension

CHANGELOG.md

@@ -4,6 +4,27 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+### Added
+- Add `facet_row` support to `px.imshow` for creating subplots along an additional dimension [[#5445](https://github.com/plotly/plotly.py/pull/5445)]
+
+### Fixed
+- Update `numpy.percentile` syntax to stop using deprecated alias [[5483](https://github.com/plotly/plotly.py/pull/5483)], with thanks to @Mr-Neutr0n for the contribution!
+  - `numpy` with a version less than 1.22 is no longer supported.
+
+## [6.6.0] - 2026-03-02
+
+### Fixed
+- Remove unneeded `type="text/javascript"` attribute from `<style>` tag [[#5454](https://github.com/plotly/plotly.py/pull/5454)], with thanks to @hannob for the contribution!
+- Remove global warning format side effect [[#5481](https://github.com/plotly/plotly.py/pull/5481)], with thanks to @emmanuel-ferdman for the contribution!
+- Fix spurious engine deprecation warning in write_image [[#5517](https://github.com/plotly/plotly.py/pull/5517)], with thanks to @mosh3eb for the contribution!
+
+### Updated
+- Update plotly.js from version 3.3.1 to version 3.4.0. See the plotly.js [release notes](https://github.com/plotly/plotly.js/releases/tag/v3.4.0) for more information. [[#5527](https://github.com/plotly/plotly.py/pull/5527)]. Notable changes include:
+  - Add support for clicking legend titles to toggle visibility of all traces in legend [[#7698](https://github.com/plotly/plotly.js/pull/7698)]
+  - Add support for shapes to reference multiple axes [[#7666](https://github.com/plotly/plotly.js/pull/7666)]
+  - Add support for dashed marker lines in scatter plots [[#7673](https://github.com/plotly/plotly.js/pull/7673)]
+  - Increase axis autorange when bar charts have outside text labels, to avoid labels being clipped [[#7675](https://github.com/plotly/plotly.js/pull/7675)]
+
 ## [6.5.2] - 2026-01-14
 
 ### Fixed
@@ -780,7 +801,7 @@ Items in this section may be considered backwards-incompatible changes for the p
     - if either `x` or `y` (but not both) may now be provided as a list of column references into `data_frame` or columns of data, in which case the imputed data frame will be treated as "wide" data and `melt()`ed internally before applying the usual mapping rules, with function-specific defaults.
     - if neither `x` nor `y` is provided but `data_frame` is, the data frame will be treated as "wide" with defaults depending on the value of `orientation` (and `orientation` has accordingly been added to `scatter`, `line`, `density_heatmap`, and `density_contour` for this purpose). Previously this would have resulted in an empty figure.
     - if both `x` and `y` are provided to `histogram`, and if `x`, `y` and `z` are provided to `density_heatmap` or `density_contour`, then `histfunc` now defaults to `sum` so as to avoid ignoring the provided data, and to cause `histogram` and `bar` to behave more similarly.
-    - `violinmode`, `boxmode` and `stripmode` now default to `overlay` if `x` (`y`) in in `v` (`h`) orientation is also mapped to `color`, to avoid strange spacing issues with the previous default of `group` in all cases.
+    - `violinmode`, `boxmode` and `stripmode` now default to `overlay` if `x` (`y`) in `v` (`h`) orientation is also mapped to `color`, to avoid strange spacing issues with the previous default of `group` in all cases.
 - The Plotly Express arguments `color_discrete_map`, `symbol_map` and `line_dash_map` now accept the string `"identity"` which causes the corresponding input data to be used as-is rather than mapped into `color_discrete_sequence`, `symbol_sequence` or `line_dash_sequence`, respectively. ([#2336](https://github.com/plotly/plotly.py/pull/2336))
 - Plotly Express now accepts `px.Constant` or `px.Range` objects in the place of column references so as to express constant or increasing integer values. ([#2336](https://github.com/plotly/plotly.py/pull/2336))
 

CITATION.cff

@@ -1,15 +1,15 @@
-cff-version: 1.2.0
-message: "If you use this software, please cite it as below."
-authors:
-- family-names: "Kruchten"
-  given-names: "Nicolas"
-  orcid: https://orcid.org/0000-0002-8416-789X
-- family-names: "Seier"
-  given-names: "Andrew"
-- family-names: "Parmer"
-  given-names: "Chris"
-title: "An interactive, open-source, and browser-based graphing library for Python"
-version: 6.5.2
-doi: 10.5281/zenodo.14503524
-date-released: 2026-01-14
-url: "https://github.com/plotly/plotly.py"
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Kruchten"
+  given-names: "Nicolas"
+  orcid: https://orcid.org/0000-0002-8416-789X
+- family-names: "Seier"
+  given-names: "Andrew"
+- family-names: "Parmer"
+  given-names: "Chris"
+title: "An interactive, open-source, and browser-based graphing library for Python"
+version: 6.6.0
+doi: 10.5281/zenodo.14503524
+date-released: 2026-03-02
+url: "https://github.com/plotly/plotly.py"

CONTRIBUTING.md

@@ -171,6 +171,42 @@ and create your pull request.
 > Please do _not_ commit changes to `uv.lock`
 > unless you have added, removed, or changed dependencies in `pyproject.toml`.
 
+## Opening a pull request
+
+When creating your pull request, please follow the guidelines below. 
+
+### Code pull request
+
+- *Make sure you have reviewed the full [contributing notes (this file)](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md) and understand the structure of the package.*
+- If your PR modifies code of `plotly.graph_objects`, the modifications should be made to the code generator, *not* the generated files.
+- You have added tests or modified existing tests, as needed.
+- For a new feature, you have added documentation examples (please see the doc checklist as well).
+- You have added a CHANGELOG entry if changing anything substantial.
+- For a new feature or a change in behavior, you have updated the relevant docstrings in the code.
+
+### Documentation pull request
+
+- *Make sure you have reviewed the [`doc/README.md`](https://github.com/plotly/plotly.py/blob/main/doc/README.md) file.*
+- This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `main` branch.
+- If this PR modifies the first example in a page or adds a new one, it is a `px` example if at all possible.
+- Every new/modified example has a descriptive title and motivating sentence or paragraph.
+- Every new/modified example is independently runnable.
+- Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized.
+- Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible.
+- The random seed is set if using randomly-generated data.
+- New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets.
+- Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations.
+- Imports are `plotly.graph_objects as go`, `plotly.express as px`, and/or `plotly.io as pio`.
+- Data frames are always called `df`.
+- `fig = <something>` is called high up in each new/modified example (either `px.<something>` or `make_subplots` or `go.Figure`).
+- Liberal use is made of `fig.add_*` and `fig.update_*` rather than `go.Figure(data=..., layout=...)`.
+- Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls.
+- `fig.show()` is at the end of each example.
+- `plotly.plot()` and `plotly.iplot()` are not used in any example.
+- Named colors are used instead of hex codes wherever possible.
+- Code blocks are marked with `&#96;&#96;&#96;python`.
+
+
 ### Testing
 
 We use [pytest](https://docs.pytest.org/) for managing and running tests.
@@ -271,3 +307,18 @@ You can then run the following command
 ```bash
 python commands.py updateplotlyjsdev --local /path/to/your/plotly.js/
 ```
+
+## Documentation for `commands.py`
+
+`commands.py` serves as an entry point for utilities to help with plotly.py development.
+
+Usage: `python commands.py <subcommand> <args>`
+
+| Subcommand | Purpose |
+|------------|---------|
+| `codegen [--noformat]` | Regenerate Python files according to `plot-schema.json`.`--noformat` skips formatter step. |
+| `lint` | Lint all Python code in `plotly/`. |
+| `format` | Format all Python code in `plotly/`. |
+| `updateplotlyjs` | Update `plotly.min.js` and `plot-schema.json` to match the `plotly.js` version specified in `js/package.json`. Then, run codegen to regenerate the Python files. |
+| `updateplotlyjsdev [--devrepo REPONAME --devbranch BRANCHNAME] \| [--local PATH]` | Update `plot-schema.json` and `plotly.min.js` to match the version in the provided plotly.js repo name and branch name, OR local path. Then, run codegen to regenerate the Python files. |
+| `bumpversion X.Y.Z` | Update the plotly.py version number to X.Y.Z across all files where it needs to be updated. |

MANIFEST.in

@@ -7,10 +7,11 @@ This is the release process for releasing plotly.py version `X.Y.Z`, including c
 
 ### Finalize changelog
 
-Review the contents of `CHANGELOG.md`. We try to follow
+Review the contents of `CHANGELOG.md` under the **Unreleased** header. We try to follow
 the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines.
-Make sure the changelog includes the version being published at the top, along
-with the expected publication date.
+
+**Note: You don't need to update the header itself with the new version number,
+as that will be done automatically as part of the next step.**
 
 Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`
 labels for all changes to plotly.py.  If the version of plotly.js has
@@ -22,16 +23,24 @@ a link to the plotly.js CHANGELOG.
 
 **Create a release branch `git checkout -b release-X.Y.Z` _from the tip of `origin/main`_.**
 
-- Manually update the versions to `X.Y.Z` in the files specified below:
+- Ensure that you have `npm` and `uv` installed in your environment
+
+- Run the command `python commands.py bumpversion X.Y.Z`, which will update the version to X.Y.Z in the following places
   - `pyproject.toml`
-    - update version
-  - `CHANGELOG.md`
-    - update version and release date
-    - finalize changelog entries according to instructions above
+  - `uv.lock`
+  - `js/package.json`
+  - `js/package-lock.json`
+  - `CHANGELOG.md` (Adds a new header for X.Y.Z above the unreleased items)
   - `CITATION.cff`
-    - update version and release date
-- Run `uv lock` to update the version number in the `uv.lock` file (do not update manually)
-- Commit and push your changes to the release branch:
+
+- Run `git diff` and ensure the above files were all updated correctly.
+  - Note: The current date is used as the release date in `CHANGELOG.md` and `CITATION.cff`. If you want to use a different date, edit these files manually afterward.
+  - If the bumpversion command failed for any reason, you can update the versions yourself by doing the following:
+    - Manually update the version number (and release date, as needed) in `pyproject.toml`, `CHANGELOG.md` and `CITATION.cff`
+    - Run `npm version X.Y.Z` to update `js/package.json` and `js/package-lock.json`
+    - Run `uv lock` to update `uv.lock`
+
+- Commit and push the changed files to the release branch:
     ```sh
     $ git add -u
     $ git commit -m "version changes for vX.Y.Z"

RELEASE.md

@@ -878,7 +878,7 @@ def __init__(
 
     def description(self):
         desc = """\
-    The '{plotly_name}' property is a integer and may be specified as:""".format(
+    The '{plotly_name}' property is an integer and may be specified as:""".format(
             plotly_name=self.plotly_name
         )