truthound-dashboard 1.0.0__tar.gz

truthound_dashboard-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,214 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff black mypy
+
+      - name: Check formatting with Black
+        run: black --check src tests
+
+      - name: Lint with Ruff
+        run: ruff check src tests
+
+  test:
+    name: Test Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["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: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests with pytest
+        run: pytest --cov=truthound_dashboard --cov-report=xml --cov-report=term-missing -v
+
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.11'
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  build-frontend:
+    name: Build Frontend
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: "npm"
+          cache-dependency-path: frontend/package-lock.json
+
+      - name: Install dependencies
+        working-directory: frontend
+        run: npm ci
+
+      - name: Type check
+        working-directory: frontend
+        run: npm run type-check
+
+      - name: Lint
+        working-directory: frontend
+        run: npm run lint
+
+      - name: Build
+        working-directory: frontend
+        run: npm run build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: frontend-build
+          path: src/truthound_dashboard/static
+          retention-days: 7
+
+  e2e:
+    name: E2E Tests
+    runs-on: ubuntu-latest
+    needs: [build-frontend]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+
+      - name: Install backend dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Download frontend build
+        uses: actions/download-artifact@v4
+        with:
+          name: frontend-build
+          path: src/truthound_dashboard/static
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          cache: "npm"
+          cache-dependency-path: frontend/package-lock.json
+
+      - name: Install Playwright
+        working-directory: frontend
+        run: |
+          npm ci
+          npx playwright install --with-deps chromium
+
+      - name: Run E2E tests
+        working-directory: frontend
+        run: npx playwright test
+        env:
+          CI: true
+
+      - name: Upload Playwright report
+        uses: actions/upload-artifact@v4
+        if: failure()
+        with:
+          name: playwright-report
+          path: frontend/playwright-report/
+          retention-days: 7
+
+  security:
+    name: Security Scan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pip-audit bandit
+
+      - name: Run pip-audit
+        run: pip-audit || true
+        continue-on-error: true
+
+      - name: Run Bandit security scan
+        run: bandit -r src/truthound_dashboard -ll -ii || true
+        continue-on-error: true
+
+  build-package:
+    name: Build Package
+    runs-on: ubuntu-latest
+    needs: [lint, test, build-frontend]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Download frontend build
+        uses: actions/download-artifact@v4
+        with:
+          name: frontend-build
+          path: src/truthound_dashboard/static
+
+      - name: Install build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Upload package artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          retention-days: 7

truthound_dashboard-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build and Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+
+      - name: Install frontend dependencies
+        working-directory: frontend
+        run: npm ci
+
+      - name: Build frontend
+        working-directory: frontend
+        run: npm run build
+
+      - name: Install Python build tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: dist/*
+          generate_release_notes: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

truthound_dashboard-1.0.0/.github/workflows/trigger-docs.yml

@@ -0,0 +1,16 @@
+# Trigger truthound docs site rebuild when dashboard docs change
+name: Trigger Docs Build
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+
+jobs:
+  trigger:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger Netlify build
+        run: |
+          curl -X POST -d {} "${{ secrets.NETLIFY_DOCS_BUILD_HOOK }}"

truthound_dashboard-1.0.0/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+/lib/
+/lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+Pipfile.lock
+
+# PEP 582
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# VS Code
+.vscode/
+
+# IDE
+.idea/
+*.swp
+*.swo
+
+# Node
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Frontend build output (handled by build process)
+# src/truthound_dashboard/static/
+
+# Local development
+.truthound/
+*.db
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Test
+.pytest_cache/
+htmlcov/
+
+# Claude
+.claude/
+CLAUDE.md

truthound_dashboard-1.0.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: truthound-dashboard
+Version: 1.0.0
+Summary: Open-source data quality dashboard - GX Cloud alternative
+Author-email: Truthound Team <team@truthound.dev>
+License-Expression: MIT
+Keywords: dashboard,data-quality,monitoring,truthound,validation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Requires-Dist: aiosmtplib>=3.0.0
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: apscheduler>=3.10.0
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: fastapi>=0.110.0
+Requires-Dist: httpx>=0.26.0
+Requires-Dist: polars>=0.20.0
+Requires-Dist: pydantic-settings>=2.1.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: sqlalchemy[asyncio]>=2.0.0
+Requires-Dist: truthound>=1.0.5
+Requires-Dist: typer>=0.9.0
+Requires-Dist: uvicorn[standard]>=0.27.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: httpx>=0.26.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# truthound-dashboard
+
+A web-based data quality monitoring dashboard for [truthound](https://github.com/seadonggyun4/truthound).
+
+[Documentation](https://truthound.netlify.app) | [Live Demo](https://truthound-dashboard.netlify.app)
+
+## Overview
+
+truthound-dashboard provides a graphical interface for managing data sources, executing validations, tracking historical results, scheduling automated checks, and configuring notifications. It serves as an alternative to commercial data quality platforms.
+
+## Feature Comparison with GX Cloud
+
+| Feature | GX Cloud (Paid) | truthound-dashboard |
+|---------|-----------------|---------------------|
+| Data Source Management | Available | Available |
+| Schema Learning | Available | Available |
+| Validation Execution | Available | Available |
+| Validation History | Available | Available |
+| Scheduled Validations | Available | Available |
+| Slack Notifications | Available | Available |
+| Email Notifications | Available | Available |
+| Webhook Notifications | Available | Available |
+| Drift Detection | Available | Available |
+| Data Profiling | Available | Available |
+| Dark Mode | Available | Available |
+| Multi-language (en/ko) | Not Available | Available |
+| License | Commercial | MIT |
+
+## Requirements
+
+- Python 3.11 or higher
+- truthound >= 1.0.5
+
+## Installation
+
+```bash
+pip install truthound-dashboard
+```
+
+This command automatically installs [truthound](https://github.com/seadonggyun4/truthound) as a dependency.
+
+## Usage
+
+```bash
+# Start the dashboard server (default port: 8765)
+truthound serve
+
+# Specify a custom port
+truthound serve --port 9000
+
+# Enable development mode with hot reload
+truthound serve --reload
+
+# Disable automatic browser opening
+truthound serve --no-browser
+```
+
+The dashboard interface is accessible at `http://localhost:8765`.
+
+## Implemented Features
+
+### Data Source Management
+- Supported file formats: CSV, Parquet
+- Supported databases: PostgreSQL, MySQL, Snowflake, BigQuery
+- Connection validation
+
+### Schema Management
+- Automated schema generation using `th.learn`
+- Manual schema editing in YAML format
+
+### Validation
+- On-demand validation execution using `th.check`
+- Persistent storage of validation results
+- Issue classification by severity (Critical, High, Medium, Low)
+
+### Validation History
+- Historical record of validation results
+- Trend visualization
+
+### Scheduling
+- Cron-based scheduling using APScheduler
+- Schedule controls: pause, resume, immediate execution
+
+### Notifications
+- Supported channels: Slack, Email, Webhook
+- Configurable notification rules based on validation outcomes
+- Notification delivery logs
+
+### Drift Detection
+- Dataset comparison using `th.compare`
+- Column-level drift analysis
+
+### Data Profiling
+- Statistical profiling using `th.profile`
+- Column-level statistics
+
+### User Interface
+- Light and dark theme support
+- Internationalization: English, Korean
+
+## Technology Stack
+
+**Backend**
+- FastAPI
+- SQLAlchemy 2.0 (async)
+- SQLite with aiosqlite
+- APScheduler
+- Pydantic 2.x
+
+**Frontend**
+- React 18
+- TypeScript
+- Vite
+- TailwindCSS
+- shadcn/ui
+- Zustand
+- i18next
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/seadonggyun4/truthound-dashboard
+cd truthound-dashboard
+
+# Install backend dependencies
+pip install -e ".[dev]"
+
+# Start the backend server
+truthound serve --reload
+
+# In a separate terminal, install frontend dependencies
+cd frontend
+npm install
+
+# Start the frontend development server
+npm run dev
+
+# Alternative: run with mock API (backend not required)
+npm run dev:mock
+```
+
+## Testing
+
+```bash
+# Run tests
+pytest
+
+# Run tests with coverage report
+pytest --cov=truthound_dashboard
+```
+
+## Live Demo
+
+A live demonstration is available at [https://truthound-dashboard.netlify.app](https://truthound-dashboard.netlify.app).
+
+The demo instance operates using Mock Service Worker (MSW) with simulated data and does not require a backend connection.
+
+## Documentation
+
+Full documentation is available at [https://truthound.netlify.app](https://truthound.netlify.app).
+
+- [Getting Started](./docs/getting-started.md)
+- [Features](./docs/features.md)
+- [API Reference](./docs/api.md)
+- [Configuration](./docs/configuration.md)
+
+## Related Projects
+
+- [truthound](https://github.com/seadonggyun4/truthound) - Core data validation library
+- [truthound-orchestration](https://github.com/seadonggyun4/truthound-orchestration) - Pipeline orchestration integration
+
+## License
+
+This project is licensed under the MIT License.