feat(packaging): PyPI distribution for dimos-viewer

.github/workflows/build-viewer.yml

@@ -1,116 +1,249 @@
-name: Build Interactive Viewer
+# Build & publish dimos-viewer wheels.
+#
+# Modelled on Rerun's reusable_build_and_upload_wheels / reusable_publish_wheels
+# but adapted for the dimos-viewer binary package:
+#   - Uses standard GitHub runners (no self-hosted)
+#   - Uses GitHub Artifacts instead of GCS for wheel storage
+#   - Builds with `maturin build` (bindings = "bin") instead of rerun_py
+#
+# Triggers:
+#   PR → main          build + test
+#   push → main        build + test
+#   tag v*             build + test + publish to PyPI + GitHub Release
+
+name: Build & Publish dimos-viewer
 
 on:
   push:
     branches: [main]
     tags: ['v*']
   pull_request:
     branches: [main]
+  workflow_dispatch:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  id-token: write
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  RUST_TOOLCHAIN: "1.92.0"
+  PYTHON_VERSION: "3.10"
+  PACKAGE_DIR: examples/rust/custom_callback
+
+# ---------------------------------------------------------------------------
 jobs:
-  build-linux:
+
+  # -------------------------------------------------------------------
+  # 1. Rust checks & tests
+  # -------------------------------------------------------------------
+  check:
+    name: Cargo check & test
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install Rust
-        uses: dtolnay/rust-toolchain@stable
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: 1.92.0
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
 
       - name: Install system dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y \
-            libgtk-3-dev \
-            libxcb-render0-dev \
-            libxcb-shape0-dev \
-            libxcb-xfixes0-dev \
-            libxkbcommon-dev \
-            libvulkan-dev \
-            mesa-vulkan-drivers \
-            xvfb \
-            libxkbcommon-x11-0
-
-      - name: Cache cargo
-        uses: actions/cache@v4
+            libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev \
+            libxcb-xfixes0-dev libxkbcommon-dev libvulkan-dev \
+            mesa-vulkan-drivers libxkbcommon-x11-0
+
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
             target/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          key: ${{ runner.os }}-cargo-check-${{ hashFiles('**/Cargo.lock') }}
+
+      - run: cargo check -p custom_callback
+      - run: cargo test  -p custom_callback
+
+  # -------------------------------------------------------------------
+  # 2. Build wheels (one job per platform)
+  #    Mirrors the matrix approach from reusable_build_and_upload_wheels.yml
+  # -------------------------------------------------------------------
+  build-wheel:
+    name: Build wheel (${{ matrix.platform }})
+    needs: [check]
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - platform: linux-x64
+            os: ubuntu-22.04
+            target: x86_64-unknown-linux-gnu
+            compatibility: manylinux_2_28
+          - platform: linux-arm64
+            os: ubuntu-22.04
+            target: aarch64-unknown-linux-gnu
+            compatibility: manylinux_2_28
+          - platform: macos-arm64
+            os: macos-14
+            target: aarch64-apple-darwin
+            compatibility: ""
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+          targets: ${{ matrix.target }}
 
-      - name: Build viewer
-        run: cargo build --release -p custom_callback
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install maturin
+        run: pip install maturin>=1.8.1
 
-      - name: Run tests
-        run: cargo test -p custom_callback
+      - name: Install system dependencies (Linux)
+        if: runner.os == 'Linux'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgtk-3-dev libxcb-render0-dev libxcb-shape0-dev \
+            libxcb-xfixes0-dev libxkbcommon-dev libvulkan-dev \
+            mesa-vulkan-drivers libxkbcommon-x11-0
 
-      - name: Package binary
+      - name: Install cross-compilation toolchain (Linux ARM64)
+        if: matrix.target == 'aarch64-unknown-linux-gnu'
         run: |
-          cd target/release
-          strip custom_callback_viewer
-          tar -czf dimos-viewer-${{ github.ref_name }}-linux-x64.tar.gz custom_callback_viewer
+          sudo apt-get install -y gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
+          echo "CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER=aarch64-linux-gnu-gcc" >> "$GITHUB_ENV"
 
