ctxverify 0.1.0__tar.gz

ctxverify-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Something ctxverify reports that is wrong, or something it fails to report
+title: ""
+labels: bug
+assignees: ""
+---
+
+**What happened**
+
+A rule fired on a pack it should not have, or a rule stayed silent on a pack
+it should have caught.
+
+**The pack**
+
+If you can share it, attach the eight files or a link. If not, the smallest
+reproduction you can manage: the claim, the evidence record, and the manifest
+source it points at.
+
+**What you ran**
+
+```
+ctxv check <pack> --format json
+```
+
+Paste the JSON output. It names the rule, the severity, the location and the
+hint.
+
+**What you expected**
+
+**Which version**
+
+```
+ctxv --version
+```
+
+**Anything else**
+
+The rule catalogue is in `docs/rules.md`. If a rule is doing something you
+did not expect, the rule id in the output is the fastest way to find its
+documentation.

ctxverify-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Context Pack Format (SPEC.md)
+    url: https://github.com/arronfly/ctxverify/blob/main/SPEC.md
+    about: The format specification, including the version rules and the conformance requirements.
+  - name: Rule catalogue
+    url: https://github.com/arronfly/ctxverify/blob/main/docs/rules.md
+    about: What each of the sixteen rules detects, why it matters, and how to fix what it reports.

ctxverify-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,25 @@
+---
+name: Feature request
+about: A check, an adapter, or a format change that would make ctxverify more useful
+title: ""
+labels: enhancement
+assignees: ""
+---
+
+**What you want to check**
+
+The problem you want a rule to catch. A concrete failure mode is worth more
+than a category name.
+
+**Why the current rules do not catch it**
+
+If one of the existing rules is close but not quite right, say which one and
+where it falls short. `docs/rules.md` lists all sixteen.
+
+**What a finding would look like**
+
+The rule id, the severity, and roughly the message.
+
+**A pack that triggers it**
+
+If you have one, that is the most useful thing you can bring.

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

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Upgrade pip
+        run: python -m pip install --upgrade pip
+
+      - name: Install the package and dev dependencies
+        run: "python -m pip install -e .[dev]"
+
+      - name: Run the test suite
+        env:
+          PYTHONPATH: src
+        run: |
+          python -m unittest discover -s tests -t .
+
+      - name: Check the example packs
+        run: |
+          set -e
+          PYTHONPATH=src python -m ctxverify check examples/clean-pack
+          echo "examples/clean-pack exited 0 as expected"
+
+          set +e
+          PYTHONPATH=src python -m ctxverify check examples/broken-pack
+          status=$?
+          set -e
+          if [ "$status" -ne 1 ]; then
+            echo "expected examples/broken-pack to exit 1, got $status"
+            exit 1
+          fi
+          echo "examples/broken-pack exited 1 as expected"
+
+      - name: Check that the README quotes real output
+        run: |
+          set -e
+          PYTHONPATH=src python -m unittest tests.test_docs -v

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

@@ -0,0 +1,52 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    name: Build the distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build
+        run: python -m pip install --upgrade pip build
+
+      - name: Build the sdist and wheel
+        run: python -m build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ctxverify
+    permissions:
+      id-token: write
+    steps:
+      - name: Download the distribution packages
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      # Trusted publishing: configure this repository and workflow as a
+      # trusted publisher on PyPI. No API token is stored in the repository.
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ctxverify-0.1.0/.gitignore

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

ctxverify-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,14 @@
+# The ctxverify hook expects a pack directory, not a list of files, so it is
+# invoked with `args: [<pack path>]` in the consuming repository's
+# .pre-commit-config.yaml. The path defaults to the current directory when no
+# argument is given.
+#
+# The `files` pattern below matches the pack's own files. Adjust it to point at
+# your pack directory; pre-commit applies it to the changed paths, and the
+# hook itself is told which directory to check through `args`.
+- id: ctxverify
+  name: ctxverify — check the context pack
+  entry: ctxv check
+  language: python
+  files: \.(json|jsonl)$
+  pass_filenames: false

