guardtrellis 0.1.0a1__tar.gz

guardtrellis-0.1.0a1/.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.0a1/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## 0.1.0a1 — release candidate
+
+The first alpha is prepared from source. Publication and its verification are tracked in
+[#4](https://github.com/sahilmathur254/guardtrellis/issues/4); this entry does not claim an upload.
+
+### 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.0a1/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# 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
+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.
+
+The current API is alpha and may change. Discuss public API or dependency changes before
+implementation and 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, then install extras and execute all
+three examples against each installed artifact. Build the sdist
+and wheel after updating packaged documentation or evaluation results.
+
+The workflow checks Python 3.11, 3.12, 3.13, and 3.14 on Linux. Check the run for the commit
+under review; 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.
+
+## Releases and licensing
+
+Package publication is maintainer work and follows the [release checklist](docs/releasing.md).
+No PyPI release is available yet. 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.0a1/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.

guardtrellis-0.1.0a1/PKG-INFO

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: guardtrellis
+Version: 0.1.0a1
+Summary: Composable local checks around model inputs, outputs, retrieval, and tools
+Project-URL: Source, https://github.com/sahilmathur254/guardtrellis
+Project-URL: Issues, https://github.com/sahilmathur254/guardtrellis/issues
+Project-URL: Documentation, https://github.com/sahilmathur254/guardtrellis/blob/main/docs/api.md
+Project-URL: Changelog, https://github.com/sahilmathur254/guardtrellis/blob/main/CHANGELOG.md
+Project-URL: Roadmap, https://github.com/users/sahilmathur254/projects/3
+Author: Sahil Mathur
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Typing :: Typed
+Requires-Python: <3.15,>=3.11
+Requires-Dist: jsonschema<5,>=4.23
+Requires-Dist: referencing<0.38,>=0.35
+Provides-Extra: fastapi
+Requires-Dist: fastapi<1,>=0.115; extra == 'fastapi'
+Requires-Dist: httpx<1,>=0.27; extra == 'fastapi'
+Requires-Dist: uvicorn<1,>=0.30; extra == 'fastapi'
+Provides-Extra: langgraph
+Requires-Dist: langgraph<2,>=1; extra == 'langgraph'
+Requires-Dist: langsmith<1,>=0.3; extra == 'langgraph'
+Description-Content-Type: text/markdown
+
+# GuardTrellis
+
+A small Python SDK for local checks around model inputs, complete outputs, retrieved text,
+and proposed tool calls. Policies are explicit, composable, and independent of model providers.
+
+**Alpha: 0.1.0a1.** APIs may change before a stable release.
+Supported Python: 3.11–3.14. Apache-2.0 licensed. Verified package availability is tracked
+in the [first alpha release issue](https://github.com/sahilmathur254/guardtrellis/issues/4).
+
+Use an activated virtual environment, then clone and install the source:
+
+```sh
+git clone https://github.com/sahilmathur254/guardtrellis.git
+cd guardtrellis
+python -m pip install -e .
+python examples/plain_callable.py
+```
+
+```python
+from guardtrellis import Guard, PIIScanner, SecretScanner
+
+guard = Guard(
+    input_scanners=[SecretScanner(), PIIScanner()],
+    output_scanners=[SecretScanner(), PIIScanner()],
+)
+
+# Deterministic local demonstration, not a real model integration.
+result = guard.run("Contact casey@example.org", lambda text: f"Received: {text}")
+print(result.require_text())  # Received: Contact [PII]
+print(result.diagnostics())  # Metadata only; no matched strings or prompt text.
+```
+
+`run` calls your callback only after accepted input checks, then checks the **complete**
+returned string before exposing it. Use `await guard.arun(text, callback)` for async work;
+both sync and async callbacks work there. Provider SDKs are not required by the core.
+
+| Check | Default | Scope |
+| --- | --- | --- |
+| `PIIScanner` | redact | ASCII email, contiguous international phone, US SSN shapes |
+| `SecretScanner` | block | Selected GitHub tokens, AWS access-key IDs, PEM private keys |
+| `InvisibleScanner` | warn | Unicode control/format characters except tab and newlines |
+| `LiteralScanner([...])` | block | Configured literal substrings; optional ASCII case folding |
+| `JSONScanner(schema)` | block invalid data | Strict JSON and constrained Draft 2020-12 schemas |
+| `ToolGuard({name: schema})` | block invalid calls | Exact tool names and object argument schemas |
+
+No scanners are installed implicitly: `Guard()` permits bounded text. Choose policies for each
+boundary. Heuristic matches are signals, not probabilities or comprehensive protection.
+
+```python
+from guardtrellis import Action, Guard, JSONScanner, LiteralScanner, Stage, ToolGuard
+
+guard = Guard(
+    retrieval_scanners=[LiteralScanner(["confidential"], action=Action.BLOCK)],
+    output_scanners=[JSONScanner({"type": "object", "required": ["answer"]})],
+)
+retrieval = guard.scan("A public reference", stage=Stage.RETRIEVAL)
+# In async code: await guard.ascan("A public reference", stage=Stage.RETRIEVAL)
+
+tools = ToolGuard(
+    {
+        "search": {
+            "type": "object",
+            "properties": {"query": {"type": "string", "maxLength": 200}},
+            "required": ["query"],
+            "additionalProperties": False,
+        },
+    }
+)
+call = tools.validate("search", '{"query":"public documentation"}')
+name, arguments = call.require_call()
+# Your application must still enforce identity, permissions, and execution limits.
+```
+
+`ALLOW`, `WARN`, and `REDACT` expose `result.text`; `BLOCK` and `ERROR` expose `None`.
+`require_text()` / `require_call()` raise a payload-free `Rejected` exception on rejection.
+WARN deliberately permits delivery. Scanner/callback exceptions are errors, never successful
+checks. The first block/error stops its stage. Input rejection prevents the callback entirely.
+
+Stages have separate scanner lists: `input_scanners`, `output_scanners`, `retrieval_scanners`,
+and `tool_scanners`. Use `scan(text, stage=Stage.INPUT/OUTPUT/RETRIEVAL/TOOL)` or `ascan`;
+the default stage is `Stage.INPUT`. Retrieval/tool checks must be invoked explicitly;
+`run` does not discover or intercept these operations. `ToolGuard` adds name/schema validation.
+
+Scanners run in configuration order. Each sees the text produced by preceding redactions.
+Findings record half-open character offsets, scanner index, and the **input revision** they
+refer to; every redacting scanner increments the revision. Offsets from different revisions
+must not be applied to the original string. No originals or rehydration maps are retained.
+
+Defaults: 100,000 characters per stage, 256 findings per scanner, JSON nesting at most 32,
+and a 5-second **per-operation async wait**. Synchronous calls have no execution deadline.
+Async cancellation cannot terminate a running thread or preempt a coroutine that blocks
+the event loop. Timed-out work may continue and have side effects. Use process isolation
+and application concurrency limits when execution must be forcibly bounded.
+
+## Examples and development
+
+```sh
+uv sync --all-extras --group dev
+uv run python examples/plain_callable.py
+uv run python examples/fastapi_app.py       # Local TestClient demo, no server needed
+uv run python examples/langgraph_app.py     # Local graph, no provider credentials
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+uv run python evaluation/run.py
+uv build
+uv run python scripts/smoke_dist.py
+```
+
+FastAPI and LangGraph are optional extras (`.[fastapi]`, `.[langgraph]`). LangGraph input
+checks run **before** text enters graph state. The example also checks model output before
+returning it to graph state. Instrumentation around callbacks may still capture raw data.
+
+See [API details](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/api.md),
+[limitations and trust boundaries](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/limitations.md),
+[evaluation methodology](https://github.com/sahilmathur254/guardtrellis/blob/main/evaluation/README.md),
+[measured smoke results](https://github.com/sahilmathur254/guardtrellis/blob/main/evaluation/REPORT.md),
+and [contribution guidance](https://github.com/sahilmathur254/guardtrellis/blob/main/CONTRIBUTING.md).
+These checks do not provide comprehensive
+prompt-injection prevention, factual verification, regulatory compliance, or a tool sandbox.
+
+## Roadmap and contributions
+
+Use the public [GitHub Project](https://github.com/users/sahilmathur254/projects/3) to find
+ready work and track progress. The [roadmap](https://github.com/sahilmathur254/guardtrellis/blob/main/ROADMAP.md) explains the release milestones,
+dependencies, and longer-term proposals. Start with a
+[good first issue](https://github.com/sahilmathur254/guardtrellis/labels/good%20first%20issue)
+or a [help wanted issue](https://github.com/sahilmathur254/guardtrellis/labels/help%20wanted),
+then follow the [contributor workflow](https://github.com/sahilmathur254/guardtrellis/blob/main/CONTRIBUTING.md).
+
+See the [changelog](https://github.com/sahilmathur254/guardtrellis/blob/main/CHANGELOG.md)
+for version-specific behavior and the [release guide](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/releasing.md)
+for packaging checks, TestPyPI rehearsal, and maintainer-approved publication.

guardtrellis-0.1.0a1/README.md

@@ -0,0 +1,134 @@
+# GuardTrellis
+
+A small Python SDK for local checks around model inputs, complete outputs, retrieved text,
+and proposed tool calls. Policies are explicit, composable, and independent of model providers.
+
+**Alpha: 0.1.0a1.** APIs may change before a stable release.
+Supported Python: 3.11–3.14. Apache-2.0 licensed. Verified package availability is tracked
+in the [first alpha release issue](https://github.com/sahilmathur254/guardtrellis/issues/4).
+
+Use an activated virtual environment, then clone and install the source:
+
+```sh
+git clone https://github.com/sahilmathur254/guardtrellis.git
+cd guardtrellis
+python -m pip install -e .
+python examples/plain_callable.py
+```
+
+```python
+from guardtrellis import Guard, PIIScanner, SecretScanner
+
+guard = Guard(
+    input_scanners=[SecretScanner(), PIIScanner()],
+    output_scanners=[SecretScanner(), PIIScanner()],
+)
+
+# Deterministic local demonstration, not a real model integration.
+result = guard.run("Contact casey@example.org", lambda text: f"Received: {text}")
+print(result.require_text())  # Received: Contact [PII]
+print(result.diagnostics())  # Metadata only; no matched strings or prompt text.
+```
+
+`run` calls your callback only after accepted input checks, then checks the **complete**
+returned string before exposing it. Use `await guard.arun(text, callback)` for async work;
+both sync and async callbacks work there. Provider SDKs are not required by the core.
+
+| Check | Default | Scope |
+| --- | --- | --- |
+| `PIIScanner` | redact | ASCII email, contiguous international phone, US SSN shapes |
+| `SecretScanner` | block | Selected GitHub tokens, AWS access-key IDs, PEM private keys |
+| `InvisibleScanner` | warn | Unicode control/format characters except tab and newlines |
+| `LiteralScanner([...])` | block | Configured literal substrings; optional ASCII case folding |
+| `JSONScanner(schema)` | block invalid data | Strict JSON and constrained Draft 2020-12 schemas |
+| `ToolGuard({name: schema})` | block invalid calls | Exact tool names and object argument schemas |
+
+No scanners are installed implicitly: `Guard()` permits bounded text. Choose policies for each
+boundary. Heuristic matches are signals, not probabilities or comprehensive protection.
+
+```python
+from guardtrellis import Action, Guard, JSONScanner, LiteralScanner, Stage, ToolGuard
+
+guard = Guard(
+    retrieval_scanners=[LiteralScanner(["confidential"], action=Action.BLOCK)],
+    output_scanners=[JSONScanner({"type": "object", "required": ["answer"]})],
+)
+retrieval = guard.scan("A public reference", stage=Stage.RETRIEVAL)
+# In async code: await guard.ascan("A public reference", stage=Stage.RETRIEVAL)
+
+tools = ToolGuard(
+    {
+        "search": {
+            "type": "object",
+            "properties": {"query": {"type": "string", "maxLength": 200}},
+            "required": ["query"],
+            "additionalProperties": False,
+        },
+    }
+)
+call = tools.validate("search", '{"query":"public documentation"}')
+name, arguments = call.require_call()
+# Your application must still enforce identity, permissions, and execution limits.
+```
+
+`ALLOW`, `WARN`, and `REDACT` expose `result.text`; `BLOCK` and `ERROR` expose `None`.
+`require_text()` / `require_call()` raise a payload-free `Rejected` exception on rejection.
+WARN deliberately permits delivery. Scanner/callback exceptions are errors, never successful
+checks. The first block/error stops its stage. Input rejection prevents the callback entirely.
+
+Stages have separate scanner lists: `input_scanners`, `output_scanners`, `retrieval_scanners`,
+and `tool_scanners`. Use `scan(text, stage=Stage.INPUT/OUTPUT/RETRIEVAL/TOOL)` or `ascan`;
+the default stage is `Stage.INPUT`. Retrieval/tool checks must be invoked explicitly;
+`run` does not discover or intercept these operations. `ToolGuard` adds name/schema validation.
+
+Scanners run in configuration order. Each sees the text produced by preceding redactions.
+Findings record half-open character offsets, scanner index, and the **input revision** they
+refer to; every redacting scanner increments the revision. Offsets from different revisions
+must not be applied to the original string. No originals or rehydration maps are retained.
+
+Defaults: 100,000 characters per stage, 256 findings per scanner, JSON nesting at most 32,
+and a 5-second **per-operation async wait**. Synchronous calls have no execution deadline.
+Async cancellation cannot terminate a running thread or preempt a coroutine that blocks
+the event loop. Timed-out work may continue and have side effects. Use process isolation
+and application concurrency limits when execution must be forcibly bounded.
+
+## Examples and development
+
+```sh
+uv sync --all-extras --group dev
+uv run python examples/plain_callable.py
+uv run python examples/fastapi_app.py       # Local TestClient demo, no server needed
+uv run python examples/langgraph_app.py     # Local graph, no provider credentials
+uv run pytest
+uv run ruff check .
+uv run ruff format --check .
+uv run mypy
+uv run python evaluation/run.py
+uv build
+uv run python scripts/smoke_dist.py
+```
+
+FastAPI and LangGraph are optional extras (`.[fastapi]`, `.[langgraph]`). LangGraph input
+checks run **before** text enters graph state. The example also checks model output before
+returning it to graph state. Instrumentation around callbacks may still capture raw data.
+
+See [API details](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/api.md),
+[limitations and trust boundaries](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/limitations.md),
+[evaluation methodology](https://github.com/sahilmathur254/guardtrellis/blob/main/evaluation/README.md),
+[measured smoke results](https://github.com/sahilmathur254/guardtrellis/blob/main/evaluation/REPORT.md),
+and [contribution guidance](https://github.com/sahilmathur254/guardtrellis/blob/main/CONTRIBUTING.md).
+These checks do not provide comprehensive
+prompt-injection prevention, factual verification, regulatory compliance, or a tool sandbox.
+
+## Roadmap and contributions
+
+Use the public [GitHub Project](https://github.com/users/sahilmathur254/projects/3) to find
+ready work and track progress. The [roadmap](https://github.com/sahilmathur254/guardtrellis/blob/main/ROADMAP.md) explains the release milestones,
+dependencies, and longer-term proposals. Start with a
+[good first issue](https://github.com/sahilmathur254/guardtrellis/labels/good%20first%20issue)
+or a [help wanted issue](https://github.com/sahilmathur254/guardtrellis/labels/help%20wanted),
+then follow the [contributor workflow](https://github.com/sahilmathur254/guardtrellis/blob/main/CONTRIBUTING.md).
+
+See the [changelog](https://github.com/sahilmathur254/guardtrellis/blob/main/CHANGELOG.md)
+for version-specific behavior and the [release guide](https://github.com/sahilmathur254/guardtrellis/blob/main/docs/releasing.md)
+for packaging checks, TestPyPI rehearsal, and maintainer-approved publication.