-      - name: Upload artifact
+      - uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-${{ matrix.target }}-cargo-wheel-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Build wheel
+        run: |
+          COMPAT_ARG=""
+          if [ -n "${{ matrix.compatibility }}" ]; then
+            COMPAT_ARG="--compatibility ${{ matrix.compatibility }}"
+          fi
+          maturin build \
+            --release \
+            --manifest-path "${{ env.PACKAGE_DIR }}/Cargo.toml" \
+            --target "${{ matrix.target }}" \
+            $COMPAT_ARG \
+            --out dist/
+
+      - name: Upload wheel artifact
         uses: actions/upload-artifact@v4
         with:
-          name: dimos-viewer-linux-x64
-          path: target/release/dimos-viewer-*.tar.gz
+          name: wheel-${{ matrix.platform }}
+          path: dist/*.whl
+
+  # -------------------------------------------------------------------
+  # 3. Test installed wheels
+  # -------------------------------------------------------------------
+  test-wheel:
+    name: Test wheel (py${{ matrix.python-version }})
+    needs: [build-wheel]
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+    runs-on: ubuntu-22.04
 
-  build-macos:
-    runs-on: macos-14
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install Rust
-        uses: dtolnay/rust-toolchain@stable
+      - uses: actions/setup-python@v5
         with:
-          toolchain: 1.92.0
+          python-version: ${{ matrix.python-version }}
 
-      - name: Cache cargo
-        uses: actions/cache@v4
+      - name: Download linux-x64 wheel
+        uses: actions/download-artifact@v4
         with:
-          path: |
-            ~/.cargo/registry/index/
-            ~/.cargo/registry/cache/
-            ~/.cargo/git/db/
-            target/
-          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          name: wheel-linux-x64
+          path: dist/
 
-      - name: Build viewer
-        run: cargo build --release -p custom_callback
+      - name: Install wheel + test deps
+        run: |
+          pip install dist/*.whl
+          pip install pytest
 
-      - name: Run tests
-        run: cargo test -p custom_callback
+      - name: Run Python tests
+        run: pytest "${{ env.PACKAGE_DIR }}/tests/" -v
 
-      - name: Package binary
+      - name: Verify CLI entry point
         run: |
-          cd target/release
-          strip custom_callback_viewer
-          tar -czf dimos-viewer-${{ github.ref_name }}-macos-arm64.tar.gz custom_callback_viewer
+          which dimos-viewer
+          python -c "from dimos_viewer import __version__; print(f'dimos-viewer v{__version__}')"
+          python -c "from dimos_viewer import _find_viewer_binary; print(f'binary: {_find_viewer_binary()}')"
+
+  # -------------------------------------------------------------------
+  # 4. Publish to PyPI  (tag v* only)
+  #    Mirrors reusable_publish_wheels.yml but pulls from GitHub Artifacts
+  #    instead of GCS, then uploads via `maturin upload`.
+  # -------------------------------------------------------------------
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [test-wheel]
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-22.04
+    permissions:
+      id-token: write
 
-      - name: Upload artifact
-        uses: actions/upload-artifact@v4
+    steps:
+      - name: Download all wheels
+        uses: actions/download-artifact@v4
         with:
-          name: dimos-viewer-macos-arm64
-          path: target/release/dimos-viewer-*.tar.gz
+          pattern: wheel-*
+          merge-multiple: true
+          path: dist/
 
-  release:
-    needs: [build-linux, build-macos]
-    runs-on: ubuntu-22.04
+      - run: ls -la dist/
+
+      - name: Publish to PyPI (trusted publisher)
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          skip-existing: true
+
+  # -------------------------------------------------------------------
+  # 5. GitHub Release  (tag v* only)
+  # -------------------------------------------------------------------
+  github-release:
+    name: GitHub Release
+    needs: [publish-pypi]
     if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-22.04
+
     steps:
-      - name: Download all artifacts
+      - name: Download all wheels
         uses: actions/download-artifact@v4
         with:
+          pattern: wheel-*
           merge-multiple: true
-          path: release/
+          path: dist/
 
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2
         with:
-          files: release/dimos-viewer-*.tar.gz
+          files: dist/*.whl
           generate_release_notes: true

examples/rust/custom_callback/.gitignore

@@ -0,0 +1,10 @@
+# Python
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+
+# Maturin build artifacts
+target/

examples/rust/custom_callback/Cargo.toml

@@ -7,13 +7,9 @@ license = "MIT OR Apache-2.0"
 publish = false
 
 [[bin]]
-name = "custom_callback_viewer"
+name = "dimos-viewer"
 path = "src/viewer.rs"
 
-[[bin]]
-name = "custom_callback_app"
-path = "src/app.rs"
-
 [features]
 default = []