dcap-qvl 0.3.0__tar.gz

dcap_qvl-0.3.0/.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
+   ./scripts/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.0/.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.0/.github/workflows/python-wheels.yml

@@ -0,0 +1,235 @@
+name: Build and Publish Python Wheels
+
+on:
+  push:
+    tags:
+      - "v*"
+    branches:
+      - "python-bindings" # For testing
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build-wheels:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - 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@v4
+        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@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - 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@v4
+        with:
+          name: wheels-windows
+          path: python-bindings/dist
+
+  # macOS Intel build using native runner (Zig cross-compilation has issues)
+  macos-intel:
+    runs-on: macos-13 # Intel runner
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - 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@v4
+        with:
+          name: wheels-macos-x86_64
+          path: python-bindings/dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - 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@v4
+        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/')
+    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@v4
+        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'
+    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@v4
+        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@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Setup Python ${{ matrix.python-version }}
+        run: uv venv --python ${{ matrix.python-version }}
+      - name: Download wheels
+        uses: actions/download-artifact@v4
+        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 scripts/test_installation.py

dcap_qvl-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,163 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release (e.g., 0.3.1)"
+        required: true
+        type: string
+      prerelease:
+        description: "Is this a prerelease?"
+        required: false
+        type: boolean
+        default: false
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  create-release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    outputs:
+      release-id: ${{ steps.create-release.outputs.id }}
+      upload-url: ${{ steps.create-release.outputs.upload_url }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get version
+        id: get-version
+        run: |
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            VERSION="${{ github.event.inputs.version }}"
+          else
+            VERSION=${GITHUB_REF#refs/tags/v}
+          fi
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "tag=v${VERSION}" >> $GITHUB_OUTPUT
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          # Simple changelog generation - you can enhance this
+          if git tag --list | grep -q "v"; then
+            PREVIOUS_TAG=$(git tag --list "v*" --sort=-version:refname | head -n2 | tail -n1)
+            if [[ -n "$PREVIOUS_TAG" ]]; then
+              CHANGELOG=$(git log ${PREVIOUS_TAG}..HEAD --pretty=format:"- %s" --no-merges)
+            else
+              CHANGELOG=$(git log --pretty=format:"- %s" --no-merges)
+            fi
+          else
+            CHANGELOG=$(git log --pretty=format:"- %s" --no-merges)
+          fi
+
+          # Save changelog to file
+          cat > changelog.md << EOF
+          ## Changes in ${{ steps.get-version.outputs.tag }}
+
+          ${CHANGELOG}
+
+          ## Python Package
+
+          This release includes Python wheels for multiple platforms:
+          - Linux: x86_64, x86, aarch64, armv7, s390x, ppc64le
+          - Windows: x64, x86
+          - macOS: x86_64, aarch64 (Apple Silicon)
+
+          Install with: \`pip install dcap-qvl==${{ steps.get-version.outputs.version }}\`
+
+          ## Rust Crate
+
+          Add to your \`Cargo.toml\`:
+          \`\`\`toml
+          dcap-qvl = "${{ steps.get-version.outputs.version }}"
+          \`\`\`
+          EOF
+
+      - name: Create Release
+        id: create-release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.get-version.outputs.tag }}
+          release_name: Release ${{ steps.get-version.outputs.tag }}
+          body_path: changelog.md
+          draft: false
+          prerelease: ${{ github.event.inputs.prerelease || false }}
+
+  build-rust:
+    name: Build Rust Binaries
+    needs: create-release
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+            artifact-name: dcap-qvl-linux-x86_64
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+            artifact-name: dcap-qvl-linux-x86_64-musl
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+            artifact-name: dcap-qvl-windows-x86_64.exe
+          - os: macos-latest
+            target: x86_64-apple-darwin
+            artifact-name: dcap-qvl-macos-x86_64
+          - os: macos-latest
+            target: aarch64-apple-darwin
+            artifact-name: dcap-qvl-macos-aarch64
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.target }}
+
+      - name: Install musl tools
+        if: matrix.target == 'x86_64-unknown-linux-musl'
+        run: sudo apt-get install -y musl-tools
+
+      - name: Build CLI
+        run: |
+          cd cli
+          cargo build --release --target ${{ matrix.target }}
+
+      - name: Upload CLI Binary
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create-release.outputs.upload-url }}
+          asset_path: cli/target/${{ matrix.target }}/release/dcap-qvl${{ contains(matrix.target, 'windows') && '.exe' || '' }}
+          asset_name: ${{ matrix.artifact-name }}
+          asset_content_type: application/octet-stream
+
+  publish-crates:
+    name: Publish to crates.io
+    needs: create-release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Publish dcap-qvl crate
+        run: cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}
+        continue-on-error: true # Don't fail if already published
+
+      - name: Publish dcap-qvl-cli crate
+        run: |
+          cd cli
+          cargo publish --token ${{ secrets.CRATES_IO_TOKEN }}
+        continue-on-error: true # Don't fail if already published

dcap_qvl-0.3.0/.github/workflows/rust.yml

@@ -0,0 +1,56 @@
+name: Rust
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build
+      run: cargo build --verbose
+    - name: Run tests
+      run: cargo test --verbose
+
+  wasm:
+    name: Check WebAssembly target
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Add wasm32 target
+        run: rustup target add wasm32-unknown-unknown
+      - name: Check wasm32 build
+        run: cargo check --target wasm32-unknown-unknown --features js
+
+  format:
+    name: Format code
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Format code
+        run: cargo fmt --all -- --check
+
+  clippy:
+    name: Check code with clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check code with clippy
+        run: cargo clippy --all
+
+  clippy-cli:
+    name: Check cli code with clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check cli code with clippy
+        run: cd cli && cargo clippy --all

dcap_qvl-0.3.0/.gitignore

@@ -0,0 +1,3 @@
+Cargo.lock
+target/
+.claude/