qualis 0.3.1__tar.gz

qualis-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Lint with ruff
+        run: uv run ruff check src/ tests/
+
+      - name: Typecheck with mypy
+        run: uv run mypy src/
+
+      - name: Run tests
+        run: uv run pytest --cov=qualis --cov-report=term-missing
+
+      - name: Enforce coverage threshold
+        run: uv run pytest --cov=qualis --cov-fail-under=80

qualis-0.3.1/.github/workflows/dq-check.yml.example

@@ -0,0 +1,21 @@
+name: Data Quality
+
+on:
+  pull_request:
+    paths:
+      - 'data/**'
+      - 'rules/**'
+
+jobs:
+  qualis:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ahmedashraffcih/qualis@v0.2.0
+        with:
+          rules: rules/
+          sample: data/accidents.csv
+          fail-on-score: "80"

qualis-0.3.1/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Build artefacts
+        run: uv build
+
+      - name: Verify version matches tag
+        run: |
+          VERSION_IN_PYPROJECT=$(grep '^version = ' pyproject.toml | head -1 | sed 's/.*"\(.*\)"/\1/')
+          TAG_VERSION="${GITHUB_REF#refs/tags/v}"
+          if [ "$VERSION_IN_PYPROJECT" != "$TAG_VERSION" ]; then
+            echo "Version mismatch: pyproject.toml says '$VERSION_IN_PYPROJECT', tag is '$TAG_VERSION'"
+            exit 1
+          fi
+          echo "Version $VERSION_IN_PYPROJECT matches tag v$TAG_VERSION"
+
+      - name: Upload artefacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/qualis
+    permissions:
+      id-token: write   # IMPORTANT: required for trusted publishing
+    steps:
+      - name: Download artefacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

qualis-0.3.1/.gitignore

@@ -0,0 +1,79 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg
+*.egg-info/
+dist/
+build/
+eggs/
+parts/
+var/
+sdist/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+
+# uv
+.uv/
+
+# Environment variables
+.env
+.env.*
+!.env.example
+
+# Coverage
+.coverage
+.coverage.*
+htmlcov/
+.tox/
+.nox/
+coverage.xml
+*.cover
+*.py,cover
+
+# Testing
+.pytest_cache/
+.cache/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# ruff
+.ruff_cache/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.project
+.pydevproject
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.Spotlight-V100
+.Trashes
+
+# Distribution / packaging
+.Python
+develop-eggs/
+lib/
+lib64/

qualis-0.3.1/.python-version

@@ -0,0 +1 @@
+3.12

qualis-0.3.1/CHANGELOG.md

