9gear-sentinel 0.1.0__tar.gz

9gear_sentinel-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: sentinel
+          POSTGRES_PASSWORD: sentinel
+          POSTGRES_DB: analytics
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd "pg_isready -U sentinel -d analytics"
+          --health-interval 5s
+          --health-timeout 3s
+          --health-retries 10
+    env:
+      SENTINEL_TEST_PG_URL: postgresql+psycopg://sentinel:sentinel@localhost:5432/analytics
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: uv pip install --system -e ".[dev]"
+      - name: Lint
+        run: ruff check . && ruff format --check .
+      - name: Type-check
+        run: mypy src
+      - name: Test
+        run: pytest --cov=sentinel --cov-report=term-missing

9gear_sentinel-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,40 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    paths: ["docs/**", "mkdocs.yml", ".github/workflows/docs.yml"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install "mkdocs-material>=9.5"
+      - run: mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

9gear_sentinel-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+# Push a tag like v0.1.0 to build, publish to PyPI and create a GitHub release.
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Check the tag matches the package version
+        run: |
+          VERSION=$(sed -n 's/^__version__ = "\(.*\)"/\1/p' src/sentinel/__init__.py)
+          if [ "v$VERSION" != "$GITHUB_REF_NAME" ]; then
+            echo "Tag $GITHUB_REF_NAME does not match __version__ $VERSION"
+            exit 1
+          fi
+      - name: Build
+        run: uv build
+      - name: Smoke-test the wheel
+        run: |
+          uv venv /tmp/smoke
+          uv pip install --python /tmp/smoke dist/*.whl
+          /tmp/smoke/bin/sentinel --version
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/9gear-sentinel
+    permissions:
+      id-token: write  # trusted publishing: no API token stored anywhere
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Create GitHub release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: >
+          gh release create "$GITHUB_REF_NAME" dist/*
+          --repo "$GITHUB_REPOSITORY"
+          --title "9Gear Sentinel $GITHUB_REF_NAME"
+          --generate-notes

9gear_sentinel-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+.venv/
+.env
+.sentinel/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+sentinel-report.html

9gear_sentinel-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/), and versions follow [Semantic Versioning](https://semver.org/).
+
+## [0.1.0] - 2026-10-30
+
+First public release.
+
+### Checks
+- `freshness`, `row_count`, `row_count_change`, `not_null`, `null_rate`, `unique`, `accepted_values`, `schema_drift` and `custom_sql`
+- Common options on every check: `severity`, `where`, `tags` and `name`
+
+### Commands
+- `init`, `validate`, `test-connection`, `run`, `history`, `report`, `snapshot-schema`, `test-alert` and `watch`
+- `run` filters (`--source`, `--table`, `--check`, `--tag`), `--dry-run`, `--no-store` and `--no-alerts`
+- Exit codes: 0 passed or warned, 1 failed, 2 couldn't run
+
+### Configuration
+- One YAML file with `${VAR}` and `${VAR:-default}` substitution and `.env` support
+- Validation errors that name the file, line and field
+
+### Results and alerts
+- Results store in SQLite or Postgres, with stable check keys so thresholds can change without losing history
+- Slack and email alerts that fire on change of state: once on failure, once on recovery
+- Self-contained HTML report with each check's recent trend
+
+### Databases
+- Postgres and SQLite supported and tested

9gear_sentinel-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+Thanks for helping improve 9Gear Sentinel.
+
+## Setup
+
+```bash
+git clone https://github.com/Mirrz64/9Gear-Sentinel.git
+cd 9Gear-Sentinel
+uv venv && source .venv/bin/activate      # Windows Git Bash: .venv/Scripts/activate
+uv pip install -e ".[dev]"
+```
+
+## Before opening a pull request
+
+```bash
+ruff format . && ruff check . && mypy src && pytest
+```
+
+Postgres integration tests run when a database is available:
+
+```bash
+docker compose up -d
+SENTINEL_TEST_PG_URL=postgresql+psycopg://sentinel:sentinel@localhost:5433/analytics pytest
+```
+
+## Conventions
+
+- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/): `feat:`, `fix:`, `docs:`, `test:`, `chore:`.
+- New check types live in `src/sentinel/checks/`, one file each, registered in `registry.py`, with unit tests that don't need a database.
+- Keep user-facing messages short and specific: what was measured and what the limit was.

9gear_sentinel-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within 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 patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   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 cause any modified files to carry prominent notices
+          stating that You changed the files; 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 as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. 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 as an addendum 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   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 file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

9gear_sentinel-0.1.0/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.5
+Name: 9gear-sentinel
+Version: 0.1.0
+Summary: Data quality checks for your warehouse, declared in YAML, run anywhere.
+Project-URL: Homepage, https://github.com/Mirrz64/9Gear-Sentinel
+Project-URL: Documentation, https://mirrz64.github.io/9Gear-Sentinel/
+Project-URL: Repository, https://github.com/Mirrz64/9Gear-Sentinel
+Project-URL: Issues, https://github.com/Mirrz64/9Gear-Sentinel/issues
+Project-URL: Changelog, https://github.com/Mirrz64/9Gear-Sentinel/blob/main/CHANGELOG.md
+Author: Miracle Osabuogbe
+License: Apache-2.0
+License-File: LICENSE
+Keywords: data engineering,data observability,data quality,monitoring,sql
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.7
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: rich>=13.7
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: psycopg[binary]>=3.1; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# 9Gear Sentinel
+
+[![CI](https://github.com/Mirrz64/9Gear-Sentinel/actions/workflows/ci.yml/badge.svg)](https://github.com/Mirrz64/9Gear-Sentinel/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/9gear-sentinel)](https://pypi.org/project/9gear-sentinel/)
+[![Python](https://img.shields.io/pypi/pyversions/9gear-sentinel)](https://pypi.org/project/9gear-sentinel/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+**Data quality checks for your warehouse, declared in YAML and run anywhere you can run a command.**
+
+Sentinel catches stale tables, sudden row-count drops, null spikes, duplicate keys and silent schema changes before your stakeholders do. Every check runs as SQL inside your own database, so your data never leaves it.
+
+![Sentinel running against a demo database](https://raw.githubusercontent.com/Mirrz64/9Gear-Sentinel/main/docs/assets/demo.gif)
+
+## Why Sentinel
+
+- **Ten minutes to the first alert.** `pip install`, one YAML file, done. No server, no UI to host.
+- **Alerts that don't nag.** Slack or email once when a check breaks and once when it recovers, not every hour while it stays broken.
+- **It remembers.** Every run is stored, so checks can catch a 40% overnight drop in rows, and you can see each check's recent trend.
+- **Fits your pipeline.** Clear exit codes for CI and Airflow, a built-in scheduler, and a shareable HTML report.
+- **Plain SQL you can read.** `--dry-run` shows exactly what will be sent to your database.
+
+## Quickstart
+
+```bash
+pip install "9gear-sentinel[postgres]"
+sentinel init                 # writes sentinel.yml and .env.example
+cp .env.example .env          # set WAREHOUSE_URL
+sentinel test-connection
+sentinel run
+```
+
+```yaml
+tables:
+  - source: warehouse
+    table: analytics.orders
+    checks:
+      - freshness: { column: updated_at, max_age: 6h }
+      - row_count_change: { max_drop_pct: 30 }
+      - unique: { columns: [order_id] }
+      - null_rate: { column: customer_id, max_pct: 1, severity: warn }
+      - accepted_values:
+          column: status
+          values: [pending, paid, shipped, refunded]
+      - schema_drift: {}
+```
+
+Want to see it first? The repo includes a demo database with deliberate problems:
+
+```bash
+git clone https://github.com/Mirrz64/9Gear-Sentinel.git && cd 9Gear-Sentinel
+pip install -e ".[postgres]"
+docker compose up -d
+sentinel run -c examples/sentinel.yml
+```
+
+## Checks
+
+| Check | Fails when |
+| --- | --- |
+| `freshness` | The newest timestamp is older than `max_age` |
+| `row_count` | The row count is outside `min` / `max` |
+| `row_count_change` | The count moved more than allowed since the last run |
+| `not_null` | Any null appears in the column |
+| `null_rate` | The share of nulls is above `max_pct` |
+| `unique` | Any key value appears more than once |
+| `accepted_values` | A value outside the list appears |
+| `schema_drift` | A column is added, removed or retyped since the baseline |
+| `custom_sql` | Your query returns any rows |
+
+## Reports
+
+`sentinel report` turns the latest run into one self-contained HTML page, with failures first and each check's recent history.
+
+![HTML report](https://raw.githubusercontent.com/Mirrz64/9Gear-Sentinel/main/docs/assets/report.png)
+
+## Documentation
+
+Full docs: **[mirrz64.github.io/9Gear-Sentinel](https://mirrz64.github.io/9Gear-Sentinel/)**, covering configuration, every check, alerts, scheduling, CI recipes and the CLI.
+
+## Supported databases
+
+Postgres and SQLite are supported and tested. Snowflake and BigQuery are planned for v0.2.
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup.
+
+## Licence
+
+[Apache-2.0](LICENSE). Built by Miracle Osabuogbe at 9Gear Tech.

9gear_sentinel-0.1.0/README.md

@@ -0,0 +1,90 @@
+# 9Gear Sentinel
+
+[![CI](https://github.com/Mirrz64/9Gear-Sentinel/actions/workflows/ci.yml/badge.svg)](https://github.com/Mirrz64/9Gear-Sentinel/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/9gear-sentinel)](https://pypi.org/project/9gear-sentinel/)
+[![Python](https://img.shields.io/pypi/pyversions/9gear-sentinel)](https://pypi.org/project/9gear-sentinel/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+**Data quality checks for your warehouse, declared in YAML and run anywhere you can run a command.**
+
+Sentinel catches stale tables, sudden row-count drops, null spikes, duplicate keys and silent schema changes before your stakeholders do. Every check runs as SQL inside your own database, so your data never leaves it.
+
+![Sentinel running against a demo database](https://raw.githubusercontent.com/Mirrz64/9Gear-Sentinel/main/docs/assets/demo.gif)
+
+## Why Sentinel
+
+- **Ten minutes to the first alert.** `pip install`, one YAML file, done. No server, no UI to host.
+- **Alerts that don't nag.** Slack or email once when a check breaks and once when it recovers, not every hour while it stays broken.
+- **It remembers.** Every run is stored, so checks can catch a 40% overnight drop in rows, and you can see each check's recent trend.
+- **Fits your pipeline.** Clear exit codes for CI and Airflow, a built-in scheduler, and a shareable HTML report.
+- **Plain SQL you can read.** `--dry-run` shows exactly what will be sent to your database.
+
+## Quickstart
+
+```bash
+pip install "9gear-sentinel[postgres]"
+sentinel init                 # writes sentinel.yml and .env.example
+cp .env.example .env          # set WAREHOUSE_URL
+sentinel test-connection
+sentinel run
+```
+
+```yaml
+tables:
+  - source: warehouse
+    table: analytics.orders
+    checks:
+      - freshness: { column: updated_at, max_age: 6h }
+      - row_count_change: { max_drop_pct: 30 }
+      - unique: { columns: [order_id] }
+      - null_rate: { column: customer_id, max_pct: 1, severity: warn }
+      - accepted_values:
+          column: status
+          values: [pending, paid, shipped, refunded]
+      - schema_drift: {}
+```
+
+Want to see it first? The repo includes a demo database with deliberate problems:
+
+```bash
+git clone https://github.com/Mirrz64/9Gear-Sentinel.git && cd 9Gear-Sentinel
+pip install -e ".[postgres]"
+docker compose up -d
+sentinel run -c examples/sentinel.yml
+```
+
+## Checks
+
+| Check | Fails when |
+| --- | --- |
+| `freshness` | The newest timestamp is older than `max_age` |
+| `row_count` | The row count is outside `min` / `max` |
+| `row_count_change` | The count moved more than allowed since the last run |
+| `not_null` | Any null appears in the column |
+| `null_rate` | The share of nulls is above `max_pct` |
+| `unique` | Any key value appears more than once |
+| `accepted_values` | A value outside the list appears |
+| `schema_drift` | A column is added, removed or retyped since the baseline |
+| `custom_sql` | Your query returns any rows |
+
+## Reports
+
+`sentinel report` turns the latest run into one self-contained HTML page, with failures first and each check's recent history.
+
+![HTML report](https://raw.githubusercontent.com/Mirrz64/9Gear-Sentinel/main/docs/assets/report.png)
+
+## Documentation
+
+Full docs: **[mirrz64.github.io/9Gear-Sentinel](https://mirrz64.github.io/9Gear-Sentinel/)**, covering configuration, every check, alerts, scheduling, CI recipes and the CLI.
+
+## Supported databases
+
+Postgres and SQLite are supported and tested. Snowflake and BigQuery are planned for v0.2.
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup.
+
+## Licence
+
+[Apache-2.0](LICENSE). Built by Miracle Osabuogbe at 9Gear Tech.

9gear_sentinel-0.1.0/docker-compose.yml

@@ -0,0 +1,23 @@
+# Local Postgres with demo data for trying Sentinel and running integration tests.
+# Start:  docker compose up -d
+# Reset:  docker compose down -v && docker compose up -d
+services:
+  postgres:
+    image: postgres:16
+    environment:
+      POSTGRES_USER: sentinel
+      POSTGRES_PASSWORD: sentinel
+      POSTGRES_DB: analytics
+    ports:
+      - "5433:5432"
+    volumes:
+      - ./examples/seed.sql:/docker-entrypoint-initdb.d/01-seed.sql:ro
+      - pgdata:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U sentinel -d analytics"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+
+volumes:
+  pgdata: