chops 0.1.0__tar.gz

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

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Lint
+        run: |
+          ruff check src/ tests/
+          ruff format --check src/ tests/
+
+      - name: Type check
+        run: mypy src/
+
+      - name: Test
+        run: pytest -v

chops-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/chops
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

chops-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+*.egg
+.env

chops-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antonio Mello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

chops-0.1.0/PKG-INFO

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: chops
+Version: 0.1.0
+Summary: ClickHouse Operations CLI — health checks, data quality profiling, and observability
+Project-URL: Homepage, https://github.com/antonio-mello-ai/chops
+Project-URL: Repository, https://github.com/antonio-mello-ai/chops
+Project-URL: Issues, https://github.com/antonio-mello-ai/chops/issues
+Author-email: Antonio Mello <antonio.mello@felhen.com.br>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,clickhouse,data-quality,database,observability,operations
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Requires-Dist: clickhouse-connect>=0.7
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# chops
+
+ClickHouse Operations CLI — health checks, data quality profiling, and observability from your terminal.
+
+No more copy-pasting system table queries. One command to check cluster health, profile data quality, or find slow queries.
+
+## Quick Start
+
+```bash
+# Run directly with uvx (no install needed)
+uvx chops health summary
+
+# Or install with pip
+pip install chops
+```
+
+## Configuration
+
+Set environment variables or pass flags:
+
+```bash
+export CLICKHOUSE_HOST=localhost
+export CLICKHOUSE_PORT=8123
+export CLICKHOUSE_USER=default
+export CLICKHOUSE_PASSWORD=
+```
+
+Or use flags: `chops --host myserver --user admin health summary`
+
+## Commands
+
+### Health & Observability
+
+| Command | Description |
+|---------|-------------|
+| `chops health summary` | Cluster overview: version, uptime, databases, tables, parts, merges, queries |
+| `chops health table-sizes` | Disk usage by table, sorted by size |
+| `chops health slow-queries` | Top N slowest queries from query log |
+| `chops health merges` | Currently running merge operations |
+| `chops health running-queries` | Active queries with elapsed time and memory |
+
+### Data Quality
+
+| Command | Description |
+|---------|-------------|
+| `chops dq profile <table>` | Column-level profiling: null rates, cardinality, min/max |
+| `chops dq check <table>` | Run quality checks with configurable thresholds (CI-friendly exit codes) |
+| `chops dq freshness <table>` | Time since last row — OK/WARNING/CRITICAL with exit codes |
+
+## Examples
+
+```bash
+# Quick cluster health check
+chops health summary
+
+# Find which tables are eating disk
+chops health table-sizes --limit 10
+
+# Slowest queries in the last 6 hours
+chops health slow-queries --hours 6
+
+# Profile a table's data quality
+chops dq profile mydb.events
+
+# Run quality checks in CI (non-zero exit on failure)
+chops dq check mydb.events --max-null-pct 5 --min-rows 1000
+
+# Check if a streaming table is still receiving data
+chops dq freshness mydb.events --warn 60 --critical 1440
+
+# JSON output for automation
+chops dq profile mydb.events --output json
+```
+
+## CI/CD Integration
+
+`chops dq check` and `chops dq freshness` return non-zero exit codes on failure, making them usable in CI pipelines:
+
+```yaml
+- name: Data quality gate
+  run: |
+    chops dq check production.orders --max-null-pct 2 --min-rows 10000
+    chops dq freshness production.orders --warn 30 --critical 120
+```
+
+## Development
+
+```bash
+git clone https://github.com/antonio-mello-ai/chops.git
+cd chops
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/
+```
+
+## License
+
+MIT

chops-0.1.0/README.md

@@ -0,0 +1,107 @@
+# chops
+
+ClickHouse Operations CLI — health checks, data quality profiling, and observability from your terminal.
+
+No more copy-pasting system table queries. One command to check cluster health, profile data quality, or find slow queries.
+
+## Quick Start
+
+```bash
+# Run directly with uvx (no install needed)
+uvx chops health summary
+
+# Or install with pip
+pip install chops
+```
+
+## Configuration
+
+Set environment variables or pass flags:
+
+```bash
+export CLICKHOUSE_HOST=localhost
+export CLICKHOUSE_PORT=8123
+export CLICKHOUSE_USER=default
+export CLICKHOUSE_PASSWORD=
+```
+
+Or use flags: `chops --host myserver --user admin health summary`
+
+## Commands
+
+### Health & Observability
+
+| Command | Description |
+|---------|-------------|
+| `chops health summary` | Cluster overview: version, uptime, databases, tables, parts, merges, queries |
+| `chops health table-sizes` | Disk usage by table, sorted by size |
+| `chops health slow-queries` | Top N slowest queries from query log |
+| `chops health merges` | Currently running merge operations |
+| `chops health running-queries` | Active queries with elapsed time and memory |
+
+### Data Quality
+
+| Command | Description |
+|---------|-------------|
+| `chops dq profile <table>` | Column-level profiling: null rates, cardinality, min/max |
+| `chops dq check <table>` | Run quality checks with configurable thresholds (CI-friendly exit codes) |
+| `chops dq freshness <table>` | Time since last row — OK/WARNING/CRITICAL with exit codes |
+
+## Examples
+
+```bash
+# Quick cluster health check
+chops health summary
+
+# Find which tables are eating disk
+chops health table-sizes --limit 10
+
+# Slowest queries in the last 6 hours
+chops health slow-queries --hours 6
+
+# Profile a table's data quality
+chops dq profile mydb.events
+
+# Run quality checks in CI (non-zero exit on failure)
+chops dq check mydb.events --max-null-pct 5 --min-rows 1000
+
+# Check if a streaming table is still receiving data
+chops dq freshness mydb.events --warn 60 --critical 1440
+
+# JSON output for automation
+chops dq profile mydb.events --output json
+```
+
+## CI/CD Integration
+
+`chops dq check` and `chops dq freshness` return non-zero exit codes on failure, making them usable in CI pipelines:
+
+```yaml
+- name: Data quality gate
+  run: |
+    chops dq check production.orders --max-null-pct 2 --min-rows 10000
+    chops dq freshness production.orders --warn 30 --critical 120
+```
+
+## Development
+
+```bash
+git clone https://github.com/antonio-mello-ai/chops.git
+cd chops
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/
+```
+
+## License
+
+MIT

