dcap-qvl 0.3.8__tar.gz

dcap_qvl-0.3.8/.github/PUBLISHING.md

@@ -0,0 +1,172 @@
+# Publishing Guide
+
+This document explains how to publish dcap-qvl to various package repositories.
+
+## Python Package (PyPI)
+
+### Automated Publishing
+
+The project includes GitHub Actions workflows for automated publishing:
+
+#### 1. Via Git Tags (Automatic)
+When you push a git tag starting with `v`, the `python-wheels.yml` workflow automatically:
+- Builds wheels for all supported platforms
+- Publishes to PyPI if the tag matches a version
+
+```bash
+git tag v0.3.1
+git push origin v0.3.1
+```
+
+#### 2. Manual Publishing
+Use the `publish-pypi.yml` workflow for manual control:
+
+1. Go to GitHub Actions → "Publish to PyPI"
+2. Click "Run workflow"
+3. Choose environment (testpypi or pypi)
+4. Optionally specify version
+5. Click "Run workflow"
+
+### Supported Platforms
+
+The automated builds create wheels for:
+
+**Linux (manylinux)**:
+- x86_64
+- x86 (32-bit)
+- aarch64 (ARM64)
+
+**Windows**:
+- x64 (64-bit)
+- x86 (32-bit)
+
+**macOS**:
+- x86_64 (Intel)
+- aarch64 (Apple Silicon)
+
+### ABI3 Compatibility
+
+All wheels are built with abi3 (stable ABI) enabled, meaning:
+- One wheel works across multiple Python versions (3.8+)
+- Smaller distribution size
+- Better compatibility
+
+### Test Before Publishing
+
+1. **Test on TestPyPI first**:
+   ```bash
+   # Use the manual workflow with environment: testpypi
+   pip install -i https://test.pypi.org/simple/ dcap-qvl
+   ```
+
+2. **Local testing**:
+   ```bash
+   cd python-bindings
+   ./tests/test_python_versions.sh
+   ```
+
+## Rust Crate (crates.io)
+
+### Automated Publishing
+
+When you create a git tag, the `release.yml` workflow automatically publishes to crates.io.
+
+### Manual Publishing
+
+```bash
+# Main library
+cargo publish
+
+# CLI tool
+cd cli
+cargo publish
+```
+
+## GitHub Releases
+
+The `release.yml` workflow automatically creates GitHub releases with:
+- Pre-built CLI binaries for multiple platforms
+- Changelog generated from git commits
+- Links to PyPI and crates.io packages
+
+## Environment Setup
+
+### Required Secrets
+
+Configure these secrets in your GitHub repository:
+
+1. **CRATES_IO_TOKEN**: Token for publishing to crates.io
+   - Get from https://crates.io/settings/tokens
+   - Add to repository secrets
+
+2. **PyPI Publishing**: Uses OpenID Connect (no token needed)
+   - Configured with `id-token: write` permission
+   - Uses trusted publishing via GitHub Actions
+
+### Environments
+
+Set up these GitHub Environments for PyPI publishing:
+
+1. **testpypi**: For testing releases
+   - URL: https://test.pypi.org/p/dcap-qvl
+   - Protection rules: None
+
+2. **pypi**: For production releases
+   - URL: https://pypi.org/p/dcap-qvl
+   - Protection rules: Required reviewers, deployment branches
+
+## Version Management
+
+### Python Package Version
+
+Update version in `python-bindings/pyproject.toml`:
+```toml
+[project]
+version = "0.3.1"
+```
+
+### Rust Crate Version
+
+Update version in root `Cargo.toml`:
+```toml
+[package]
+version = "0.3.1"
+```
+
+### CLI Version
+
+Update version in `cli/Cargo.toml`:
+```toml
+[package]
+version = "0.3.1"
+```
+
+## Troubleshooting
+
+### Build Failures
+
+1. **Cross-compilation issues**: Check the maturin-action logs
+2. **Missing dependencies**: Ensure all features are properly configured
+3. **Test failures**: Run tests locally first
+
+### Publishing Issues
+
+1. **Duplicate version**: Use `skip-existing: true` in workflows
+2. **Permission denied**: Check GitHub environment protection rules
+3. **Missing wheels**: Verify all build jobs completed successfully
+
+### Testing Issues
+
+1. **Import errors**: Check that the wheel is compatible with the test environment
+2. **Async function failures**: Ensure tokio runtime is properly configured
+3. **ABI compatibility**: Test with multiple Python versions locally
+
+## Best Practices
+
+1. **Always test on TestPyPI first**
+2. **Use semantic versioning**
+3. **Update all version numbers consistently**
+4. **Test locally before pushing tags**
+5. **Review the generated changelog before release**
+6. **Monitor PyPI download statistics**
+7. **Keep dependencies up to date with Dependabot**