@@ -0,0 +1,106 @@
+# Changelog
+
+## v0.3.1 (2026-06-03)
+
+First PyPI release — no behaviour changes from v0.3.0. Adds PyPI metadata
+(classifiers, keywords, project URLs), the tag-driven release workflow with
+OIDC trusted publishing, CI on Python 3.12/3.13, and contributor docs.
+
+## v0.3.0 (2026-06-02) — Trust scaffolding
+
+Informed by feedback from a live-delivery practitioner: "generation is the
+commodity; grounding, control, and upkeep are the value." This release ships
+the scaffolding that makes generated rules trustworthy.
+
+- **Context model.** New `context.yaml` declares per-column sentinels
+  (e.g. `0 = "unknown"`), exceptions, and business grain. `qualis discover
+  --context` consults it and excludes declared sentinels from `in_set`
+  suggestions. Closes the practitioner's #1 failure mode ("0 valid in some
+  tables, invalid in others — generic check is wrong half the time").
+- **Evidence trail.** `RuleSuggestion.rationale: str` is replaced with
+  `evidence: SuggestionEvidence` — a structured snapshot of the profile that
+  drove the suggestion (rows, nulls, distinct count, min/max, top values,
+  sentinels consulted). The review screen surfaces this so reviewers see the
+  reasoning. The old `.rationale` property still works for callers.
+- **Review state machine.** Rules now carry `status: draft | needs_evidence
+  | active | deprecated`. New `qualis review --pending` lists rules a
+  reviewer sent back for SME confirmation. The discover review prompt adds
+  `[B] Send back` as a first-class action that captures a reason.
+- **Pluggable standards mapping.** `Rule.metadata` is an open dict; a new
+  `RuleMetadataSchema` + `StandardsValidator` let programmes plug in their
+  required-fields model (CDE, glossary, owner, frequency, threshold).
+- **Referential-integrity check type.** New `check: reference_lookup` with
+  `ReferenceLookupParams(reference, key_column)`. Implemented across
+  in-memory, DuckDB, and PostgreSQL adapters (SQL pushdown on the latter
+  two). New `ReferenceDataPort` plus `InMemoryReferenceData` adapter.
+  Closes the practitioner's #3 failure mode ("wrong-key join passed every
+  quality check because the rows existed; they were just the wrong rows").
+- **Rule lineage fields.** `Rule` gains `version`, `supersedes`,
+  `deprecated_at`, `approved_by`, and `metadata` — surfaced by the loader
+  and writer when present.
+
+Deferred to v0.4: PyPI publish, Snowflake / BigQuery adapters, `qualis
+drift` (rule maintenance over time), live glossary integration.
+
+## v0.2.2 (2026-05-31)
+
+Trust-calibration patch — informed by a live-delivery practitioner's critique that
+"a tool that generates confidently from thin context will produce rules that look
+right but are wrong, at scale."
+
+- **`in_set` confidence dropped from `high` to `medium`.** The heuristic observes
+  values in the profiled dataset only; it cannot know the authoritative valid
+  domain. Sentinels (e.g., `0` meaning "unknown") and rarely-occurring legitimate
+  values are silently codified as "valid" today. Calling this "high confidence"
+  was epistemically wrong.
+- **Rationale now explicitly warns** to verify against the authoritative valid
+  domain before accepting.
+
+## v0.2.1 (2026-05-31)
+
+Bug-fix release based on data-team testing (Anwar, Data Engineer).
+
+- **`--rules` now accepts a file OR directory.** `qualis discover` writes a YAML file; the next step (`validate`/`check`/`report --rules <file>`) used to error "is not a directory." Fixed via new `load_rules_from_path()` that auto-detects.
+- **`qualis init` scaffold runs first-try.** Old scaffold referenced `my_table`/`my_column` placeholders that crashed on `qualis check`. New scaffold creates `rules/completeness.yaml` + `data/example.csv` + three runnable rules. The "next steps" message gives the exact working command.
+- **`qualis discover` success message points at the actual output path** (not `output.parent`).
+- **`qualis discover` sets `severity: critical`** for `not_null` and `unique` rules on ID-like columns. Previously every suggestion was `warning`.
+
+## v0.2.0 (2026-05-30)
+
+**Featured commands:** `qualis diff` (score comparison), `qualis discover` (rule suggestion), `qualis-github-action`.
+
+- **`qualis diff`** — compare quality scores between two runs with trend arrows; `--fail-on-regression` for CI gates
+- **`qualis discover`** — statistical profiler + heuristic rule suggester; interactive `git add -p` style review; pure deterministic (no LLM API key required)
+- **GitHub Action** — composite action posts a sticky PR comment with the scorecard; uploads the HTML report as an artifact
+- **3 new check types**: `in_set`, `row_count`, `not_negative` across DuckDB and PostgreSQL adapters
+- **PostgreSQL adapter** check methods extended for all 8 check types
+- Reports loader (`load_report`) reconstructs a `DatasetScore` from a JSON report file
+- `run_detailed()` on `CheckRunner` returns both `DatasetScore` and `list[CheckResult]`
+
+## v0.1.1 (2026-05-27)
+
+- HTML scorecard report — single-file, traffic-light hero, DAMA dimension bars, drilldown table
+- `qualis report` command — generate HTML or JSON reports to file
+- PostgreSQL adapter with PG-dialect SQL templates (psycopg3, read-only transactions)
+- `run_detailed()` on CheckRunner for detailed results with individual check outcomes
+- `--fail-on-score` on report command for CI gating
+
+## v0.1.0 (2026-05-26)
+
+Initial release.
+
+- 5 check types: not_null, unique, between, regex, sql
+- DuckDB adapter built-in (CSV/Parquet support, zero-config)
+- In-memory adapter for testing
+- YAML-first rule definitions with typed parameters
+- Template variables: `{{ today }}`, `{{ yesterday }}`, `{{ now }}`, `{{ env.VAR }}`
+- DAMA DMBOK 2.0 — all 9 dimensions as first-class enums
+- Weighted scoring with check-count normalization
+- CLI: `qualis init`, `qualis validate`, `qualis check`
+- Rich-colored console output with scorecard panel
+- `--fail-on-score N` for CI pipeline gating
+- `--allow-custom` security gate for Python check handlers
+- `--output-format json` for machine-readable output
+- Pydantic v2 settings with SecretStr credentials
+- Typo suggestions on invalid enum values
+- Apache 2.0 license

