writ-sdk 0.1.0__tar.gz

writ_sdk-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+dist/
+build/
+*.egg-info/

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

writ_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.5
+Name: writ-sdk
+Version: 0.1.0
+Summary: Policy-gated tool calls for Python agents: every tool call is checked against writ.yaml and recorded to writ's hash-chained ledger.
+Project-URL: Homepage, https://github.com/writ-agent/writ
+Project-URL: Source, https://github.com/writ-agent/writ/tree/main/adapters/python
+Author-email: Bhaskar Gurram <gurrambhaskar.ai@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,audit,authorization,claude-agent-sdk,langgraph,openai-agents,policy
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Security
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: claude-agent-sdk
+Requires-Dist: claude-agent-sdk>=0.2; extra == 'claude-agent-sdk'
+Provides-Extra: dev
+Requires-Dist: claude-agent-sdk>=0.2; extra == 'dev'
+Requires-Dist: langchain-core>=1.0; extra == 'dev'
+Requires-Dist: langgraph>=1.0; extra == 'dev'
+Requires-Dist: openai-agents>=0.22; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Provides-Extra: langgraph
+Requires-Dist: langchain-core>=1.0; extra == 'langgraph'
+Requires-Dist: langgraph>=1.0; extra == 'langgraph'
+Provides-Extra: openai-agents
+Requires-Dist: openai-agents>=0.22; extra == 'openai-agents'
+Description-Content-Type: text/markdown
+
+# writ-sdk
+
+Python integrations for [writ](https://github.com/writ-agent/writ/blob/main/README.md). Every tool call an agent makes
+is checked against `writ.yaml` (allow / deny / ask / redact) before the tool
+runs, and recorded to writ's hash-chained ledger.
+
+The package has no runtime dependencies. It starts `writ check --stdio` as a
+long-lived child process and speaks the hook-gateway protocol
+([`docs/INTERFACES.md`, Contract 6](https://github.com/writ-agent/writ/blob/main/docs/INTERFACES.md)). Framework
+integrations import their framework only when you import them.
+
+## Install
+
+> **You also need the `writ` binary.** Until prebuilt releases ship, install it
+> from source: `cargo install --git https://github.com/writ-agent/writ writ-cli`
+> (Rust stable), then check with `writ --version`.
+
+```bash
+pip install writ-sdk                     # core: WritClient, Writ, @writ_tool
+pip install "writ-sdk[langgraph]"        # + LangGraph / LangChain
+pip install "writ-sdk[openai-agents]"    # + OpenAI Agents SDK
+pip install "writ-sdk[claude-agent-sdk]" # + Claude Agent SDK
+```
+
+You also need the `writ` binary. The client looks for it in this order: the
+`binary=` argument, the `WRIT_BIN` environment variable, then `writ` on `PATH`.
+`policy=` / `ledger=` become `--policy` / `--ledger`; otherwise writ uses
+`./writ.yaml` and `./.writ/ledger.jsonl` relative to the child's `cwd`.
+
+## Fail closed
+
+The tool does not run unless writ answers `dispatch: true`. Every failure
+raises a `WritError` subclass, and each framework integration turns that into
+a refusal the model can read:
+
+| Situation                                        | Result                          |
+|--------------------------------------------------|---------------------------------|
+| `deny` verdict                                   | `WritDenied` (rule, reason, `writ.yaml:LINE`) |
+| `ask`, approver rejects / times out / raises     | `WritApprovalRejected`          |
+| `ask` with `--ask deny` (the default)            | `WritApprovalRejected`          |
+| writ binary missing or cannot start              | `WritUnavailable`               |
+| `writ check` exits while a request is waiting    | `WritGatewayCrashed`            |
+| no answer within `timeout` (child is killed)     | `WritTimeout`                   |
+| non-JSON line, wrong id, contradictory response  | `WritProtocolError`             |
+| `{"error": ...}` response                        | `WritGatewayError`              |
+| `complete` fails after the tool ran              | output withheld from the model  |
+| `redact` verdict but no redacted output returned | output withheld from the model  |
+
+A request is never retried: a retried `decide` could write a second Decision
+record for one call. A crashed gateway is restarted on the next request, up to
+`max_restarts` (default 3) per `restart_window` (60 s); past that the client
+refuses to start writ again.
+
+## Core API
+
+```python
+from writ_sdk import Writ, writ_tool
+
+writ = Writ(policy="writ.yaml", session_id="run-42")   # one writ check process
+
+@writ.tool("fs.read")                 # the tool name your policy matches on
+def read_file(path: str) -> str:
+    return open(path).read()
+
+read_file("README.md")                # decide -> run -> complete; WritDenied if refused
+safe = writ.guarded(lambda command: ..., name="bash")
+writ.execute("postgres.query", {"query": sql}, lambda: db.run(sql))  # redact -> redacted text
+```
+
+The sequence is always: `decide`; for a deferred ask, the `approver` plus
+`resolve`; run; `complete`. For a `redact` verdict the value returned is the
+redacted **text** writ sends back, not the original object.
+
+`WritClient` / `AsyncWritClient` expose the raw protocol (`decide`, `resolve`,
+`complete`) with typed `Decision` / `Completion` results. Both are thread-safe
+and share one child process; `close()` (or `with`) closes its stdin and waits
+for it to exit, and an `atexit` hook closes anything left open.
+
+### Approvals
+
+With no approver, `Writ` runs `--ask deny`: every `ask` fails closed. Give it
+an approver and it runs `--ask defer`; the approver sees the call and the
+rule's diff, and its answer goes to writ with `resolve`:
+
+```python
+from writ_sdk import Approval, Writ
+
+def approve(req):                      # sync or async
+    print(req.decision.rule_id, req.diff, req.call.args)
+    return Approval(input("run it? [y/N] ") == "y", approver="human:alice")
+
+writ = Writ(approver=approve, approval_timeout=120)   # timeout -> rejected
+```
+
+Anything other than `True` / `Approval(True, ...)` rejects, as do exceptions
+and timeouts (default: the rule's `timeout_ms`, else 300 s).
+
+## LangGraph / LangChain
+
+Integration point: `ToolNode(wrap_tool_call=..., awrap_tool_call=...)`.
+ToolNode hands every tool call to the wrapper with an `execute` callable; the
+wrapper asks writ first. A blocked call becomes a `ToolMessage(status="error")`
+with writ's reason, so the model sees the refusal and the graph keeps going.
+The session id is the graph's `thread_id`.
+
+```python
+from langchain_core.tools import tool
+from langgraph.prebuilt import tools_condition
+from writ_sdk import Writ
+from writ_sdk.langgraph import writ_tool_node
+
+@tool
+def read_file(path: str) -> str:
+    """Read a file."""
+    return open(path).read()
+
+writ = Writ()
+graph.add_node("tools", writ_tool_node([read_file], writ))   # instead of ToolNode([...])
+graph.add_conditional_edges("model", tools_condition)
+app = graph.compile(); app.invoke(inputs, {"configurable": {"thread_id": "t-1"}})
+```
+
+`writ_tool_node` accepts every `ToolNode` argument; your own `wrap_tool_call`
+runs outside writ's, so writ decides on the request as it will execute. It
+can also be passed as `tools=` to `create_react_agent`. For tools invoked
+outside a ToolNode, `guard_tool(tool, writ)` wraps a single `BaseTool` (use
+one or the other, not both: each records its own decision). For a redact
+verdict the `ToolMessage` content is replaced and its `artifact` dropped; a
+`Command` result under a redact rule is withheld.
+
+## OpenAI Agents SDK
+
+Integration point: each `FunctionTool`'s `on_invoke_tool`, wrapped. That is
+the call `Runner` awaits to execute a tool, so the wrapper can decide before
+the tool body runs, record `complete`, and substitute the redacted output.
+`RunHooks.on_tool_start` cannot refuse a single call (its return value is
+ignored; raising aborts the run), and tool input guardrails see no output, so
+they cannot carry a redact verdict.
+
+```python
+from agents import Agent, RunConfig, Runner, function_tool
+from writ_sdk import Writ
+from writ_sdk.openai_agents import guard_agent
+
+@function_tool
+def read_file(path: str) -> str:
+    """Read a file."""
+    return open(path).read()
+
+writ = Writ()
+agent = guard_agent(Agent(name="coder", tools=[read_file]), writ)
+result = await Runner.run(agent, "read README.md", run_config=RunConfig(group_id="t-1"))
+```
+
+A blocked call returns writ's refusal as the tool result. Session id:
+`session_id=` (string or `ctx -> str`), else `RunConfig.group_id`, else a
+`session_id` on your run context, else the `Writ`'s. `guard_agent` refuses
+agents with tools it cannot gate (hosted tools, `mcp_servers`) unless you pass
+`strict=False`; put MCP servers behind `writ proxy --mcp` instead. Handoff
+targets are separate agents: guard each one. `guard_function_tool` wraps a
+single tool.
+
+## Claude Agent SDK
+
+Integration point: SDK hooks. `PreToolUse` decides (allow / deny with writ's
+reason), `PostToolUse` records `complete` and, for a redact verdict, returns
+`updatedToolOutput` with the redacted result, `PostToolUseFailure` records the
+failure. `can_use_tool` is not used: the CLI only consults it when its own
+permission rules would prompt, and it has no post-execution step.
+
+```python
+from claude_agent_sdk import ClaudeAgentOptions, ClaudeSDKClient
+from writ_sdk import Writ
+from writ_sdk.claude_agent_sdk import writ_hooks
+
+writ = Writ()
+options = ClaudeAgentOptions(hooks=writ_hooks(writ))
+async with ClaudeSDKClient(options) as client:
+    await client.query("list the repo and summarize README.md")
+    async for message in client.receive_response():
+        print(message)
+```
+
+Tool names are mapped exactly as `writ check --format claude-code` maps them
+([`toolmap.py`](https://github.com/writ-agent/writ/blob/main/adapters/python/src/writ_sdk/toolmap.py)), so one `writ.yaml` covers Claude
+Code and the SDK:
+
+| Claude tool                                   | writ `tool`  | policy field           |
+|-----------------------------------------------|--------------|------------------------|
+| `Bash`, `PowerShell`                          | `bash`       | `command`              |
+| `Read`, `Glob`, `Grep`, `LS`, `NotebookRead`  | `fs.read`    | `path` (from `file_path`) |
+| `Write`, `Edit`, `MultiEdit`, `NotebookEdit`  | `fs.write`   | `path` (from `file_path` / `notebook_path`) |
+| `WebFetch`                                    | `http`       | `url` (`url.host`)     |
+| `WebSearch`                                   | `web.search` | `query`                |
+| `mcp__<server>__<tool>`                       | `<tool>`     | `server = <server>`    |
+| anything else                                 | unchanged    | unchanged              |
+
+Redacted output keeps the tool's output shape (Claude Code rejects a
+mismatched `updatedToolOutput` for built-in tools); if the redacted result
+cannot be parsed back into the same shape, every string in the output is
+masked. The hooks never raise; any adapter failure answers `deny`.
+
+## Development
+
+```bash
+python -m venv .venv && .venv/Scripts/python -m pip install -e ".[dev]"   # bin/ on POSIX
+.venv/Scripts/python -m pytest
+WRIT_E2E=1 WRIT_BIN=/path/to/writ .venv/Scripts/python -m pytest tests/test_e2e_writ.py
+```
+
+Unit tests run against `tests/fake_writ.py`, a small Contract 6 gateway that
+picks verdicts by tool name and can misbehave on request (malformed lines,
+hangs, crashes, contradictions). Framework tests use each framework's real
+runtime with a scripted model: a LangGraph `StateGraph`, the Agents SDK's
+`agents.testing.ScriptedModel`, and a scripted stand-in for the Claude Code
+CLI behind the SDK's `Transport`. No network, no API keys. The e2e module is
+skipped unless `WRIT_E2E=1`; it builds nothing and uses `WRIT_BIN`.
+
+Tested with Python 3.14, langgraph 1.2.12 / langchain-core 1.6.4,
+openai-agents 0.22.3, claude-agent-sdk 0.2.157. Requires Python >= 3.10.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/writ-agent/writ/blob/main/adapters/python/LICENSE).