ci: use hatchling for bundling app

Author: jourdain

.github/workflows/finalize-release.yml

@@ -36,7 +36,7 @@ jobs:
             VERSION="${{ github.event.inputs.version }}"
           else
             # Automatic trigger - read from files
-            VERSION=$(python -c "from quickview import __version__; print(__version__)")
+            VERSION=$(python -c "from e3sm_quickview import __version__; print(__version__)")
           fi
           echo "VERSION=$VERSION" >> $GITHUB_ENV
           echo "APP_TAG=v$VERSION" >> $GITHUB_ENV

.github/workflows/package-and-release.yml

@@ -26,9 +26,9 @@ jobs:
       - name: Verify LFS files
         run: |
           echo "Checking LFS files..."
-          ls -la quickview/data/
-          file quickview/data/globe.vtk
-          file quickview/data/connectivity.nc
+          ls -la src/e3sm_quickview/data/
+          file src/e3sm_quickview/data/globe.vtk
+          file src/e3sm_quickview/data/connectivity.nc
           echo "LFS file check complete"
 
       - name: Get version for tagging
@@ -51,14 +51,14 @@ jobs:
           python -m pip install --upgrade pip
           pip install .  # Assumes installable via setup.py or pyproject.toml
           # Now we can read the version
-          VERSION=$(python -c "from quickview import __version__; print(__version__)")
+          VERSION=$(python -c "from e3sm_quickview import __version__; print(__version__)")
           echo "VERSION=$VERSION" >> $GITHUB_ENV
           echo "Found version: $VERSION"
         shell: bash -l {0}
       - name: Package using PyInstaller
         run: |
-          chmod +x scripts/setup_tauri.sh
-          ./scripts/setup_tauri.sh
+          chmod +x scripts/setup_tauri2.sh
+          ./scripts/setup_tauri2.sh
         shell: bash -l {0}
       - name: setup node
         uses: actions/setup-node@v4

.gitignore

@@ -3,4 +3,4 @@ __pycache__
 build
 server.spec
 CLAUDE.md
-quickview.egg-info/
+*.egg-info

pyproject.toml

@@ -1,28 +1,15 @@
 [project]
-name = "quickview"
+name = "e3sm-quickview"
 version = "1.0.2"
 description = "An application to explore/analyze data for atmosphere component for E3SM"
 authors = [
     {name = "Kitware Inc."},
 ]
-dependencies = [
-    "trame>=3.6",
-    "trame-vtk>=2.6",
-    "trame-vuetify>=2.4",
-    "trame-components>=2.3.2",
-    "trame-grid-layout>=1.0.3",
-    "trame-tauri>=0.6.2",
-    "pyproj>=3.6.1",
-    "netCDF4>=1.6.5",
-    "pyinstaller",
-    "trame-dataclass",
-]
-requires-python = ">=3.13"
 readme = "README.md"
 license = {text = "Apache Software License"}
 keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Environment :: Web Environment",
     "License :: OSI Approved :: Apache Software License",
     "Natural Language :: English",
@@ -32,20 +19,50 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 
-[tool.setuptools.packages.find]
-where = ["."]
+requires-python = ">=3.10"
+
+dependencies = [
+    "trame>=3.12",
+    "trame-vtk>=2.10",
+    "trame-vuetify>=3.1",
+    "pyproj>=3.6.1",
+    "netCDF4>=1.6.5",
+    "trame-dataclass>=1.2",
+]
+
+[project.optional-dependencies]
+tauri = [
+    "pyinstaller",
+]
+vue2 = [
+    "trame-grid-layout>=1.0.3",
+    "trame-tauri>=0.6.2",
+]
+
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build]
+include = [
+  "/src/e3sm_quickview/**/*.py",
+  "/src/e3sm_quickview/presets/**",
+  "/src/e3sm_quickview/data/**",
+  "/src/e3sm_quickview/assets/**",
+  "/src/e3sm_quickview/module/**",
+]
 
-[tool.setuptools.package-data]
-quickview = [
-  "presets/**",
-  "data/**"
+[tool.hatch.build.targets.wheel]
+packages = [
+    "src/e3sm_quickview",
 ]
 
 [project.scripts]
-quickview = "quickview.app:main"
-quickview2 = "quickview.app2:main"
+quickview-vue2 = "e3sm_quickview.app:main"
+quickview = "e3sm_quickview.app2:main"
 
 [tool.ruff.lint.per-file-ignores]
 # Ignore star import issues in ParaView plugins
-"quickview/plugins/*.py" = ["F403", "F405"]
-"quickview/pipeline.py" = ["F821"]  # Plugin classes loaded dynamically
+"e3sm_quickview/plugins/*.py" = ["F403", "F405"]
+"e3sm_quickview/pipeline.py" = ["F821"]  # Plugin classes loaded dynamically

quickview/data/connectivity.nc

@@ -17,14 +17,14 @@ python -m PyInstaller --clean --noconfirm \
         --collect-all pyproj \
         --collect-all netCDF4 \
         --collect-all paraview \
-        --collect-all quickview \
+        --collect-all e3sm_quickview \
         --hidden-import pkgutil \
         --add-binary="$(which pvpython):."  \
-        quickview/app2.py
+        src/e3sm_quickview/app2.py
 
 # Generate trame www + quickview
 python -m trame.tools.www --output ./src-tauri/www
-python -m trame.tools.www --output ./src-tauri/www quickview.module
+python -m trame.tools.www --output ./src-tauri/www e3sm_quickview.module
 
 # Precompile install to speedup start (maybe?)
 ./src-tauri/server/server --timeout 1 --server

quickview/data/globe.vtk

@@ -5,8 +5,8 @@
 from pathlib import Path
 
 
-from quickview.pipeline import EAMVisSource
-from quickview.interface import EAMApp
+from e3sm_quickview.pipeline import EAMVisSource
+from e3sm_quickview.interface import EAMApp
 
 
 def main():

scripts/setup_tauri2.sh

@@ -10,12 +10,12 @@
 from trame.widgets import vuetify3 as v3, client, html, dataclass
 from trame.decorators import controller, change, trigger, life_cycle
 
-from quickview import module as qv_module
-from quickview.assets import ASSETS
-from quickview.components import doc, file_browser, css, toolbars, dialogs, drawers
-from quickview.pipeline import EAMVisSource
-from quickview.utils import compute, js, constants, cli
-from quickview.view_manager2 import ViewManager
+from e3sm_quickview import module as qv_module
+from e3sm_quickview.assets import ASSETS
+from e3sm_quickview.components import doc, file_browser, css, toolbars, dialogs, drawers
+from e3sm_quickview.pipeline import EAMVisSource
+from e3sm_quickview.utils import compute, js, constants, cli
+from e3sm_quickview.view_manager2 import ViewManager
 
 
 v3.enable_lab()