kbguard 0.1.0__tar.gz

kbguard-0.1.0/.env.example

@@ -0,0 +1,40 @@
+# Copy this file to .env and fill in real values there. .env is gitignored
+# and never committed — only the variable *names* belong in version
+# control, never the values (same principle as kbguard.yaml's
+# api_key_env: fields, which hold a variable name, not a secret).
+#
+# .env is loaded automatically by the repo-root conftest.py before any
+# test runs (python-dotenv) — nothing else in kbguard reads it.
+
+# Remote Docker host for pgvector/Qdrant contract tests, if not localhost.
+# See docs/project/contributing.md.
+# KBGUARD_TEST_PG_HOST=
+# KBGUARD_TEST_PG_PORT=5434
+# KBGUARD_TEST_QDRANT_HOST=
+# KBGUARD_TEST_QDRANT_PORT=6333
+
+# Pinecone: needed only for tests/test_adapters_pinecone_live.py, which is
+# skipped automatically when these aren't set. Free "Starter" tier is
+# enough — see docs/guide/adapters/pinecone.md.
+# PINECONE_API_KEY=
+# PINECONE_TEST_INDEX=
+
+# judge.model in kbguard.yaml is a plain litellm model string -- only the
+# ONE matching provider's key below is actually needed, based on whatever
+# you set judge.model to (e.g. judge.model: xai/grok-4.5 needs only
+# XAI_API_KEY; judge.model: ollama/llama3 needs none of these at all,
+# since Ollama runs locally with no API key). Fill in only the one(s)
+# you're actually going to use.
+# xAI / Grok -- judge.model: xai/grok-4.5 (or whatever's current on x.ai's pricing page)
+# XAI_API_KEY=
+# Groq (fast/cheap inference for open models -- NOT the same company as
+# Grok/xAI, confusingly similar name) -- judge.model: groq/qwen/qwen3.8-27b
+# recommended over groq/openai/gpt-oss-120b: hand-verified both are real,
+# callable model names, but at temperature=0 gpt-oss-120b consistently
+# misjudges a real planted contradiction that qwen3.8-27b consistently
+# gets right (see tests/conftest.py's real_judge fixture)
+# GROQ_API_KEY=
+# OpenAI -- judge.model: gpt-4o-mini
+# OPENAI_API_KEY=
+# Anthropic -- judge.model: anthropic/claude-3-5-sonnet-...
+# ANTHROPIC_API_KEY=

kbguard-0.1.0/.github/workflows/kbguard.yml

@@ -0,0 +1,85 @@
+name: kbguard CI
+
+# This workflow tests kbguard's OWN source — unit tests, contract tests
+# against real pgvector/Qdrant/Chroma backends, lint, and strict types.
+# It is NOT the CI template a client runs kbguard against their own
+# knowledge base with — that one lives at
+# examples/ci/kbguard-client-template.yml, kept clearly separate so the
+# two "same filename pattern, different job" workflows never get
+# conflated (spec section 12's design note).
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: pgvector/pgvector:pg16
+        env:
+          POSTGRES_USER: kbguard
+          POSTGRES_PASSWORD: kbguard
+          POSTGRES_DB: kbguard_test
+        ports:
+          # Host port matches this repo's own docker-compose.yml and the
+          # test suite's default (KBGUARD_TEST_PG_PORT=5434) exactly, so
+          # no extra env vars are needed just to run in CI.
+          - 5434:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      qdrant:
+        image: qdrant/qdrant
+        ports:
+          - 6333:6333
+
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install kbguard with every extra the test suite needs
+        run: pip install -e ".[all]"
+
+      # spaCy's language models are NOT a regular pip dependency pulled in
+      # by `pip install spacy` (or the `nlp` extra above) -- they're a
+      # separate download, required at runtime by checks/contradictions.py
+      # and exercised directly by its tests. Missed entirely until this
+      # workflow's first real run: the local dev venv already had this
+      # model downloaded by hand from early in the build, so every local
+      # `pytest` run passed silently while CI never actually had it.
+      - name: Download spaCy's small English model
+        run: python -m spacy download en_core_web_sm
+
+      - name: ruff
+        run: ruff check src tests contract_tests examples conftest.py
+
+      - name: mypy --strict
+        run: mypy src/kbguard
+
+      - name: pytest (unit + contract tests, real pgvector/Qdrant/Chroma)
+        run: pytest -q
+        env:
+          # Pinecone's live test (tests/test_adapters_pinecone_live.py)
+          # skips cleanly without these — no account needed for CI to
+          # pass; set them as repo secrets only if you want that
+          # coverage running here too.
+          PINECONE_API_KEY: ${{ secrets.PINECONE_API_KEY }}
+          PINECONE_TEST_INDEX: ${{ secrets.PINECONE_TEST_INDEX }}
+
+      - name: mkdocs build --strict
+        run: |
+          pip install -e ".[docs]"
+          mkdocs build --strict

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

