guardtrellis 0.1.0__tar.gz

guardtrellis-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+*.egg-info/
+.DS_Store
+.env
+.env.*
+handoff.md

guardtrellis-0.1.0/CHANGELOG.md

@@ -0,0 +1,117 @@
+# Changelog
+
+## 0.1.0
+
+- Adopt a [compatibility and support policy](docs/compatibility.md) for the `0.1.x`
+  final-release series: preserve documented public imports, call signatures, result fields,
+  action/stage meanings, and existing diagnostics; define detection-fix exceptions,
+  deprecation notices, supported Python versions, and dependency/maintenance expectations.
+- Prepare non-alpha package metadata and matching installation instructions. Update current
+  documentation to describe the compatibility promise while retaining historical alpha notes,
+  evaluation reports, and provider verification limits.
+- Define changelog maintenance rules for user-visible changes, compatibility/dependency
+  changes, detection fixes, and migration guidance. Distinguish normal GitHub releases from
+  prereleases in the publishing checklist.
+
+No core runtime or scanner-rule changes from `0.1.0a4`. Applications using its documented
+API need only update their version pin and run their application checks. Copied OpenAI/Azure
+SDK 2 adapters from earlier alphas still need the
+[SDK 3 migration](docs/openai.md#sdk-3-compatibility) already included in `0.1.0a4`.
+Detection coverage, serialized-JSON scanning, async cancellation, and host-owned authorization
+retain their [documented limitations](docs/limitations.md).
+
+## 0.1.0a4 — 2026-09-28
+
+- Add a runnable retrieval/tool-call recipe using only core dependencies. It demonstrates
+  checking retrieved text before prompt assembly, validating proposed tool arguments, and
+  executing the checked call behind application-owned authorization. Rejection tests and
+  fresh distribution smokes cover the complete recipe.
+- Add a separate 40-case synthetic Unicode/PII development challenge set with provenance,
+  multilingual context, benign cases, escaped JSON pairs, and retained failures. Reports
+  include per-family/language results and action counts; the original 72-case corpus and
+  historical reports are preserved. These development results are not an independent benchmark.
+- Migrate the optional OpenAI/Azure examples to OpenAI SDK 3 and HTTPX2. The `openai` extra
+  now requires `openai>=3,<4` and `httpx2>=2.12,<3`. Custom transports, clients, and exception
+  handling must use HTTPX2; its default certificate trust comes from the operating system.
+  See the [migration guide](docs/openai.md#sdk-3-compatibility). Both provider paths remain
+  mock-verified; no new live provider verification is claimed.
+- Refresh the package description, versioned installation commands, guide links for PyPI,
+  and roadmap completion evidence.
+
+No core Guard/scanner API or detection-rule changes. This remains an experimental alpha;
+application authorization, execution limits, and output handling remain the host's responsibility.
+
+## 0.1.0a3
+
+- Generate the module version and README installation instructions from `pyproject.toml`.
+  CI checks source, lockfile, and changelog agreement; release validation checks the README
+  embedded in both distributions and the description returned by TestPyPI and PyPI.
+  Corrects the stale `0.1.0a1` installation pin shipped in the `0.1.0a2` description.
+
+- Reproducible offline resource measurements in bounded child processes, with retained
+  CPU/wall stops, input/finding/depth boundary cases, expensive schemas, and cancellation
+  observations. Includes host-control guidance and a separate reviewed local baseline;
+  no core runtime limits or detection rules change.
+
+## 0.1.0a2 — 2026-09-26
+
+- Optional OpenAI Responses callback example with a credential-free HTTP mock, tested
+  input/output boundaries, and a separately opted-in one-request live smoke. Adds the
+  `openai` extra without changing core dependencies or public Guard APIs. Live verification
+  is pending; see the [integration guide](docs/openai.md).
+- Standalone Azure OpenAI Chat Completions example using the same optional SDK extra,
+  with mocked HTTP boundary/failure tests and a separate, explicitly opted-in bounded
+  live command. Azure live verification is also pending; see its [guide](docs/azure_openai.md).
+- CI installation coverage for macOS and Windows alongside Linux Python 3.11–3.14.
+- Optional Gemini Developer API example with a separate `gemini` extra, mocked boundary
+  tests, and a one-request live smoke for an approved Free Tier project. See the
+  [Gemini guide](docs/gemini.md#recorded-live-smoke-2026-09-26) for the passing one-request
+  live smoke on 2026-09-26 (10 input and 5 output tokens).
+- Clarified which synthetic evaluation fixtures and baselines belong in version control.
+
+No core Guard/scanner API or detection-rule changes. The recorded `0.1.0a1` synthetic
+baseline is retained. Gemini supplies the recorded live provider evidence; OpenAI and
+Azure remain mock-verified only. Published after the
+[TestPyPI rehearsal](https://github.com/sahilmathur254/guardtrellis/actions/runs/36245484256)
+and [PyPI promotion](https://github.com/sahilmathur254/guardtrellis/actions/runs/36245714535).
+Its package description contains an outdated installation pin; use the latest release instead.
+
+## 0.1.0a1 — 2026-09-25
+
+The first alpha is available on [PyPI](https://pypi.org/project/guardtrellis/0.1.0a1/).
+The [GitHub prerelease](https://github.com/sahilmathur254/guardtrellis/releases/tag/v0.1.0a1)
+records the exact source commit, unchanged rehearsed artifacts, and verification evidence.
+Publication is tracked in [#4](https://github.com/sahilmathur254/guardtrellis/issues/4).
+
+### Included
+
+- Typed `Guard` and scanner contracts with synchronous/asynchronous entry points,
+  explicit input/output/retrieval/tool stages, and ordered redaction provenance.
+- Explicit allow, warn, redact, block, and error outcomes. Rejected inputs do not reach
+  callbacks; blocked/error results do not expose ordinary deliverable text or arguments.
+- Local checks for documented PII shapes, selected secret signatures, Unicode control/format
+  characters, literal policies, strict JSON/constrained Draft 2020-12 schemas, and tool-call
+  name/object-argument validation.
+- Bounded text, findings, and JSON depth; per-operation async waits with documented
+  cancellation limitations; metadata-only diagnostics and payload-free rejection errors.
+- Optional, credential-free callable, FastAPI, and LangGraph examples. The core requires
+  only jsonschema and referencing plus their dependencies, with no provider SDK or model download.
+- Python 3.11–3.14 support, typed package metadata, Apache-2.0 licensing, wheel/sdist
+  installation checks, and a reproducible synthetic smoke evaluation with retained failures.
+
+### Compatibility and known limitations
+
+This is an experimental API. Names, contracts, and dependencies can change before a stable
+version; such changes will be documented with migration guidance. Pin an exact alpha version
+or source commit when evaluating it. No new runtime API changes are included in release preparation.
+
+Checks inspect only explicitly supplied text and configured formats. Coverage excludes many
+PII/secret formats and semantic safety judgments. WARN permits delivery, unconfigured stages
+permit bounded text, and tool validation supplies neither authorization nor sandboxing.
+Outputs are checked only after the complete callback response; there is no streaming API.
+Async timeout does not terminate arbitrary Python code or undo callback side effects.
+
+The 72-case authored smoke corpus includes four known misses and two false positives. Its
+aggregate results are not a general accuracy estimate or an independent security benchmark.
+See [limitations](docs/limitations.md), [API contracts](docs/api.md), and the
+[evaluation report](evaluation/REPORT.md) before integrating.

guardtrellis-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# Contributing to GuardTrellis
+
+## Choose work
+
+Start with the [roadmap](ROADMAP.md) and the public
+[GitHub Project](https://github.com/users/sahilmathur254/projects/3). Its **Ready to contribute**
+view contains scoped work that can start now. Issues labelled
+[good first issue](https://github.com/sahilmathur254/guardtrellis/labels/good%20first%20issue)
+have a small entry point; [help wanted](https://github.com/sahilmathur254/guardtrellis/labels/help%20wanted)
+also includes more involved work.
+
+Read the issue's acceptance criteria, dependencies, and existing discussion before starting.
+Comment with your intended approach so the maintainer can coordinate overlapping work.
+For a new substantial feature, open a proposal first. Documentation improvements, safe
+reproductions, tests, and evaluation cases are useful contributions too.
+
+Repository issues hold scope and completion evidence; the project holds status and priority.
+Maintainers manage project status and assignments. You can contribute through a fork and
+pull request without project or repository write access. No response-time commitment is made.
+
+## Set up a contribution
+
+Fork the repository on GitHub, replace `YOUR_USERNAME` below with your account, then run:
+
+```sh
+git clone https://github.com/YOUR_USERNAME/guardtrellis.git
+cd guardtrellis
+git remote add upstream https://github.com/sahilmathur254/guardtrellis.git
+git switch -c describe-your-change
+```
+
+Use Python 3.11–3.14. The project uses a src layout, Hatchling, and uv's dependency lock.
+The runtime depends only on jsonschema and referencing plus their dependencies. Keep
+model providers, frameworks, network clients, and model downloads out of core dependencies.
+
+```sh
+uv sync --frozen --all-extras --group dev
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+uv run python evaluation/run.py --report-dir /tmp/guardtrellis-eval
+uv build
+uv run python scripts/smoke_dist.py
+```
+
+If the default uv cache is unavailable, set `UV_CACHE_DIR` to a writable local directory.
+On machines whose Python trust store is incomplete, use a verified system CA bundle via
+`SSL_CERT_FILE`; never disable certificate verification. uv must be installed separately.
+
+## Keep changes reviewable
+
+Implement one scoped issue per pull request where practical. Follow the existing API and
+dependency patterns. Add behavior-focused regression coverage when changing runtime behavior;
+check links and examples for documentation changes. State which checks actually ran and any
+remaining limitations. CI runs the full checks against submitted code.
+
+Open a pull request from your fork to `main`, link the issue, explain the user-visible change,
+and include validation evidence. Use `Fixes #NUMBER` when the PR completes the issue; use
+`Refs #NUMBER` for partial work. Address review feedback before merge. Do not mark a roadmap
+item complete until its acceptance criteria are met and its completion evidence is linked.
+
+Follow the [0.1.x compatibility policy](docs/compatibility.md). Discuss public API or
+supported-dependency changes before implementation; keep existing documented calls and
+results compatible in patch releases. Include migration notes when compatibility is affected.
+
+Test behavior and failure boundaries: rejected content must not reach callbacks or normal
+results; scanner/callback failures must be explicit errors; no raw input belongs in logs,
+reprs, generic exceptions, or diagnostics. Preserve meaningful offsets through redaction.
+New checks need supported-format documentation, benign challenges, and bounded processing.
+Do not add broad automatic injection-blocking phrases without evidence and explicit policy.
+
+Use fabricated data in issues, examples, fixtures, and reports. Remove credentials and personal
+data from logs and reproductions. Describe tooling or AI assistance when it affects attribution,
+verification, or a reviewer's ability to reproduce the change; contributors remain responsible
+for understanding and validating submitted code.
+
+Tests run against the installed editable package. Optional example tests skip when extras
+are absent; the CI matrix installs all extras, so those tests must run there. Distribution
+smokes install the wheel and source archive in fresh temporary environments outside this
+directory, verify core installs exclude frameworks, provider SDKs, and HTTP clients, then
+install only the OpenAI extra and execute both OpenAI examples without legacy HTTPX. Finally,
+they install all extras and execute all seven examples against each installed artifact. The
+OpenAI, Azure, and Gemini examples use in-memory HTTP mocks, including when credentials
+exist in the environment. See the
+[OpenAI](docs/openai.md), [Azure](docs/azure_openai.md), and [Gemini](docs/gemini.md) guides
+for separately opted-in live smokes;
+normal pytest and CI never make live provider calls. Build the sdist
+and wheel after updating packaged documentation or evaluation results.
+
+The CI matrix covers these combinations:
+
+| Runner | Architecture | Python |
+| --- | --- | --- |
+| Linux (`ubuntu-latest`) | x64 | 3.11, 3.12, 3.13, 3.14 |
+| macOS 15 (`macos-15`) | ARM64 | 3.12 |
+| Windows Server 2025 (`windows-2025`) | x64 | 3.12 |
+
+Every combination runs the full tests with extras, lint/format/type checks, the synthetic
+evaluation, and fresh wheel/sdist installation checks with all seven examples. Each job has
+a 15-minute limit; failures do not cancel the other matrix jobs. Bash runs workflow commands
+on all runners so a failed command stops its step; Python and its subprocesses run natively
+on each OS. The macOS and Windows jobs initially cover one Python version each.
+
+Check the run for the commit under review, including its runner image details; local success
+does not establish remote CI success. Synthetic evaluation limitations and reported false
+positives/misses are part of the deliverable, not tests to tune away.
+Do not include real credentials or personal data in tests, fixtures, or reports.
+
+For evaluation contributions, follow the [versioned challenge-set guide](evaluation/challenges/README.md).
+Record provenance, language, scenario-based labels, and development/held-out use. Compare
+per-family/language results and actions; keep detector changes separate from collecting
+fixtures. Evaluation commands require a new report directory and refuse to overwrite prior
+runs. CI runs both the historical smoke corpus and the Unicode/PII challenge set without
+requiring a particular detection score.
+
+For changes to resource limits or cancellation, use the separate
+[bounded measurement harness](docs/resource_limits.md). It runs fixed scenarios in child
+processes with external deadlines and records incomplete work honestly. Tests check
+containment and outcomes without asserting performance thresholds. Keep exploratory
+reports outside the checkout; update the reviewed resource baseline only intentionally.
+
+## Maintain the changelog
+
+`CHANGELOG.md` is the canonical changelog. Every user-visible behavior, API, diagnostic,
+detection, supported-version, or dependency-requirement change needs a concise entry in the
+next release. Describe the effect on users, affected formats or dependencies, and any upgrade
+action. Internal-only refactors and typo fixes need an entry only when useful to adopters.
+
+Keep released entries and historical evaluation evidence intact. Add changes to the current
+source version's entry while it is unpublished. Once that version has shipped, coordinate the
+next version with the maintainer, add its heading above prior releases, and use the release
+sync/lock commands in [the release guide](docs/releasing.md#prepare-and-review). The first
+version heading must match `pyproject.toml`; a standalone `Unreleased` heading is not supported
+by the existing release checks. A date is optional; if included, use the actual publication
+date rather than a planned date. The changelog is packaged in the source archive and supplies
+the user-facing GitHub release notes.
+
+## Releases and licensing
+
+Package publication is maintainer work and follows the [release checklist](docs/releasing.md).
+See [PyPI](https://pypi.org/project/guardtrellis/) for the latest published version and
+the [README](README.md) for installation instructions matching this source checkout.
+A merged contribution does not itself trigger publication.
+The project is Apache-2.0 licensed; preserve applicable notices when adding third-party material.

guardtrellis-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.