qualis-0.3.1/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to Qualis
+
+Thanks for considering a contribution! A few notes that will save us both time.
+
+## Setup
+
+```bash
+git clone https://github.com/ahmedashraffcih/qualis
+cd qualis
+uv sync --all-extras --dev
+uv run pytest -q
+```
+
+Expected: 439+ tests pass.
+
+## Quality bar
+
+- Tests pass: `uv run pytest`
+- Type checks pass: `uv run mypy src/` (strict mode; zero errors)
+- Lint passes: `uv run ruff check src/ tests/` (zero warnings)
+- Coverage stays above 80%: `uv run pytest --cov=qualis --cov-fail-under=80`
+
+CI enforces all four. PRs that don't meet the bar will be redirected.
+
+## Branch naming
+
+`feature/<short-description>` for new functionality
+`fix/<short-description>` for bug fixes
+`docs/<short-description>` for docs-only changes
+`chore/<short-description>` for tooling / release / CI
+
+## Commits
+
+Conventional Commits style:
+
+- `feat: ...` for new functionality
+- `fix: ...` for bug fixes
+- `chore: ...` for tooling / release work
+- `docs: ...` for documentation
+- `refactor: ...` for internal restructuring without behaviour change
+- `test: ...` for test-only changes
+
+Keep the first line under 72 chars. Use the body to explain the why.
+
+## Domain rules
+
+Qualis is hexagonal. The `src/qualis/domain/` layer has zero external
+imports (only stdlib + `qualis.domain.*`). Ports are `typing.Protocol`
+interfaces. Adapters implement ports and live under `src/qualis/adapters/`.
+Don't violate the dependency direction — if you need it, file an issue
+to discuss the design first.
+
+## Releasing
+
+See `docs/release.md`.

qualis-0.3.1/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of recording
+      instructions given to the Licensor.
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and is included
+      in the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those Contributions necessary to
+      make, use, sell, offer to sell, import, or otherwise transfer the Work.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must reproduce the above copyright notices for use,
+          reproduction, and distribution, and a relevant copyright notice
+          in the Derivative Works; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file, the contents
+          of the NOTICE file are for informational purposes only
+          and do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or in addition to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions that are consistent with this full terms and conditions,
+      including warranty disclaimers and limitation of liability contained
+      in this License, or any of the terms and conditions contained in a
+      Section 9 of the License, including without limitation
+      indemnification.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the format of the file. We also recommend that
+      a file or directory name be given, with a reference to where the
+      full text can be found.
+
+   Copyright 2024 Ahmed Ashraf
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qualis-0.3.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: qualis
+Version: 0.3.1
+Summary: Data quality framework that tells you WHAT failed, not just that something did
+Project-URL: Homepage, https://github.com/ahmedashraffcih/qualis
+Project-URL: Documentation, https://github.com/ahmedashraffcih/qualis#readme
+Project-URL: Repository, https://github.com/ahmedashraffcih/qualis
+Project-URL: Issues, https://github.com/ahmedashraffcih/qualis/issues
+Project-URL: Changelog, https://github.com/ahmedashraffcih/qualis/blob/main/CHANGELOG.md
+Author-email: Ahmed Ashraf <ahmedashraffcih@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: dama,data-governance,data-quality,data-testing,data-validation,dmbok,dq,great-expectations-alternative
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: duckdb>=1.0
+Requires-Dist: jinja2>=3.1
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.12
+Provides-Extra: postgres
+Requires-Dist: psycopg-pool>=3.1; extra == 'postgres'
+Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'