Merge branch 'main' into master

Author: gvwilson

.circleci/config.yml

@@ -1,7 +1,9 @@
-Thanks for your interest in Plotly.py!
+Thanks for your interest in Plotly.py.
+Before opening an issue, please:
 
-Before opening an issue, please search for existing and closed issues :)
+-   Use the [latest version](https://github.com/plotly/plotly.py/blob/main/CHANGELOG.md) of plotly.py in your report unless not applicable.
+-   Search for existing and closed issues.
+-   Include a minimal reproducible example with bug reports.
 
-**Please** accompany bug reports with a reproducible example. Please use the [latest version](https://github.com/plotly/plotly.py/blob/master/CHANGELOG.md) of plotly.py in your report unless not applicable.
-
-Note that GitHub Issues are meant to be used for bug reports and feature requests only. Implementation or usage questions should be asked on [community.plotly.com](https://community.plotly.com/c/graphing-libraries/python/10) or on Stack Overflow (tagged [`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
+Note that GitHub Issues are meant to be used for bug reports and feature requests.
+Questions about usage should be asked on [community.plotly.com](https://community.plotly.com/c/graphing-libraries/python/10).

.flake8

@@ -1,38 +1,38 @@
 <!--
-Please uncomment this block and take a look at this checklist if your PR is making substantial changes to **documentation**/impacts files in the `doc` directory. Check all that apply to your PR, and leave the rest unchecked to discuss with your reviewer! Not all boxes must be checked for every PR :)
+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 :-).
+If your PR modifies code of the `plotly` package, we have a different checklist below.
 
-### Documentation PR
+## Documentation PR
 
-- [ ] I've [seen the `doc/README.md` file](https://github.com/plotly/plotly.py/blob/master/doc/README.md)
-- [ ] This change runs in the current version of Plotly on PyPI and targets the `doc-prod` branch OR it targets the `master` 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 in new/modified examples
-- [ ] 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` / `plotly.io as pio`
-- [ ] Data frames are always called `df`
-- [ ] `fig = <something>` call is 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=...)` in every new/modified example
-- [ ] Specific adders and updaters like `fig.add_shape` and `fig.update_xaxes` are used instead of big `fig.update_layout` calls in every new/modified example
-- [ ] `fig.show()` is at the end of each new/modified example
-- [ ] `plotly.plot()` and `plotly.iplot()` are not used in any new/modified example
-- [ ] Hex codes for colors are not used in any new/modified example in favour of [these nice ones](https://github.com/plotly/plotly.py/issues/2192)
+- [ ] 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/master/contributing.md) and understand the structure of the package. In particular, if my PR modifies code of `plotly.graph_objects`, my modifications concern the `codegen` files and not generated files.
-- [ ] I have added tests (if submitting a new feature or correcting a bug) or
-  modified existing tests.
-- [ ] For a new feature, I have added documentation examples in an existing or
-  new tutorial notebook (please see the doc checklist as well).
-- [ ] I have added a CHANGELOG entry if fixing/changing/adding anything substantial.
-- [ ] For a new feature or a change in behaviour, I have updated the relevant docstrings in the code to describe the feature or behaviour (please see the doc checklist as well).
+- [ ] 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.
 
 -->

.gitattributes

@@ -0,0 +1,66 @@
+on: push
+
+jobs:
+  check-js-build:
+    name: Check JS 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: Install Node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '22'
+
+    - name: Copy current files to a temporary directory
+      run: |
+        cp -R 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
+        cd js
+        npm ci
+        npm run build
+    - 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
+
+        # 5. Final check
+        if [ -s content_diff.txt ] || [ -s package_json_diff.txt ]; then
+        echo "❌ Build artifacts differ:"
+        echo "--- Unexpected diffs ---"
+        cat content_diff.txt
+        echo "--- Unexpected package.json diffs ---"
+        cat package_json_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)."
+        fi
+
+    - name: Store the build artifacts from plotly/labextension
+      uses: actions/upload-artifact@v4
+      if: failure()
+      with:
+        name: labextension
+        path: plotly/labextension

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,71 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on:
+  workflow_dispatch
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    
+    - name: Install Node
+      uses: actions/setup-node@v2
+      with:
+        node-version: '22'
+
+    - name: Install npm dependencies
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sh
+        uv venv
+        source .venv/bin/activate
+        uv pip install jupyter
+        cd js
+        npm ci --verbose
+        npm run build --verbose
+
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/plotly
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

.github/pull_request_template.md

@@ -1,7 +1,7 @@
 0
 0.html
 iframe_figures/
-packages/python/plotly/plotly/tests/test_orca/images/linux/failed/
+tests/test_orca/images/linux/failed/
 
 *.egg-info
 
@@ -15,6 +15,7 @@ doc/python/raw.githubusercontent.com/
 
 # Don't ignore dataset files
 !*.csv.gz
+!*.geojson.gz
 
 *.ipynb
 
@@ -48,9 +49,9 @@ plotly.egg-info/
 # macOS utility file
 **/.DS_Store
 
-plotly/tests/test_orca/images/*/failed
-plotly/tests/test_orca/images/*/tmp
-/plotly-package/plotly/tests/test_core/test_offline/plotly.min.js
+tests/test_orca/images/*/failed
+tests/test_orca/images/*/tmp
+tests/test_core/test_offline/plotly.min.js
 temp-plot.html
 .vscode
 doc/python/.ipynb_checkpoints
@@ -59,10 +60,6 @@ doc/.ipynb_checkpoints
 tags
 doc/check-or-enforce-order.py
 
-packages/javascript/jupyterlab-plotly/lib/
-packages/python/plotly/jupyterlab_plotly/labextension/
-packages/python/plotly/jupyterlab_plotly/nbextension/index.js*
-packages/python/plotly/plotly/package_data/widgetbundle.js
-
-test/percy/*.html
-test/percy/pandas2/*.html
+tests/percy/*.html
+tests/percy/pandas2/*.html
+test_path.png