ctxverify-0.1.0/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-05
+
+### Added
+
+- The 16 rules of the first release:
+  - `pack.structure` — Pack files are present and parseable
+  - `provenance.missing` — Claims are backed by evidence
+  - `provenance.dangling` — Evidence points at things that exist
+  - `provenance.quote` — Quotes are present and untampered
+  - `links.broken` — Links resolve to real files
+  - `ids.duplicate` — Identifiers are unique
+  - `ids.collision` — Numbered files do not collide
+  - `status.inconsistent` — Claim status matches its evidence
+  - `contradiction.unresolved` — Contradictions are tracked and closed
+  - `freshness.stale` — Claims are still fresh
+  - `duplicate.claim` — The same fact is not stated twice
+  - `orphan.source` — Sources are used
+  - `orphan.entity` — Entities are used
+  - `hygiene.secret` — No credentials in the pack
+  - `hygiene.pii` — No personal contact details in the pack
+  - `action.unverified` — Reported actions really happened
+- CLI commands: `check`, `init`, `export obsidian`, `export llmwiki`,
+  `verify-actions`, `rules`, and `mcp`.
+- Output formats for `check`: text, JSON and SARIF; `verify-actions` emits
+  text or JSON.
+- Adapters for Obsidian vaults and llmwiki projects.
+- An MCP server over stdio with four tools: `check_pack`, `list_claims`,
+  `get_claim` and `verify_actions`.
+- The action verifier, which checks an agent's reported actions against the
+  filesystem.
+- The exit code contract: `0` for a clean pack, `1` for blocking findings
+  (including warnings and info under `--strict`), and `2` when the pack cannot
+  be read or the invocation is unusable.
+
+### Notes
+
+0.1.0 is the first public release. The Context Pack Format version is 0.1.

ctxverify-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to ctxverify
+
+## Setup
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+ctxverify itself has no runtime dependencies. The `dev` extra installs the test
+dependencies only.
+
+## Running the tests
+
+```sh
+PYTHONPATH=src python -m unittest discover -s tests -t .
+```
+
+To check the bundled examples after a change:
+
+```sh
+PYTHONPATH=src python -m ctxverify check examples/clean-pack
+PYTHONPATH=src python -m ctxverify check examples/broken-pack
+```
+
+The first must exit 0 and the second must exit 1.
+
+## Adding a new check
+
+1. Implement the check in `src/ctxverify/checks/`, decorated with
+   `@register("<rule id>")`.
+2. Import the module at the bottom of `src/ctxverify/checks/__init__.py` so the
+   decorator runs.
+3. Add the rule to `RULES` in `src/ctxverify/rules.py` with the same stable id,
+   a severity, a category, a title and a one-line description. Rule ids are part
+   of the public contract: CI configurations select rules by id, so do not
+   rename an id once it has shipped.
+4. Add a test under `tests/` that fails before the check and passes after it.
+5. Document the rule in `docs/rules.md`.
+
+## Changing the format
+
+The format version is `FORMAT_VERSION` in `src/ctxverify/model.py`.
+
+- Bump it whenever the meaning of a file, a field or a status changes.
+- Add the new version to `SUPPORTED_FORMAT_VERSIONS`.
+- Keep old versions readable. A pack written against an older version must
+  still load, and unknown keys are preserved rather than rejected, so an older
+  linter can check a newer pack.
+- Update `SPEC.md` and the version noted in `CHANGELOG.md`.
+
+## Commits and pull requests
+
+- One logical change per commit. Use an imperative subject line of 72
+  characters or fewer, prefixed with the area touched, for example
+  `checks: reject empty evidence quotes`.
+- Run the tests and check both example packs before opening a pull request.
+- Describe what changed and why in the pull request body. Link the issue if
+  there is one.
+- Do not bump the version or edit released sections of `CHANGELOG.md` in a
+  feature pull request; releases are cut separately.
+- By contributing you agree that your contribution is licensed under the
+  Apache License, Version 2.0, the same license as the code.

ctxverify-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.