dcap_qvl-0.3.8/.github/dependabot.yml

@@ -0,0 +1,45 @@
+version: 2
+updates:
+  # Rust dependencies
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10
+    groups:
+      rust-dependencies:
+        patterns:
+          - "*"
+
+  # Rust CLI dependencies
+  - package-ecosystem: "cargo"
+    directory: "/cli"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    groups:
+      cli-dependencies:
+        patterns:
+          - "*"
+
+  # Python dependencies in python-bindings
+  - package-ecosystem: "pip"
+    directory: "/python-bindings"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    groups:
+      python-dependencies:
+        patterns:
+          - "*"
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    groups:
+      github-actions:
+        patterns:
+          - "*"

dcap_qvl-0.3.8/.github/workflows/publish-npm.yml

@@ -0,0 +1,196 @@
+name: Publish npm Package
+
+on:
+  push:
+    tags:
+      - "npm-v*"  # Trigger on tags like npm-v0.0.1
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to publish (e.g., 0.0.1, leave empty to use package.json)"
+        required: false
+        type: string
+      npm_tag:
+        description: "npm dist-tag (latest, beta, alpha, etc.)"
+        required: false
+        type: string
+        default: "beta"
+      dry_run:
+        description: "Dry run (test without actually publishing)"
+        required: false
+        type: boolean
+        default: false
+
+permissions:
+  id-token: write  # Required for OIDC
+  contents: write  # Required to commit version changes
+
+jobs:
+  publish-npm:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Determine npm tag and version
+        id: npm-meta
+        run: |
+          if [[ "${{ github.event_name }}" == "push" ]]; then
+            # Tag push: npm-v0.1.0 -> version=0.1.0, npm_tag=latest
+            NPM_TAG="latest"
+            VERSION=${GITHUB_REF#refs/tags/npm-v}
+            UPDATE_VERSION="true"  # Update package.json to match tag
+            COMMIT_VERSION="true"  # Commit back to keep repository in sync
+            echo "Triggered by tag push: npm-v$VERSION"
+          else
+            # Manual dispatch
+            NPM_TAG="${{ github.event.inputs.npm_tag || 'beta' }}"
+            if [[ -n "${{ github.event.inputs.version }}" ]]; then
+              # User specified version
+              VERSION="${{ github.event.inputs.version }}"
+              UPDATE_VERSION="true"
+              COMMIT_VERSION="true"  # Commit version changes
+              echo "Triggered by workflow_dispatch with version=$VERSION, npm_tag=$NPM_TAG"
+            else
+              # Use version from package.json
+              VERSION=$(node -e "console.log(require('./dcap-qvl-js/package.json').version)")
+              UPDATE_VERSION="false"
+              COMMIT_VERSION="false"
+              echo "Triggered by workflow_dispatch using package.json version=$VERSION, npm_tag=$NPM_TAG"
+            fi
+          fi
+          echo "npm_tag=$NPM_TAG" >> $GITHUB_OUTPUT
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "update_version=$UPDATE_VERSION" >> $GITHUB_OUTPUT
+          echo "commit_version=$COMMIT_VERSION" >> $GITHUB_OUTPUT
+          echo "dry_run=${{ github.event.inputs.dry_run || 'false' }}" >> $GITHUB_OUTPUT
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Upgrade npm for OIDC support
+        run: |
+          npm install -g npm@latest
+          echo "npm version: $(npm --version)"
+
+      - name: Verify OIDC token availability
+        run: |
+          if [ -n "${ACTIONS_ID_TOKEN_REQUEST_URL}" ] && [ -n "${ACTIONS_ID_TOKEN_REQUEST_TOKEN}" ]; then
+            echo "✓ OIDC token available"
+            echo "Endpoint: ${ACTIONS_ID_TOKEN_REQUEST_URL}"
+          else
+            echo "✗ OIDC token NOT available"
+            echo "Check workflow permissions include 'id-token: write'"
+            exit 1
+          fi
+
+      - name: Verify repository configuration
+        run: |
+          echo "Checking repository consistency..."
+          GIT_REPO=$(git remote get-url origin | sed 's/.*github.com[/:]//; s/.git$//')
+          PKG_REPO=$(node -e "console.log(require('./dcap-qvl-js/package.json').repository?.url || '')" | sed 's|https://github.com/||; s|git+||; s|.git$||')
+
+          echo "Git remote:   $GIT_REPO"
+          echo "package.json: $PKG_REPO"
+
+          if [ "$GIT_REPO" != "$PKG_REPO" ]; then
+            echo "✗ Repository mismatch!"
+            echo "This will cause 422 error during publish"
+            exit 1
+          fi
+          echo "✓ Repositories match"
+
+      - name: Display package information
+        run: |
+          cd dcap-qvl-js
+          PKG_NAME=$(node -e "console.log(require('./package.json').name)")
+          PKG_VERSION=$(node -e "console.log(require('./package.json').version)")
+          echo "Package: $PKG_NAME"
+          echo "Version: $PKG_VERSION"
+          echo "npm tag: ${{ steps.npm-meta.outputs.npm_tag }}"
+          echo "Dry run: ${{ steps.npm-meta.outputs.dry_run }}"
+          echo "Trigger: ${{ github.event_name }}"
+
+      - name: Install dependencies
+        working-directory: dcap-qvl-js
+        run: npm ci
+
+      - name: Update package version
+        if: steps.npm-meta.outputs.update_version == 'true'
+        working-directory: dcap-qvl-js
+        run: |
+          VERSION="${{ steps.npm-meta.outputs.version }}"
+          echo "Updating package.json version to $VERSION"
+          npm version "$VERSION" --no-git-tag-version
+          echo "Updated version:"
+          node -e "console.log(require('./package.json').version)"
+
+      - name: Publish to npm (Dry Run)
+        if: steps.npm-meta.outputs.dry_run == 'true'
+        working-directory: dcap-qvl-js
+        run: |
+          NPM_TAG="${{ steps.npm-meta.outputs.npm_tag }}"
+          echo "🔍 Dry run mode - simulating publish with tag: $NPM_TAG"
+          npm publish --access public --tag "$NPM_TAG" --provenance --dry-run --verbose
+
+      - name: Publish to npm
+        if: steps.npm-meta.outputs.dry_run != 'true'
+        working-directory: dcap-qvl-js
+        run: |
+          NPM_TAG="${{ steps.npm-meta.outputs.npm_tag }}"
+          echo "Publishing @phala/dcap-qvl with tag: $NPM_TAG"
+          npm publish --access public --tag "$NPM_TAG" --provenance --verbose
+
+      - name: Publish summary
+        if: success() && steps.npm-meta.outputs.dry_run != 'true'
+        run: |
+          PKG_NAME=$(node -e "console.log(require('./dcap-qvl-js/package.json').name)")
+          PKG_VERSION=$(node -e "console.log(require('./dcap-qvl-js/package.json').version)")
+          NPM_TAG="${{ steps.npm-meta.outputs.npm_tag }}"
+          echo ""
+          echo "================================"
+          echo "✓ Published Successfully!"
+          echo "================================"
+          echo "Package: $PKG_NAME@$PKG_VERSION"
+          echo "npm tag: $NPM_TAG"
+          echo ""
+          echo "Install with:"
+          echo "  npm install $PKG_NAME@$NPM_TAG"
+          echo ""
+          echo "View on npm:"
+          echo "  https://www.npmjs.com/package/$PKG_NAME"
+          echo "================================"
+
+      - name: Commit version changes
+        if: success() && steps.npm-meta.outputs.commit_version == 'true' && steps.npm-meta.outputs.dry_run != 'true'
+        run: |
+          VERSION="${{ steps.npm-meta.outputs.version }}"
+
+          # Configure git
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Determine target branch
+          if [[ "${{ github.event_name }}" == "push" ]]; then
+            # For tag push, get the default branch
+            DEFAULT_BRANCH=$(git remote show origin | grep "HEAD branch" | cut -d ":" -f 2 | xargs)
+            echo "Detected default branch: $DEFAULT_BRANCH"
+            # Switch to the default branch
+            git fetch origin "$DEFAULT_BRANCH"
+            git checkout "$DEFAULT_BRANCH"
+          else
+            # For workflow_dispatch, we're already on a branch
+            CURRENT_BRANCH=$(git branch --show-current)
+            echo "Current branch: $CURRENT_BRANCH"
+          fi
+
+          # Commit and push
+          git add dcap-qvl-js/package.json dcap-qvl-js/package-lock.json
+          git commit -m "chore(npm): bump version to $VERSION" \
+            -m "Published @phala/dcap-qvl@$VERSION to npm" \
+            -m "Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+          git push

dcap_qvl-0.3.8/.github/workflows/python-wheels.yml

@@ -0,0 +1,274 @@
+name: Build and Publish Python Wheels
+
+on:
+  push:
+    tags:
+      - "v*"
+    branches:
+      - "python-bindings" # For testing
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to publish (e.g., 0.3.5). Leave empty to use version from Cargo.toml'
+        required: false
+        type: string
+      publish_target:
+        description: 'Where to publish'
+        required: true
+        type: choice
+        options:
+          - none
+          - testpypi
+          - pypi
+        default: 'none'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build-wheels:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Override version if specified
+        if: github.event.inputs.version != ''
+        run: |
+          sed -i 's/^version = "[^"]*"/version = "${{ github.event.inputs.version }}"/' Cargo.toml
+          echo "Updated Cargo.toml version to ${{ github.event.inputs.version }}"
+          grep '^version' Cargo.toml
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Setup Python 3.8
+        run: uv python install 3.8
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Install Zig
+        run: |
+          curl -L https://ziglang.org/download/0.13.0/zig-linux-x86_64-0.13.0.tar.xz | tar -xJ
+          sudo mv zig-linux-x86_64-0.13.0 /opt/zig
+          sudo ln -sf /opt/zig/zig /usr/local/bin/zig
+          zig version
+      - name: Build Linux and macOS wheels with Zig
+        working-directory: python-bindings
+        run: |
+          uv sync
+          uv run python scripts/build_wheels.py \
+            --platforms linux-x86_64 linux-aarch64 linux-x86_64-musl linux-aarch64-musl macos-aarch64 \
+            --zig \
+            --install-targets \
+            --output-dir dist
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-cross
+          path: python-bindings/dist
+
+  # Windows build using native runner
+  windows:
+    runs-on: windows-latest
+    env:
+      PYTHONIOENCODING: "utf-8"
+      PYTHONUTF8: "1"
+    steps:
+      - uses: actions/checkout@v6
+      - name: Override version if specified
+        if: github.event.inputs.version != ''
+        shell: bash
+        run: |
+          sed -i 's/^version = "[^"]*"/version = "${{ github.event.inputs.version }}"/' Cargo.toml
+          echo "Updated Cargo.toml version to ${{ github.event.inputs.version }}"
+          grep '^version' Cargo.toml
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Setup Python 3.8
+        run: uv python install 3.8
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build Windows wheel
+        working-directory: python-bindings
+        run: |
+          uv sync
+          uv run python scripts/build_wheels.py --platforms windows-x64 --install-targets --output-dir dist
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-windows
+          path: python-bindings/dist
+
+  # macOS Intel build using native runner (Zig cross-compilation has issues)
+  macos-intel:
+    runs-on: macos-15-intel # Intel runner
+    steps:
+      - uses: actions/checkout@v6
+      - name: Override version if specified
+        if: github.event.inputs.version != ''
+        run: |
+          sed -i '' 's/^version = "[^"]*"/version = "${{ github.event.inputs.version }}"/' Cargo.toml
+          echo "Updated Cargo.toml version to ${{ github.event.inputs.version }}"
+          grep '^version' Cargo.toml
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Setup Python 3.8
+        run: uv python install 3.8
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build wheel natively
+        working-directory: python-bindings
+        run: |
+          uv sync
+          uv run python scripts/build_wheels.py \
+            --platforms macos-x86_64 \
+            --install-targets \
+            --output-dir dist
+      - name: Upload wheels
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-macos-x86_64
+          path: python-bindings/dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Override version if specified
+        if: github.event.inputs.version != ''
+        run: |
+          sed -i 's/^version = "[^"]*"/version = "${{ github.event.inputs.version }}"/' Cargo.toml
+          echo "Updated Cargo.toml version to ${{ github.event.inputs.version }}"
+          grep '^version' Cargo.toml
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+      - name: Build source distribution
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+          working-directory: python-bindings
+      - name: Upload source distribution
+        uses: actions/upload-artifact@v6
+        with:
+          name: wheels-sdist
+          path: python-bindings/dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')) || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish_target == 'pypi')
+    needs: [build-wheels, windows, macos-intel, sdist]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dcap-qvl
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v7
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - name: List artifacts
+        run: ls -la dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true
+
+  test-release:
+    name: Test Release
+    runs-on: ubuntu-latest
+    if: (github.event_name == 'push' && github.ref == 'refs/heads/python-bindings') || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish_target == 'testpypi')
+    needs: [build-wheels, windows, macos-intel, sdist]
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/dcap-qvl
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v7
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - name: List artifacts
+        run: ls -la dist/
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          verbose: true
+
+  test-wheels:
+    name: Test Wheels
+    runs-on: ${{ matrix.os }}
+    needs: [build-wheels, windows, macos-intel]
+    if: github.event_name != 'push' || !startsWith(github.ref, 'refs/tags/')
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        exclude:
+          # Skip some combinations to reduce CI time
+          - os: windows-latest
+            python-version: "3.9"
+          - os: macos-latest
+            python-version: "3.9"
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Setup Python ${{ matrix.python-version }}
+        run: uv venv --python ${{ matrix.python-version }}
+      - name: Download wheels
+        uses: actions/download-artifact@v7
+        with:
+          pattern: wheels-*
+          merge-multiple: true
+          path: dist
+      - name: Find and install wheel
+        shell: bash
+        run: |
+          # Find the appropriate wheel for this platform and Python version
+          if [[ "${{ runner.os }}" == "Linux" ]]; then
+            WHEEL=$(find dist -name "*manylinux_*_x86_64*.whl" | head -n1)
+          elif [[ "${{ runner.os }}" == "Windows" ]]; then
+            WHEEL=$(find dist -name "*win_amd64*.whl" | head -n1)
+          elif [[ "${{ runner.os }}" == "macOS" ]]; then
+            if [[ "$(uname -m)" == "arm64" ]]; then
+              WHEEL=$(find dist -name "*macosx*arm64*.whl" | head -n1)
+            else
+              WHEEL=$(find dist -name "*macosx*x86_64*.whl" | head -n1)
+            fi
+          fi
+
+          if [[ -n "$WHEEL" ]]; then
+            echo "Installing wheel: $WHEEL"
+            uv pip install "$WHEEL"
+          else
+            echo "No suitable wheel found, installing from source"
+            cd python-bindings
+            uv add maturin
+            uv run maturin develop --features python
+          fi
+      - name: Test installation
+        working-directory: python-bindings
+        run: uv run python tests/test_installation.py