dash-dq 0.1.1__tar.gz

dash_dq-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install ruff
+      - run: ruff check dashdq/
+
+  test:
+    runs-on: ubuntu-latest
+    needs: lint
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: pip install -e ".[dev]" pytest pytest-cov
+      - name: Test
+        run: pytest tests/ -v --cov=dashdq --cov-report=xml
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install hatch
+      - run: hatch build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

dash_dq-0.1.1/.github/workflows/daily.yml

@@ -0,0 +1,33 @@
+name: Daily Tests
+
+on:
+  schedule:
+    - cron: "0 6 * * *"   # Every day 06:00 UTC — tests only, no commit
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: pip install -e ".[dev]" pytest pytest-cov
+
+      - name: Run tests
+        run: pytest tests/ -v --cov=dashdq --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false

dash_dq-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,280 @@
+name: Weekly Release
+
+on:
+  schedule:
+    - cron: "0 9 * * 1"   # Every Monday 09:00 UTC
+  workflow_dispatch:
+    inputs:
+      release_note:
+        description: "Optional release note (shown in GitHub release body)"
+        required: false
+        default: ""
+
+jobs:
+  # ── Gate: tests must pass ────────────────────────────────────────────────
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        run: pip install -e ".[dev]" pytest pytest-cov
+
+      - name: Run tests
+        run: pytest tests/ -v --cov=dashdq --cov-report=xml --cov-report=term-missing
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage.xml
+          fail_ci_if_error: false
+
+  # ── Generate docs ────────────────────────────────────────────────────────
+  docs:
+    name: Generate API docs
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install
+        run: pip install -e ".[dev]" pdoc
+
+      - name: Generate docs
+        run: |
+          pdoc dashdq --output-dir docs/api --docformat google
+          echo "Docs generated at $(date -u)" > docs/api/.generated
+
+      - name: Upload docs artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: api-docs
+          path: docs/api/
+
+  # ── Release: tag, GitHub release, commit docs ────────────────────────────
+  release:
+    name: Bump version & release
+    runs-on: ubuntu-latest
+    needs: [test, docs]
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.bump.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.RELEASE_TOKEN }}
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install hatch pdoc
+
+      - name: Bump patch version
+        id: bump
+        run: |
+          python3 - << 'PYEOF'
+          import re, os
+
+          # Read current version from pyproject.toml
+          with open("pyproject.toml") as f:
+              content = f.read()
+          m = re.search(r'^version\s*=\s*"([^"]+)"', content, re.MULTILINE)
+          current = m.group(1)
+          major, minor, patch = current.split(".")
+          new = f"{major}.{minor}.{int(patch)+1}"
+
+          # Update pyproject.toml
+          new_content = re.sub(
+              r'^(version\s*=\s*")[^"]+(")',
+              rf'\g<1>{new}\g<2>',
+              content, flags=re.MULTILINE
+          )
+          with open("pyproject.toml", "w") as f:
+              f.write(new_content)
+
+          # Update __init__.py
+          with open("dashdq/__init__.py") as f:
+              init = f.read()
+          init = re.sub(r'__version__\s*=\s*"[^"]+"', f'__version__ = "{new}"', init)
+          with open("dashdq/__init__.py", "w") as f:
+              f.write(init)
+
+          # Write outputs
+          with open(os.environ["GITHUB_OUTPUT"], "a") as f:
+              f.write(f"version={new}\n")
+              f.write(f"prev_version={current}\n")
+          print(f"Bumped {current} → {new}")
+          PYEOF
+
+      - name: Regenerate docs into repo
+        run: |
+          pip install -e ".[dev]"
+          pdoc dashdq --output-dir docs/api --docformat google
+
+      - name: Build wheel + sdist
+        run: hatch build
+
+      - name: Write release notes
+        env:
+          VERSION: ${{ steps.bump.outputs.version }}
+          PREV_VERSION: ${{ steps.bump.outputs.prev_version }}
+          RELEASE_NOTE: ${{ github.event.inputs.release_note }}
+        run: |
+          cat > RELEASE_NOTES.md << EOF
+          ## DashDQ v${VERSION}
+
+          **Released:** $(date -u '+%Y-%m-%d')
+          **Previous:** v${PREV_VERSION}
+
+          $( [ -n "${RELEASE_NOTE}" ] && echo "### Notes" && echo "${RELEASE_NOTE}" || true )
+
+          ### What's included
+          - All tests passing across Python 3.9, 3.10, 3.11, 3.12
+          - API documentation regenerated (see \`docs/api/\`)
+          - Published to PyPI and Databricks Marketplace
+
+          ### Install
+          \`\`\`bash
+          pip install dash-dq==${VERSION}
+          \`\`\`
+
+          ### Quick Start (Databricks notebook)
+          \`\`\`python
+          %pip install dash-dq==${VERSION}
+          import dashdq
+          dashdq.launch()
+          \`\`\`
+          EOF
+
+      - name: Commit version bump + docs
+        env:
+          VERSION: ${{ steps.bump.outputs.version }}
+          RELEASE_TOKEN: ${{ secrets.RELEASE_TOKEN }}
+        run: |
+          git config user.name "Darshan Shah"
+          git config user.email "darshan.innovation@gmail.com"
+          git remote set-url origin "https://${RELEASE_TOKEN}@github.com/dash-libs/dash-dq.git"
+          git add .
+          git commit -m "release: v${VERSION} — tests passed, docs updated"
+          git tag "v${VERSION}"
+          git push origin HEAD:main --tags
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: "v${{ steps.bump.outputs.version }}"
+          body_path: RELEASE_NOTES.md
+          files: dist/*
+
+      - name: Upload dist artifact for PyPI job
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  # ── Publish to PyPI (Trusted Publisher / OIDC — no token needed) ─────────
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: release
+    permissions:
+      id-token: write   # required for OIDC trusted publisher
+    environment:
+      name: pypi
+      url: https://pypi.org/project/dash-dq
+    steps:
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  # ── Package for Databricks Marketplace ───────────────────────────────────
+  publish-databricks:
+    name: Package for Databricks Marketplace
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: "v${{ needs.release.outputs.version }}"
+
+      - name: Download dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Build Marketplace bundle
+        env:
+          VERSION: ${{ needs.release.outputs.version }}
+        run: |
+          mkdir -p marketplace-bundle/files
+
+          # Copy wheel
+          cp dist/*.whl marketplace-bundle/files/
+
+          # Generate companion notebook
+          cat > marketplace-bundle/files/DashDQ_Quickstart.py << NBEOF
+          # Databricks notebook source
+          # MAGIC %md
+          # MAGIC # DashDQ v${VERSION} — Data Quality for Databricks
+          # MAGIC Install and launch the interactive UI.
+
+          # COMMAND ----------
+          # MAGIC %pip install dash-dq==${VERSION}
+
+          # COMMAND ----------
+          dbutils.library.restartPython()
+
+          # COMMAND ----------
+          import dashdq
+          dashdq.launch()
+          NBEOF
+
+          # Generate listing metadata
+          cat > marketplace-bundle/listing.json << LEOF
+          {
+            "listing_name": "DashDQ — Data Quality",
+            "version": "${VERSION}",
+            "short_description": "Interactive data quality checks for business users on Databricks",
+            "long_description": "DashDQ provides an ipywidgets UI inside Databricks notebooks to run data quality checks on DataFrames, Unity Catalog tables, and SQL queries. No coding required for business users.",
+            "categories": ["Data Quality", "Data Engineering"],
+            "tags": ["data-quality", "databricks", "unity-catalog", "pyspark"],
+            "provider": "dash-libs",
+            "documentation_url": "https://github.com/dash-libs/dash-dq",
+            "source_url": "https://github.com/dash-libs/dash-dq",
+            "pypi_package": "dash-dq==${VERSION}"
+          }
+          LEOF
+
+          # Zip the bundle
+          cd marketplace-bundle && zip -r ../dashdq-marketplace-${VERSION}.zip .
+          echo "Bundle created: dashdq-marketplace-${VERSION}.zip"
+
+      - name: Upload Marketplace bundle artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: marketplace-bundle
+          path: dashdq-marketplace-*.zip
+          retention-days: 90

dash_dq-0.1.1/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.coverage
+coverage.xml
+.pytest_cache/
+.ruff_cache/

dash_dq-0.1.1/CLAUDE.md

@@ -0,0 +1,31 @@
+# CLAUDE.md — dash-dq
+
+Part of the **Dashlibs** suite. See ~/dashlibs for the full context.
+
+## Purpose
+Data quality checks on Databricks — DataFrames, UC tables, SQL queries.  
+Business users use `dashdq.launch()` for a widget UI. Engineers use `DQSuite` directly.
+
+## Structure
+- `dashdq/ui.py` — ipywidgets UI, `launch()` entrypoint
+- `dashdq/checks.py` — individual check functions, each returns `CheckResult`
+- `dashdq/suite.py` — `DQSuite` (fluent API) and `DQReport`
+- `tests/` — pytest, no Spark dependency for unit tests
+
+## Key Design Rules
+- New checks go in `checks.py` as standalone functions returning `CheckResult`
+- `DQSuite` maps rule dicts → check functions; the UI builds those dicts
+- `DQReport.save()` appends to a Delta table — always use `mode("append")`
+- Never import Spark at module level — always inside functions
+
+## CI
+- `ci.yml` — runs on every PR: lint (ruff) → test (py3.9–3.12) → build
+- `daily.yml` — runs at 06:00 UTC daily: tests + appends to `.health/log.txt`
+- `release.yml` — runs Monday 09:00 UTC: bumps patch version, tags, releases
+
+## Adding a New Check
+1. Add function to `checks.py` returning `CheckResult`
+2. Add `expect_<name>` method to `DQSuite`
+3. Add rule type handling in `DQSuite.run()`
+4. Add dropdown option to `ui.py` and `_build_rule()`
+5. Add test in `tests/test_suite.py`