Clean up pyproject.toml and build pipeline

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

@@ -2,63 +2,72 @@ 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
+        # Compare the plotly/labextension and plotly/labextension-tmp directories
+        diff -r plotly/labextension/ plotly/labextension-tmp/ > labextension_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
+        echo "checking for differences between plotly/labextension and plotly/labextension-tmp"
 
-        # 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
+        # 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
+        FAIL=0
         else
-        echo "✅ Build artifacts match expected output (ignoring known 'load' hash in package.json)."
+        echo "✅ Build artifacts match expected output"
+        FAIL=0
         fi
 
+        echo "checked for differences"
+        echo "FAIL: $FAIL"
+
+        sleep 5
+
+        exit $FAIL
+
     - name: Store the build artifacts from plotly/labextension
       uses: actions/upload-artifact@v4
       if: failure()

RELEASE.md

@@ -25,6 +25,8 @@ a link to the plotly.js CHANGELOG.
 - Manually update the versions to `X.Y.Z` in the files specified below:
   - `pyproject.toml`
     - update version
+  - `js/package.json`
+    - update version (`"version"` key at top of file)
   - `CHANGELOG.md`
     - update version and release date
     - finalize changelog entries according to instructions above

js/install.json

@@ -1,9 +1,4 @@
 {
-    "schemaVersion": 1,
-    "packageName": "jupyterlab-plotly",
-    "version": "6.0.1",
-    "packageManager": "python",
-    "jupyterlab": {
-      "mimeExtension": "lib/mimeExtension.js"
-    }
+    "packageName": "plotly",
+    "packageManager": "python"
 }

js/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jupyterlab-plotly",
   "main": "lib/mimeExtension.js",
-  "version": "6.0.1",
+  "version": "6.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/plotly/plotly.py"
@@ -30,6 +30,7 @@
   },
   "jupyterlab": {
     "mimeExtension": true,
-    "outputDir": "../plotly/labextension"
+    "outputDir": "../plotly/labextension",
+    "webpackConfig": "./webpack.config.js"
   }
 }

js/webpack.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  // Note: This config has no effect on the lab extension functionality,
+  // but it helps ensure that webpack uses the same module and chunk IDs
+  // across platforms, which makes it easier to compare build artifacts.
+  optimization: {
+    moduleIds: 'natural',
+    chunkIds: 'natural',
+    realContentHash: true
+  },
+};

plotly/labextension/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jupyterlab-plotly",
   "main": "lib/mimeExtension.js",
-  "version": "6.0.1",
+  "version": "6.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/plotly/plotly.py"
@@ -31,8 +31,9 @@
   "jupyterlab": {
     "mimeExtension": true,
     "outputDir": "../plotly/labextension",
+    "webpackConfig": "./webpack.config.js",
     "_build": {
-      "load": "static/remoteEntry.d9ed7f5a4589fd6764e9.js",
+      "load": "static/remoteEntry.a90ef69e866c18565afe.js",
       "mimeExtension": "./mimeExtension"
     }
   }

pyproject.toml

@@ -1,11 +1,11 @@
 [build-system]
-requires = ["setuptools>=71"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
 
 [project.urls]
-"HomePage" = "https://plotly.com/python/"
+"Homepage" = "https://plotly.com/python/"
 "Documentation" = "https://plotly.com/python/"
-"Github" = "https://github.com/plotly/plotly.py"
+"GitHub" = "https://github.com/plotly/plotly.py"
 "Changelog" = "https://github.com/plotly/plotly.py/blob/main/CHANGELOG.md"
 
 [project]
@@ -18,7 +18,6 @@ maintainers = [
     { name="Emily Kellison-Linn", email="emily@plot.ly" }
 ]
 description = "An open-source interactive data visualization library for Python"
-readme = {file = "README.md", content-type = "text/markdown"}
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3.8",
@@ -31,7 +30,8 @@ classifiers = [
     "License :: OSI Approved :: MIT License"
 ]
 requires-python = ">=3.8"
-license = {file="LICENSE.txt"}
+license = "MIT"
+license-files = ["LICENSE.txt"]
 version = "6.6.0"
 dependencies = [
     "narwhals>=1.15.1",
@@ -50,7 +50,7 @@ dev_core = [
 dev_build = [
     "plotly[dev_core]",
     "build",
-    "jupyter"
+    "jupyterlab"
 ]
 dev_optional = [
     "plotly[dev_build]",
@@ -91,43 +91,17 @@ markers = [
     "matplotlib: mark a test as matplotlib"
 ]
 
-[tool.setuptools.packages.find]
-where = ["."]
-include = ["plotly*", "_plotly*"]
-exclude = ["__pycache__*", "tests*"]
-
-[tool.setuptools.package-data]
-plotly = [
-    "package_data/*",
-    "package_data/templates/*",
-    "package_data/datasets/*",
-    "validators/_validators.json"
-]
-
-[tool.jupyter-packaging.builder]
-factory = "jupyter_packaging.npm_builder"
-auto_data_files = true
-
-[tool.jupyter-packaging.build-args]
-build_cmd = "build:prod"
-npm = ["jlpm"]
-
-[tool.hatch.build.hooks.jupyter-builder]
-editable-frontend = true
-
-[tool.hatch.build.hooks.jupyter-builder.editable-build-kwargs]
-build_cmd = "build"
-npm = ["jlpm"]
-source_dir = "js"
-build_dir = "plotly/labextension"
-skip_symlink = true
-
-[tool.setuptools.data-files]
-"share/jupyter/labextensions/jupyterlab-plotly" = [
-  "plotly/labextension/package.json",
-  "js/install.json"
+[tool.hatch.build]
+include = [
+    "/plotly*",
+    "/_plotly*",
+    "js/install.json",  # used by Jupyter extension
 ]
 
-"share/jupyter/labextensions/jupyterlab-plotly/static" = [
-  "plotly/labextension/static/*.js"
-]
+[tool.hatch.build.targets.wheel.shared-data]
+# Specify files from this package which will be copied to the user's system on install
+# This is how the jupyterlab extension gets installed
+# Left path is the path within this package
+# Right path is the path on the user's system
+"plotly/labextension" = "share/jupyter/labextensions/jupyterlab-plotly"
+"js/install.json" = "share/jupyter/labextensions/jupyterlab-plotly/install.json"