violawake 0.1.0__tar.gz

violawake-0.1.0/.dockerignore

@@ -0,0 +1,41 @@
+# Git
+.git
+.gitignore
+
+# Node (frontend builds have their own Dockerfile)
+console/frontend/node_modules
+console/frontend/dist
+
+# Python caches
+__pycache__
+*.pyc
+*.pyo
+.pytest_cache
+.ruff_cache
+.coverage
+.benchmarks
+*.egg-info
+
+# IDE / editor
+.vscode
+.idea
+*.swp
+
+# Environment and secrets
+.env
+.env.*
+!.env.example
+
+# Docs and non-runtime files
+docs/
+*.md
+LICENSE
+CLAUDE.md
+
+# Test data (large)
+data/
+models/*.onnx
+
+# OS
+Thumbs.db
+.DS_Store

violawake-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,204 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main, develop]
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches: [master, main]
+  schedule:
+    - cron: "0 2 * * *"  # 2am UTC nightly
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_DEFAULT: "3.11"
+
+jobs:
+  # Job 1: Lint (ruff + mypy)
+  lint:
+    name: Lint
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_DEFAULT }}
+          cache: pip
+
+      - name: Install lint tools
+        # Only install lint tools — no pyaudio/portaudio needed for static analysis
+        run: |
+          pip install ruff mypy types-requests
+          pip install -e "." --no-deps || true
+          pip install onnxruntime numpy scipy
+          pip install openwakeword --no-deps
+
+      - name: Run ruff (lint)
+        run: ruff check src/
+
+      - name: Run ruff (format check)
+        run: ruff format --check src/
+
+      - name: Run mypy
+        # Mypy config in pyproject.toml: --strict for core SDK, training/tools excluded.
+        # Non-blocking: numpy/torch types cause noise in strict mode. Track error count down.
+        continue-on-error: true
+        run: mypy src/violawake_sdk --exclude 'training|tools'
+
+  # Job 2: Unit tests (all platforms x Python versions)
+  test-unit:
+    name: Unit tests (Python ${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-22.04, windows-2022, macos-14]
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      # PyAudio requires PortAudio headers.
+      - name: Install PortAudio (Linux)
+        if: runner.os == 'Linux'
+        run: sudo apt-get update && sudo apt-get install -y portaudio19-dev
+
+      - name: Install PortAudio (macOS)
+        if: runner.os == 'macOS'
+        run: brew install portaudio
+
+      - name: Install dependencies
+        # openwakeword is now an optional dep [oww]. Install it --no-deps to avoid
+        # tflite-runtime which has no Python 3.12 Linux wheels.
+        run: |
+          pip install openwakeword --no-deps
+          pip install onnxruntime numpy tqdm requests scipy
+          pip install -e ".[dev]"
+
+      - name: Smoke test install
+        run: |
+          python -c "from violawake_sdk import WakeDetector, __version__; print(f'violawake {__version__} OK')"
+
+      - name: Run unit tests
+        # Coverage floor: 50%. Hardware-dependent code (audio.py, pipeline.py) and
+        # CLI wrappers can't be tested without devices. Increase as mock tests are added.
+        run: pytest tests/unit/ -v --cov=violawake_sdk --cov-report=xml --cov-fail-under=50
+
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-22.04' && matrix.python-version == env.PYTHON_DEFAULT
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          flags: unit
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Job 3: Integration tests (main branch + PRs with [integration] label)
+  test-integration:
+    name: Integration tests
+    runs-on: ubuntu-22.04
+    if: github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'run-integration')
+    needs: [lint, test-unit]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_DEFAULT }}
+          cache: pip
+
+      - name: Install PortAudio
+        run: sudo apt-get install -y portaudio19-dev
+
+      - name: Install all extras
+        run: |
+          pip install openwakeword --no-deps
+          pip install -e ".[all,dev]" || pip install -e ".[audio,download,tts,stt,vad,training,generate,dev]"
+
+      - name: Cache models
+        uses: actions/cache@v4
+        id: model-cache
+        with:
+          path: ~/.violawake/models
+          key: violawake-models-v1-${{ hashFiles('src/violawake_sdk/models.py') }}
+
+      - name: Download models (if cache miss)
+        if: steps.model-cache.outputs.cache-hit != 'true'
+        run: |
+          violawake-download --model temporal_cnn
+          violawake-download --model kokoro_v1_0
+
+      - name: Run integration tests
+        run: pytest tests/integration/ -v -m integration --cov=violawake_sdk --cov-report=xml
+
+      - name: Upload integration coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          flags: integration
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  # Job 4: Benchmark regression check (nightly on main)
+  benchmark:
+    name: Benchmark regression check
+    runs-on: ubuntu-22.04
+    if: github.event_name == 'schedule' || (github.event_name == 'push' && (github.ref == 'refs/heads/master' || github.ref == 'refs/heads/main'))
+    needs: [test-unit]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_DEFAULT }}
+          cache: pip
+
+      - name: Install PortAudio
+        run: sudo apt-get install -y portaudio19-dev
+
+      - name: Install all extras
+        run: |
+          pip install openwakeword --no-deps
+          pip install -e ".[all,dev]" || pip install -e ".[audio,download,tts,stt,vad,training,generate,dev]"
+
+      - name: Cache models
+        uses: actions/cache@v4
+        with:
+          path: ~/.violawake/models
+          key: violawake-models-v1-${{ hashFiles('src/violawake_sdk/models.py') }}
+
+      - name: Download models
+        run: |
+          violawake-download --model temporal_cnn
+
+      - name: Run latency benchmarks
+        run: |
+          mkdir -p benchmark-results
+          pytest tests/benchmarks/bench_latency.py \
+            --benchmark-json=benchmark-results/latency-${{ github.sha }}.json
+
+      - name: Check for regressions
+        # --threshold 0.10 = fail if any benchmark regresses by more than 10%.
+        # This catches meaningful latency regressions while ignoring normal
+        # run-to-run variance on CI machines (typically ~5%).
+        run: python tools/benchmark_regression_check.py --threshold 0.10
+
+      - name: Upload benchmark results
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-results-${{ github.sha }}
+          path: benchmark-results/

violawake-0.1.0/.github/workflows/console-ci.yml

@@ -0,0 +1,124 @@
+name: Console CI
+
+on:
+  push:
+    branches: [main, develop]
+    paths:
+      - "console/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "console/**"
+
+concurrency:
+  group: console-ci-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHON_DEFAULT: "3.11"
+  NODE_DEFAULT: "20"
+
+jobs:
+  # --------------------------------------------------------------
+  # Job 1: Backend lint (ruff)
+  # --------------------------------------------------------------
+  backend-lint:
+    name: Backend lint
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_DEFAULT }}
+          cache: pip
+          cache-dependency-path: console/backend/requirements.txt
+
+      - name: Install lint dependencies
+        run: pip install ruff
+
+      - name: Run ruff (lint)
+        run: ruff check console/backend/
+
+      - name: Run ruff (format check)
+        run: ruff format --check console/backend/
+
+  # --------------------------------------------------------------
+  # Job 2: Backend tests
+  # --------------------------------------------------------------
+  backend-test:
+    name: Backend tests
+    runs-on: ubuntu-22.04
+    needs: [backend-lint]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_DEFAULT }}
+          cache: pip
+          cache-dependency-path: console/backend/requirements.txt
+
+      - name: Install test dependencies
+        run: pip install -r console/backend/requirements.txt pytest httpx
+
+      - name: Run backend tests
+        run: pytest console/tests/test_backend.py -v
+
+  # --------------------------------------------------------------
+  # Job 3: Frontend build
+  # --------------------------------------------------------------
+  frontend-build:
+    name: Frontend build
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        working-directory: console/frontend
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_DEFAULT }}
+          cache: npm
+          cache-dependency-path: console/frontend/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build frontend
+        run: npm run build
+
+      - name: Upload frontend artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: console-frontend-dist
+          path: console/frontend/dist/
+
+  # --------------------------------------------------------------
+  # Job 4: Frontend typecheck
+  # --------------------------------------------------------------
+  frontend-typecheck:
+    name: Frontend typecheck
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        working-directory: console/frontend
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_DEFAULT }}
+          cache: npm
+          cache-dependency-path: console/frontend/package-lock.json
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run TypeScript typecheck
+        run: npx tsc --noEmit

violawake-0.1.0/.github/workflows/model-verify.yml

@@ -0,0 +1,89 @@
+name: Model Verification
+
+on:
+  # Weekly on Monday at 06:00 UTC
+  schedule:
+    - cron: "0 6 * * 1"
+  # On changes to model registry or this workflow
+  push:
+    branches: [main, develop]
+    paths:
+      - "src/violawake_sdk/models.py"
+      - ".github/workflows/model-verify.yml"
+  pull_request:
+    branches: [main]
+    paths:
+      - "src/violawake_sdk/models.py"
+      - ".github/workflows/model-verify.yml"
+  # Manual trigger
+  workflow_dispatch:
+
+concurrency:
+  group: model-verify-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify-models:
+    name: Verify models (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          pip install -e ".[download]"
+          pip install onnxruntime
+
+      - name: Warn on placeholder hashes
+        run: |
+          python - <<'PY'
+          from violawake_sdk.models import MODEL_REGISTRY
+
+          seen = set()
+          placeholders = []
+          for name, spec in MODEL_REGISTRY.items():
+              if spec.name in seen:
+                  continue
+              seen.add(spec.name)
+              if spec.sha256.startswith("PLACEHOLDER"):
+                  placeholders.append(name)
+
+          if placeholders:
+              models = ", ".join(placeholders)
+              print(f"::warning::Placeholder SHA-256 values detected. Hash verification will be skipped for: {models}")
+          else:
+              print("All model hashes are populated.")
+          PY
+
+      - name: Cache downloaded models
+        uses: actions/cache@v4
+        id: model-cache
+        with:
+          path: ~/.violawake/models
+          key: model-verify-v1-${{ hashFiles('src/violawake_sdk/models.py') }}
+          restore-keys: |
+            model-verify-v1-
+
+      - name: Verify all models
+        run: python scripts/verify_models.py --ci
+        env:
+          VIOLAWAKE_MODEL_DIR: ~/.violawake/models
+
+      - name: Upload verification report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: model-verification-py${{ matrix.python-version }}
+          path: model-verify-report.json
+          retention-days: 30

violawake-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,179 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+permissions:
+  contents: write  # for GitHub Release creation
+  id-token: write  # for PyPI trusted publishing (OIDC)
+
+jobs:
+  # ──────────────────────────────────────────────
+  # Job 1: Validate the release
+  # ──────────────────────────────────────────────
+  validate:
+    name: Validate release tag
+    runs-on: ubuntu-22.04
+    outputs:
+      version: ${{ steps.extract-version.outputs.version }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extract version from tag
+        id: extract-version
+        run: |
+          TAG="${GITHUB_REF#refs/tags/v}"
+          echo "version=${TAG}" >> "$GITHUB_OUTPUT"
+          echo "Release version: ${TAG}"
+
+      - name: Verify version matches pyproject.toml
+        run: |
+          PYPROJECT_VERSION=$(python -c "
+          try:
+              import tomllib
+          except ImportError:
+              import tomli as tomllib
+          d=tomllib.load(open('pyproject.toml','rb')); print(d['project']['version'])")
+          TAG_VERSION="${{ steps.extract-version.outputs.version }}"
+          if [ "$PYPROJECT_VERSION" != "$TAG_VERSION" ]; then
+            echo "ERROR: pyproject.toml version ($PYPROJECT_VERSION) != tag ($TAG_VERSION)"
+            exit 1
+          fi
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install PortAudio
+        run: sudo apt-get install -y portaudio19-dev
+
+      - name: Install and run full test suite
+        run: |
+          pip install -e ".[dev]"
+          pytest tests/unit/ -v --cov=violawake_sdk --cov-fail-under=65
+
+  # ──────────────────────────────────────────────
+  # Job 2: Build distribution artifacts
+  # ──────────────────────────────────────────────
+  build:
+    name: Build wheel + sdist
+    runs-on: ubuntu-22.04
+    needs: validate
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install hatch
+        run: pip install hatch
+
+      - name: Build wheel and sdist
+        run: hatch build
+
+      - name: Verify wheel contents
+        run: |
+          pip install twine
+          twine check dist/*
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-artifacts
+          path: dist/
+
+  # ──────────────────────────────────────────────
+  # Job 3: Create GitHub Release with model assets
+  # ──────────────────────────────────────────────
+  github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-22.04
+    needs: [validate, build]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-artifacts
+          path: dist/
+
+      - name: Fetch model files from model artifact store
+        # Models are stored in a private artifact store (not in git).
+        # This step retrieves the models for the current version and
+        # attaches them to the GitHub Release.
+        env:
+          MODEL_STORE_TOKEN: ${{ secrets.MODEL_STORE_TOKEN }}
+        run: |
+          python tools/fetch_release_models.py \
+            --version ${{ needs.validate.outputs.version }} \
+            --output models/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ViolaWake SDK ${{ needs.validate.outputs.version }}
+          body_path: RELEASE_NOTES.md
+          draft: false
+          prerelease: ${{ contains(needs.validate.outputs.version, 'rc') || contains(needs.validate.outputs.version, 'alpha') || contains(needs.validate.outputs.version, 'beta') }}
+          files: |
+            dist/*.whl
+            dist/*.tar.gz
+            models/*.onnx
+
+  # ──────────────────────────────────────────────
+  # Job 4: Publish to PyPI (trusted publishing via OIDC)
+  # ──────────────────────────────────────────────
+  pypi-publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-22.04
+    needs: [validate, build, github-release]
+    environment: pypi  # required for OIDC trusted publishing
+
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-artifacts
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # Uses OIDC trusted publishing — no API token needed if configured
+        # in PyPI project settings. See:
+        # https://docs.pypi.org/trusted-publishers/
+
+  # ──────────────────────────────────────────────
+  # Job 5: Update model registry SHA-256s in docs
+  # ──────────────────────────────────────────────
+  update-docs:
+    name: Update model registry
+    runs-on: ubuntu-22.04
+    needs: github-release
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Update model SHA-256s in models.py
+        run: |
+          python tools/update_model_registry.py \
+            --version ${{ needs.validate.outputs.version }}
+
+      - name: Commit updated registry
+        run: |
+          git config user.name "ViolaWake Release Bot"
+          git config user.email "bot@violawake.dev"
+          git add src/violawake_sdk/models.py
+          git commit -m "chore: update model registry for v${{ needs.validate.outputs.version }}" || echo "No changes to commit"
+          git push origin main