@@ -0,0 +1,95 @@
+name: Publish to PyPI
+
+# Publishes a tagged release to the real PyPI index via Trusted Publishing
+# (OIDC — no stored API token, confirmed as PyPA's own current recommended
+# approach before writing this: https://docs.pypi.org/trusted-publishers/).
+# This workflow does NOT publish anything by itself. Nothing uploads until
+# a human explicitly creates a GitHub Release (which itself requires a
+# tag) — a deliberate, one-click-away-but-not-automatic trigger, not "every
+# push publishes."
+#
+# One-time manual setup required before this can work at all (done once,
+# on pypi.org, by whoever owns the PyPI account — not something a CI
+# workflow or an agent can do on your behalf):
+#   1. Create the `kbguard` project on PyPI (or reserve the name) if it
+#      doesn't exist yet.
+#   2. On the project's "Publishing" settings page, add a trusted
+#      publisher: GitHub owner "devbyanoop", repository "kbguard",
+#      workflow filename "release.yml", environment name "pypi" (must
+#      match exactly, including the environment below).
+#   3. In this repo's GitHub settings, create an environment named
+#      "pypi" (Settings → Environments) — add protection rules (e.g.
+#      required reviewers) if you want a human approval step before
+#      every publish, which is recommended for a one-way action like
+#      this.
+# See docs.pypi.org/trusted-publishers/adding-a-publisher/ for the exact
+# current PyPI-side steps (these change rarely but are PyPI's own UI, not
+# this repo's to document precisely).
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build and verify the distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install kbguard with every extra the test suite needs
+        run: pip install -e ".[all]"
+
+      # See kbguard.yml's identical step for why this is needed separately
+      # from the pip install above -- spaCy's model is not a regular pip
+      # dependency.
+      - name: Download spaCy's small English model
+        run: python -m spacy download en_core_web_sm
+
+      - name: ruff
+        run: ruff check src tests contract_tests examples conftest.py
+
+      - name: mypy --strict
+        run: mypy src/kbguard
+
+      - name: pytest (unit + contract tests; real external services/APIs skip cleanly without credentials)
+        run: pytest -q
+
+      - name: Build sdist and wheel
+        run: |
+          pip install --upgrade build twine
+          python -m build
+          twine check dist/*
+
+      - name: Upload the built distribution
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Matches the trusted-publisher configuration's "environment name"
+    # exactly (see the setup note above) — PyPI checks this as part of
+    # verifying the OIDC token actually came from the workflow/environment
+    # it was told to trust, not just from this repo in general.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/kbguard
+    permissions:
+      id-token: write  # the one thing trusted publishing actually needs — no secrets.PYPI_API_TOKEN anywhere
+    steps:
+      - name: Download the distribution built and verified above
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

kbguard-0.1.0/.github/workflows/test-publish.yml

@@ -0,0 +1,77 @@
+name: Publish to TestPyPI
+
+# Rehearses the real release.yml's Trusted Publishing mechanism against
+# the TestPyPI index before anything goes to the real PyPI index. Manually
+# triggered (workflow_dispatch) only -- a TestPyPI upload is still a real,
+# visible, one-way action (a given version string can never be
+# re-uploaded to the same index, same restriction as real PyPI), so this
+# never fires on its own.
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build and verify the distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install kbguard with every extra the test suite needs
+        run: pip install -e ".[all]"
+
+      # See kbguard.yml's identical step for why this is needed separately
+      # from the pip install above -- spaCy's model is not a regular pip
+      # dependency.
+      - name: Download spaCy's small English model
+        run: python -m spacy download en_core_web_sm
+
+      - name: ruff
+        run: ruff check src tests contract_tests examples conftest.py
+
+      - name: mypy --strict
+        run: mypy src/kbguard
+
+      - name: pytest (unit + contract tests; real external services/APIs skip cleanly without credentials)
+        run: pytest -q
+
+      - name: Build sdist and wheel
+        run: |
+          pip install --upgrade build twine
+          python -m build
+          twine check dist/*
+
+      - name: Upload the built distribution
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Matches the trusted-publisher configuration's "environment name"
+    # exactly -- same requirement as release.yml's "pypi" environment,
+    # kept as a separate environment name so a TestPyPI trusted publisher
+    # can never be confused with the real-PyPI one.
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/kbguard
+    permissions:
+      id-token: write  # the one thing trusted publishing actually needs -- no secrets.TESTPYPI_API_TOKEN anywhere
+    steps:
+      - name: Download the distribution built and verified above
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

kbguard-0.1.0/.gitignore

@@ -0,0 +1,48 @@
+# kbguard runtime data — snapshots contain client text, never commit
+.kbguard/
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Test / tool caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+#Do not commit following folders 
+Plan/
+# Env files that may hold secrets (judge model keys, DB creds)
+.env
+.env.*
+!.env.example
+
+# MkDocs build output (published separately, not committed to main)
+site/
+
+# Generated demo data — reproducible via examples/policy_corpus/seed.py
+examples/policy_corpus/chroma_data/
+
+# Generated demo data -- reproducible via examples/eval_demo/seed.py
+examples/eval_demo/chroma_data/
+
+# Generated golden set -- judge-generated content from a real LLM call,
+# reproducible via `kbguard golden generate`, not stable data. Named
+# individually, not as a whole-directory pattern: a directory-level
+# ignore (trailing slash) stops git from even looking inside it, so a
+# `!` exception for calibration.jsonl (hand-written, kept) wouldn't work.
+examples/eval_demo/evals/golden_review.csv
+examples/eval_demo/evals/golden.jsonl

kbguard-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 2026 Anoop Singh
+
+   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.