aqualisys 0.1.0__tar.gz

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

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Ruff
+        run: ruff check src tests
+      - name: Black
+        run: black --check src tests
+
+  tests:
+    needs: lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e '.[dev]'
+      - name: Pytest
+        run: pytest -vv

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

@@ -0,0 +1,161 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  wait-for-ci:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Wait for CI workflow
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const workflowName = "CI";
+            const sha = process.env.GITHUB_SHA;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+
+            const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+            for (let attempt = 0; attempt < 30; attempt++) {
+              const { data } = await github.rest.actions.listWorkflowRunsForRepo({
+                owner,
+                repo,
+                event: "push",
+                head_sha: sha,
+                per_page: 50,
+              });
+
+              const run = data.workflow_runs.find((r) => r.name === workflowName);
+              if (run) {
+                if (run.status === "completed") {
+                  if (run.conclusion !== "success") {
+                    core.setFailed(`CI workflow finished with status ${run.conclusion}`);
+                    return;
+                  }
+                  core.info(`CI workflow ${run.id} succeeded.`);
+                  return;
+                }
+                core.info(`CI workflow ${run.id} still running (attempt ${attempt + 1}).`);
+              } else {
+                core.info(`No CI workflow run found yet (attempt ${attempt + 1}).`);
+              }
+              await delay(30000);
+            }
+
+            core.setFailed("Timed out waiting for CI workflow to complete.");
+
+  build:
+    needs: wait-for-ci
+    runs-on: ubuntu-latest
+    outputs:
+      release_tag: ${{ steps.tag_check.outputs.release_tag }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.sha }}
+          fetch-depth: 0
+
+      - name: Ensure tag release
+        id: tag_check
+        run: |
+          TAG_NAME="$(git describe --tags --exact-match HEAD 2>/dev/null || true)"
+          if [ -z "$TAG_NAME" ]; then
+            echo "This commit is not tagged; skipping release build."
+            echo "release_tag=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+          if [[ "$TAG_NAME" != v* ]]; then
+            echo "Tag $TAG_NAME does not match v* pattern; skipping."
+            echo "release_tag=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+          echo "release_tag=$TAG_NAME" >> "$GITHUB_OUTPUT"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+
+      - name: Build package
+        if: ${{ steps.tag_check.outputs.release_tag != '' }}
+        run: uv build
+
+      - name: Upload dist artifacts
+        if: ${{ steps.tag_check.outputs.release_tag != '' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: aqualisys-dist
+          path: dist/*
+
+  publish-testpypi:
+    needs: build
+    if: ${{ needs.build.result == 'success' && needs.build.outputs.release_tag != '' }}
+    runs-on: ubuntu-latest
+    outputs:
+      published: ${{ steps.publish.outputs.published }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.sha }}
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: astral-sh/setup-uv@v2
+      - name: Build dist for publishing
+        run: uv build
+      - id: publish
+        env:
+          TEST_PYPI_API_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          UV_PUBLISH_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          UV_PUBLISH_URL: https://test.pypi.org/legacy/
+          UV_PUBLISH_USERNAME: __token__
+        run: |
+          if [ -z "$TEST_PYPI_API_TOKEN" ]; then
+            echo "published=false" >> "$GITHUB_OUTPUT"
+            echo "TEST_PYPI_API_TOKEN not set; skipping TestPyPI publish."
+            exit 0
+          fi
+          uv publish
+          echo "published=true" >> "$GITHUB_OUTPUT"
+
+  publish-pypi:
+    needs:
+      - build
+      - publish-testpypi
+    if: >-
+      ${{
+        needs.build.result == 'success' &&
+        needs.build.outputs.release_tag != '' &&
+        needs.publish-testpypi.outputs.published == 'true'
+      }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.sha }}
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: astral-sh/setup-uv@v2
+      - name: Build dist for publishing
+        run: uv build
+      - name: Publish to PyPI
+        env:
+          PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+          UV_PUBLISH_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+          UV_PUBLISH_USERNAME: __token__
+        run: |
+          if [ -z "$PYPI_API_TOKEN" ]; then
+            echo "PYPI_API_TOKEN not set; aborting PyPI publish."
+            exit 1
+          fi
+          uv publish

aqualisys-0.1.0/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.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/
+cover/
+
+# 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
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

aqualisys-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Absolentia
+
+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.

aqualisys-0.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: aqualisys
+Version: 0.1.0
+Summary: Polars-first data-quality and data-validation toolkit.
+Author-email: Aqualisys Maintainers <maintainers@aqualisys.dev>
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1.7
+Requires-Dist: polars>=0.20.0
+Requires-Dist: pyyaml>=6.0.1
+Provides-Extra: dev
+Requires-Dist: black>=24.3.0; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.4; extra == 'dev'
+Requires-Dist: ruff>=0.2.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Aqualisys
+
+Polars-first data-quality toolkit delivering deterministic validation, structured logging, and a composable rule registry.
+
+## Why Aqualisys?
+- **Declarative rules**: ship reusable expectations such as not-null, uniqueness, accepted-values, and referential checks.
+- **Deterministic logging**: every run is persisted to SQLite (JSON-friendly) for audits and debugging.
+- **Pipeline-ready**: run from Python code or via `aqualisys validate configs/orders.yml` in CI.
+
+## Quick Start
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e .[dev]
+pytest
+aqualisys validate configs/orders.yml
+```
+
+## Usage Example
+```python
+import polars as pl
+from aqualisys import DataQualityChecker, NotNullRule, UniqueRule, SQLiteRunLogger
+
+df = pl.DataFrame({"order_id": [1, 2, 3], "status": ["pending", "shipped", "shipped"]})
+checker = DataQualityChecker(
+    rules=[NotNullRule("order_id"), UniqueRule("order_id")],
+    logger=SQLiteRunLogger("artifacts/example_runs.db"),
+)
+report = checker.run(df, dataset_name="orders")
+assert report.passed
+```
+
+## Project Structure
+- `src/aqualisys/`: library source (rules, checker, logging, CLI).
+- `tests/`: pytest suites (unit + integration).
+- `configs/`: sample validation suite definitions.
+- `docs/`: roadmap and design notes.
+
+See `docs/PUBLISHING.md` for uv-based build and release steps once you are ready to publish a new version.
+
+See `docs/ROADMAP.md` for the multi-week implementation plan inspired by the Start Data Engineering guide.

aqualisys-0.1.0/README.md

@@ -0,0 +1,40 @@
+# Aqualisys
+
+Polars-first data-quality toolkit delivering deterministic validation, structured logging, and a composable rule registry.
+
+## Why Aqualisys?
+- **Declarative rules**: ship reusable expectations such as not-null, uniqueness, accepted-values, and referential checks.
+- **Deterministic logging**: every run is persisted to SQLite (JSON-friendly) for audits and debugging.
+- **Pipeline-ready**: run from Python code or via `aqualisys validate configs/orders.yml` in CI.
+
+## Quick Start
+```bash
+python -m venv .venv && source .venv/bin/activate
+pip install -e .[dev]
+pytest
+aqualisys validate configs/orders.yml
+```
+
+## Usage Example
+```python
+import polars as pl
+from aqualisys import DataQualityChecker, NotNullRule, UniqueRule, SQLiteRunLogger
+
+df = pl.DataFrame({"order_id": [1, 2, 3], "status": ["pending", "shipped", "shipped"]})
+checker = DataQualityChecker(
+    rules=[NotNullRule("order_id"), UniqueRule("order_id")],
+    logger=SQLiteRunLogger("artifacts/example_runs.db"),
+)
+report = checker.run(df, dataset_name="orders")
+assert report.passed
+```
+
+## Project Structure
+- `src/aqualisys/`: library source (rules, checker, logging, CLI).
+- `tests/`: pytest suites (unit + integration).
+- `configs/`: sample validation suite definitions.
+- `docs/`: roadmap and design notes.
+
+See `docs/PUBLISHING.md` for uv-based build and release steps once you are ready to publish a new version.
+
+See `docs/ROADMAP.md` for the multi-week implementation plan inspired by the Start Data Engineering guide.

aqualisys-0.1.0/configs/orders.yml

@@ -0,0 +1,15 @@
+dataset:
+  name: orders
+  path: data/orders.parquet
+  format: parquet
+fail_fast: true
+logger:
+  path: artifacts/orders_runs.db
+rules:
+  - type: not_null
+    column: order_id
+  - type: unique
+    column: order_id
+  - type: accepted_values
+    column: order_status
+    allowed_values: ["pending", "shipped", "delivered", "cancelled"]

aqualisys-0.1.0/docs/PUBLISHING.md

@@ -0,0 +1,49 @@
+# Publishing & Release Guide
+
+This guide mirrors the Week 4 "DX & Publishing" milestone from the roadmap. It assumes you have uv installed locally (https://docs.astral.sh/uv/).
+
+## 1. Build the distribution artifacts
+```bash
+uv build
+```
+Outputs land in `dist/` as both an sdist (`.tar.gz`) and wheel (`.whl`). Inspect them locally if needed:
+```bash
+ls dist
+uv pip install dist/aqualisys-*.whl --target /tmp/aqualisys-wheel-check
+```
+
+## 2. Smoke-test from a clean environment
+```bash
+python -m venv /tmp/aqualisys-smoke
+source /tmp/aqualisys-smoke/bin/activate
+pip install --upgrade pip
+pip install dist/aqualisys-*.whl
+python - <<'PY'
+from aqualisys import DataQualityChecker, NotNullRule
+print("Loaded", DataQualityChecker, NotNullRule)
+PY
+```
+
+## 3. Publish to TestPyPI first
+```bash
+uv publish --repository testpypi --token "$TEST_PYPI_API_TOKEN"
+```
+Retrieve the token from https://test.pypi.org/manage/account/token/ and store it in the `TEST_PYPI_API_TOKEN` environment variable (or GitHub secret of the same name). After publishing, install from TestPyPI to verify:
+```bash
+pip install --index-url https://test.pypi.org/simple --no-deps aqualisys
+```
+
+## 4. Promote to PyPI
+Once TestPyPI validation passes:
+```bash
+uv publish --token "$PYPI_API_TOKEN"
+```
+
+## 5. GitHub Actions workflow
+Pushing a tag like `v0.2.0` triggers `.github/workflows/release.yml`, which:
+1. Checks out the repo.
+2. Sets up Python 3.12 and uv.
+3. Runs `uv build`.
+4. Uploads `dist/` as a workflow artifact.
+
+If `TEST_PYPI_API_TOKEN` or `PYPI_API_TOKEN` secrets exist, the workflow also attempts to publish. Keep those secrets scoped to org/repo maintainers.

aqualisys-0.1.0/docs/ROADMAP.md

@@ -0,0 +1,36 @@
+# Aqualisys Roadmap
+
+## Vision & Scope
+- **Audience**: Data engineers who need deterministic, scriptable data-quality checks on Polars DataFrames up to ~100 GB in-memory workloads.
+- **Problem**: Automate repetitive assertions (uniqueness, non-null, accepted-value, relationship checks) while logging all outcomes for auditability.
+- **Constraints**: Operate on Polars inputs only in v0.x, log validation metadata (dataset, run_id, rule_id, metric/value) to SQLite for easy inspection, keep validator and logger orthogonal so either can be swapped later.
+
+## System Architecture Snapshot
+- **Validator Layer**: `DataQualityChecker` orchestrates rule execution. Rules are composable callables implementing a `BaseRule` protocol. Supports registry + bundles for domain suites.
+- **Logging Layer**: `SQLiteRunLogger` implements an abstract `RunLogger` interface capturing run context + rule results. Future connectors (DuckDB, HTTP) can reuse the interface.
+- **Configuration Layer**: Simple `ValidationConfig` dataclass (YAML/JSON loading later) ties inputs, selected rule bundles, and thresholds. Flags (fail fast, severity) stored here.
+- **CLI/Script Layer**: `aqualisys validate --config configs/orders.yml` entry point enabling pipeline integration. CLI delegates entirely to the library.
+
+## Milestones
+1. **Foundation (Week 1)**  
+   - Scaffold repo: `pyproject.toml`, `src/aqualisys`, `tests`.  
+   - Implement minimal Polars rule set (unique, not_null) and SQLite logger.  
+   - Provide quick-start documentation + architecture diagrams in README.
+2. **Rule Expansion (Week 2)**  
+   - Add accepted-values, referential-integrity, expression-based checks.  
+   - Introduce rule registry + tagging for bundles.  
+   - Emit structured results (JSON + SQLite) to support downstream observability.
+3. **Configuration & CLI (Week 3)**  
+   - YAML config parser, CLI wrappers for running suites locally or in CI.  
+   - Support `--fail-fast`, severity overrides, include/exclude selectors.  
+   - Harden logging with retries + summary tables.
+4. **DX & Publishing (Week 4)**  
+   - Add docs site snippets, end-to-end demo notebook, telemetry opt-in.  
+   - Set up `uv build`, publish to TestPyPI, smoke-test install, then promote to PyPI.  
+   - Configure CI (lint, type-check, pytest with coverage) and badges.
+
+## Success Metrics
+- Unit + integration coverage ≥90% on validators/loggers.  
+- Ability to run ≥50 rules/minute on 1M-row datasets on a laptop.  
+- Users can onboard by running a single CLI command using sample configs.  
+- Release cadence: tagged versions every 2 weeks during v0 development.

aqualisys-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "aqualisys"
+version = "0.1.0"
+description = "Polars-first data-quality and data-validation toolkit."
+authors = [{ name = "Aqualisys Maintainers", email = "maintainers@aqualisys.dev" }]
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+dependencies = [
+    "click>=8.1.7",
+    "polars>=0.20.0",
+    "pyyaml>=6.0.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black>=24.3.0",
+    "mypy>=1.8.0",
+    "pytest>=7.4.4",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.2.1",
+]
+
+[project.scripts]
+aqualisys = "aqualisys.cli:run"
+
+[tool.black]
+line-length = 88
+target-version = ["py311"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 88
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+
+[tool.pytest.ini_options]
+addopts = "-vv --strict-markers"
+testpaths = ["tests"]