chops-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "chops"
+version = "0.1.0"
+description = "ClickHouse Operations CLI — health checks, data quality profiling, and observability"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [{ name = "Antonio Mello", email = "antonio.mello@felhen.com.br" }]
+keywords = ["clickhouse", "cli", "data-quality", "observability", "database", "operations"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: System :: Monitoring",
+]
+dependencies = [
+    "clickhouse-connect>=0.7",
+    "rich>=13.0",
+    "typer>=0.12",
+]
+
+[project.scripts]
+chops = "chops.cli:app"
+
+[project.urls]
+Homepage = "https://github.com/antonio-mello-ai/chops"
+Repository = "https://github.com/antonio-mello-ai/chops"
+Issues = "https://github.com/antonio-mello-ai/chops/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=1.0",
+    "mypy>=1.11",
+    "ruff>=0.6",
+]
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "SIM", "B", "A", "C4", "RET", "PIE"]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

chops-0.1.0/src/chops/__init__.py

@@ -0,0 +1,3 @@
+"""chops — ClickHouse Operations CLI."""
+
+__version__ = "0.1.0"

chops-0.1.0/src/chops/cli.py

@@ -0,0 +1,70 @@
+"""CLI entry point for chops."""
+
+from __future__ import annotations
+
+import typer
+
+from chops import __version__
+from chops.commands import dq, health
+
+app = typer.Typer(
+    name="chops",
+    help="ClickHouse Operations CLI — health checks, data quality, and observability.",
+    no_args_is_help=True,
+)
+
+app.add_typer(health.app, name="health", help="Cluster health and observability commands.")
+app.add_typer(dq.app, name="dq", help="Data quality profiling and checks.")
+
+
+@app.command()
+def version() -> None:
+    """Show chops version."""
+    typer.echo(f"chops {__version__}")
+
+
+@app.callback()
+def main(
+    ctx: typer.Context,
+    host: str | None = typer.Option(
+        None,
+        "--host",
+        "-h",
+        envvar="CLICKHOUSE_HOST",
+        help="ClickHouse host",
+    ),
+    port: int | None = typer.Option(
+        None,
+        "--port",
+        "-p",
+        envvar="CLICKHOUSE_PORT",
+        help="ClickHouse HTTP port",
+    ),
+    user: str | None = typer.Option(
+        None,
+        "--user",
+        "-u",
+        envvar="CLICKHOUSE_USER",
+        help="ClickHouse user",
+    ),
+    password: str | None = typer.Option(
+        None,
+        "--password",
+        envvar="CLICKHOUSE_PASSWORD",
+        help="ClickHouse password",
+    ),
+    database: str | None = typer.Option(
+        None,
+        "--database",
+        "-d",
+        envvar="CLICKHOUSE_DATABASE",
+        help="Default database",
+    ),
+) -> None:
+    """Global connection options."""
+    ctx.ensure_object(dict)
+    ctx.obj["host"] = host
+    ctx.obj["port"] = port
+    ctx.obj["user"] = user
+    ctx.obj["password"] = password
+    ctx.obj["database"] = database

chops-0.1.0/src/chops/client.py

@@ -0,0 +1,40 @@
+"""ClickHouse connection client."""
+
+from __future__ import annotations
+
+import os
+from typing import Any
+
+import clickhouse_connect
+from clickhouse_connect.driver.client import Client
+
+
+def get_client(
+    host: str | None = None,
+    port: int | None = None,
+    user: str | None = None,
+    password: str | None = None,
+    database: str | None = None,
+    secure: bool | None = None,
+) -> Client:
+    """Create a ClickHouse client from explicit args or environment variables."""
+    return clickhouse_connect.get_client(
+        host=host or os.getenv("CLICKHOUSE_HOST", "localhost"),
+        port=port or int(os.getenv("CLICKHOUSE_PORT", "8123")),
+        username=user or os.getenv("CLICKHOUSE_USER", "default"),
+        password=password if password is not None else os.getenv("CLICKHOUSE_PASSWORD", ""),
+        database=database if database is not None else os.getenv("CLICKHOUSE_DATABASE", "default"),
+        secure=(
+            secure
+            if secure is not None
+            else os.getenv("CLICKHOUSE_SECURE", "false").lower() == "true"
+        ),
+        connect_timeout=10,
+    )
+
+
+def query(client: Client, sql: str, params: dict[str, Any] | None = None) -> list[dict[str, Any]]:
+    """Execute a query and return results as list of dicts."""
+    result = client.query(sql, parameters=params or {})
+    columns = result.column_names
+    return [dict(zip(columns, row, strict=False)) for row in result.result_rows]

chops-0.1.0/src/chops/commands/__init__.py

@@ -0,0 +1 @@
+"""chops CLI commands."""