Merge main to doc-prod and make docs changes live

.circleci/config.yml

@@ -25,8 +25,8 @@ commands:
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install .
-            uv pip install -r ./test_requirements/requirements_core.txt
+            uv lock --check
+            uv sync --extra dev_core
       - run:
           name: List installed packages and python version
           command: |
@@ -56,11 +56,7 @@ commands:
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install .
-            uv pip install -r ./test_requirements/requirements_optional.txt
-            cd js
-            npm ci
-            npm run build
+            uv sync --extra dev_optional
 
       - when:
           condition:
@@ -73,8 +69,7 @@ commands:
                 name: Install pandas
                 command: |
                   source .venv/bin/activate
-                  uv pip install pip
-                  python -m pip install pandas==<<parameters.pandas_version>> numpy==<<parameters.numpy_version>>
+                  uv pip install pandas==<<parameters.pandas_version>> numpy==<<parameters.numpy_version>>
 
       - run:
           name: Test core
@@ -117,6 +112,34 @@ commands:
             source .venv/bin/activate
             python -m pytest -x test_init/test_lazy_imports.py
 
+  test_io_kaleido_v0:
+    steps:
+      - checkout
+      - browser-tools/install-chrome
+      - browser-tools/install-chromedriver
+      - run:
+          name: Install dependencies
+          command: |
+            curl -LsSf https://astral.sh/uv/install.sh | sh
+            uv venv
+            source .venv/bin/activate
+            uv sync --extra dev_optional
+            # Install Kaleido v0 instead of the v1 specified in requirements_optional.txt
+            uv pip uninstall kaleido
+            uv pip install kaleido==0.2.1
+      - run:
+          name: List installed packages and python version
+          command: |
+            source .venv/bin/activate
+            uv pip list
+            python --version
+      - run:
+          name: Test plotly.io image output with Kaleido v0
+          command: |
+            source .venv/bin/activate
+            python -m pytest tests/test_optional/test_kaleido
+          no_output_timeout: 20m
+
 jobs:
   check-code-formatting:
     docker:
@@ -125,16 +148,16 @@ jobs:
     steps:
       - checkout
       - run:
-          name: Install black
+          name: Install ruff
           command: |
-            python -m venv venv
-            . venv/bin/activate
-            pip install black==22.3.0
+            uv venv
+            source .venv/bin/activate
+            uv sync --extra dev_core
       - run:
-          name: Check formatting with black
+          name: Check handwritten code with ruff
           command: |
-            . venv/bin/activate
-            black --check . --exclude venv
+            source .venv/bin/activate
+            ruff format --check .
 
   test_core_py:
     parameters:
@@ -166,6 +189,17 @@ jobs:
           pandas_version: <<parameters.pandas_version>>
           numpy_version: <<parameters.numpy_version>>
 
+  test_kaleido_v0:
+    parameters:
+      python_version:
+        default: "3.12"
+        type: string
+    executor:
+      name: docker-container
+      python_version: <<parameters.python_version>>
+    steps:  
+      - test_io_kaleido_v0
+
   # Percy
   python_311_percy:
     docker:
@@ -189,22 +223,20 @@ jobs:
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install -e .
-            uv pip install -r test_requirements/requirements_optional.txt
+            uv sync --extra dev_optional
 
       - run:
-          name: Build html figures (Pandas 2)
+          name: Build HTML figures (Pandas 2)
           command: |
             source .venv/bin/activate
             python tests/percy/plotly-express.py
       - run:
-          name: Build html figures (Pandas 1) and compare
+          name: Build HTML figures (Pandas 1) and compare
           command: |
             source .venv/bin/activate
             mkdir tests/percy/pandas2
             mv tests/percy/*.html tests/percy/pandas2/
-            uv pip install pip
-            python -m pip install pandas==1.5.3 numpy==1.26.4
+            uv pip install pandas==1.5.3 numpy==1.26.4
             python tests/percy/plotly-express.py
             python tests/percy/compare-pandas.py
             rm -rf tests/percy/pandas2
@@ -236,8 +268,7 @@ jobs:
             curl -LsSf https://astral.sh/uv/install.sh | sh
             uv venv
             source .venv/bin/activate
-            uv pip install -e .
-            uv pip install -r ./test_requirements/requirements_core.txt black inflect jupyterlab
+            uv sync --extra dev_optional
       - run:
           name: Update plotly.js to dev
           command: |
@@ -254,7 +285,7 @@ jobs:
           name: Build source distribution packages
           command: |
             source .venv/bin/activate
-            uv pip install build
+            uv sync --extra dev_build
             python -m build --sdist --wheel -o dist
           when: always
       - store_artifacts:
@@ -269,22 +300,17 @@ jobs:
 
     steps:
       - checkout
-
       - run:
-          name: initial NPM Build
+          name: PyPI Build
           command: |
-            python -m venv venv
-            . venv/bin/activate
+            curl -LsSf https://astral.sh/uv/install.sh | sh
+            uv venv
+            source .venv/bin/activate
+            uv sync --extra dev_build
             cd js
             npm ci
             npm run build
-            git status
-
-      - run:
-          name: PyPI Build
-          command: |
-            . venv/bin/activate
-            pip install build
+            cd ..
             python -m build --sdist --wheel -o dist
             cp -R dist output
             git status
@@ -310,7 +336,6 @@ jobs:
       - checkout
       - browser-tools/install-chrome
       - browser-tools/install-chromedriver
-
       - run:
           name: Install dependencies
           command: |
@@ -321,16 +346,11 @@ jobs:
             uv venv
             source .venv/bin/activate
             uv pip install -r requirements.txt
+            cd ..
             if [ "${CIRCLE_BRANCH}" != "doc-prod" ]; then
               uv pip uninstall plotly
-              cd ..
               uv pip install -e .
-              cd js
-              npm ci
-              npm run build
-              cd ../doc
             fi
-            cd ..
 
       - run:
           name: make html
@@ -412,6 +432,7 @@ jobs:
       - store_artifacts:
           path: doc/build
           destination: doc/build
+
 workflows:
   code_formatting:
     jobs:
@@ -422,7 +443,6 @@ workflows:
   release_build:
     jobs:
       - full_build
-
   build:
     jobs:
       - test_core_py:
@@ -450,5 +470,10 @@ workflows:
           python_version: "3.9"
           pandas_version: "1.2.4"
           numpy_version: "1.26.4"
+      - test_kaleido_v0:
+          matrix:
+            parameters:
+              python_version:
+                - "3.12"
       - python_311_percy
       - build-doc

.github/ISSUE_TEMPLATE.md

@@ -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).

.github/pull_request_template.md

@@ -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 `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 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.
 
 -->

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

@@ -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