pywrit 0.2.4__tar.gz → 0.2.6__tar.gz

{pywrit-0.2.4 → pywrit-0.2.6}/PKG-INFO

@@ -1,15 +1,23 @@
 Metadata-Version: 2.4
 Name: pywrit
-Version: 0.2.4
+Version: 0.2.6
 Summary: Python client + CLI for Writ — the gate before the write
-License: MIT
+License-Expression: MIT
 Project-URL: Homepage, https://github.com/AvenueDAdmin/pywrit
 Project-URL: Documentation, https://withwrit.com/docs
-Keywords: ai-agents,policy,audit-log,guardrails
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27
+Provides-Extra: polyglot
+Requires-Dist: tree-sitter>=0.23; extra == "polyglot"
+Requires-Dist: tree-sitter-typescript>=0.23; extra == "polyglot"
+Requires-Dist: tree-sitter-javascript>=0.23; extra == "polyglot"
+Provides-Extra: keywords
+Requires-Dist: ai-agents; extra == "keywords"
+Requires-Dist: policy; extra == "keywords"
+Requires-Dist: audit-log; extra == "keywords"
+Requires-Dist: guardrails; extra == "keywords"
 Dynamic: license-file
 
 # pywrit
@@ -32,6 +40,18 @@ pip install pywrit
 
 Requires Python 3.9+. Installs the `writ` command and the `pywrit` Python client.
 
+**JavaScript/TypeScript devs:** run the scanner with no Python setup via npm:
+
+```bash
+npx writ-scan .
+```
+
+The `writ-scan` package wraps the same scanner (including TS/JS support). On
+first run it installs `pywrit[polyglot]` from PyPI using your Python 3.9+
+(one-time); afterwards it starts instantly. See [`npm/`](npm/) for details,
+environment overrides (`WRIT_PYTHON`, `WRIT_SCAN_NO_INSTALL`), and the
+install test.
+
 ## 60-second quickstart: scan → apply → gate
 
 **1. Scan.** See which functions write, and how many of them are gated.
@@ -114,13 +134,42 @@ Python (`.py`) files, parsed with the stdlib `ast` (no extra dependencies):
   calls such as `stripe.Refund.create(...)`, deferred task queues, or shared clients
   several layers down. The risk report lists these gaps every time.
 
-### TypeScript / JavaScript: coming soon (not yet released)
+### TypeScript / JavaScript (scan-only)
+
+`writ scan` also finds write sites in TypeScript and JavaScript. It needs the
+optional extra (tree-sitter based):
+
+    pip install 'pywrit[polyglot]'
+    writ scan .
+
+Without the extra, the scanner prints a one-line hint and keeps going —
+Python scanning never needs it.
+
+TS/JS is **scan-only**: findings are listed with verbs for your policy file,
+but `writ scan --apply` never rewrites TS/JS files — gate those by hand.
+Covered patterns: `fetch`/`axios` writes, `fs` writes, SQL through knex-style
+clients, Prisma writes, and JS SDK calls such as `stripe.refunds.create(...)`.
+(Still not covered: the *Python* SDK equivalents like `stripe.Refund.create(...)`
+— see "Not covered" above.)
+
+![writ scan on a TypeScript agent finds 5 write sites, 1 of 5 gated](https://raw.githubusercontent.com/AvenueDAdmin/pywrit/main/docs/assets/scan-tsjs.gif)
+
+## GitHub Action
+
+Scan every pull request for ungated write sites. Findings land as check
+annotations on the exact file and line, plus a Markdown risk report in the
+job summary. The check fails when an ungated finding meets your
+`fail-on-risk` threshold (default: `high`).
 
-> **Not available in `pywrit` 0.2.2 or on PyPI yet.** The current release scans
-> Python only. The preview below shows scan-only TS/JS support that is still in
-> development; the command it uses is not available yet.
+```yaml
+- uses: actions/checkout@v4
+- uses: AvenueDAdmin/pywrit@v1
+  with:
+    fail-on-risk: high   # high | medium | low | never
+```
 
-![Preview, not yet released: writ scan on a TypeScript agent finds 5 write sites, 1 of 5 gated](https://raw.githubusercontent.com/AvenueDAdmin/pywrit/main/docs/assets/scan-tsjs.gif)
+No API key needed. Full reference: [docs/github-action.md](docs/github-action.md) ·
+example workflow: [examples/github-action/writ-scan.yml](examples/github-action/writ-scan.yml)
 
 ## Python client
 
@@ -185,6 +234,32 @@ writ grant --sponsor acme --agent agent-7 --verb payments.refund \
 Sponsor-token commands (`revoke`, `reinstate`, `revoked`, `grant`) read
 `--sponsor-token` or `WRIT_SPONSOR_TOKEN`. Run `writ --help` for the full command list.
 
+## README badge
+
+Show that your agent's writes are gated by Writ. Two flavors:
+
+**Static** (works today, no API key) — same design, no live count:
+
+```md
+[![agent writes gated by Writ](https://cdn.jsdelivr.net/gh/AvenueDAdmin/pywrit@main/badge/writ-gated.svg)](https://withwrit.com)
+```
+
+**Dynamic** (live 30-day gated-write count from your audit log) — mint a badge
+token, then embed the snippet the API returns:
+
+```bash
+curl -s https://api.withwrit.com/v1/badge/tokens \
+  -H "Authorization: Bearer writ_..." \
+  -H "Content-Type: application/json" \
+  -d '{}'
+```
+
+The dynamic endpoint ships with the gate — until it's live, `POST /v1/badge/tokens`
+returns 404 and the static badge above is the one to use.
+
+See [`badge/`](badge/) for embed docs and the verification model (what the
+badge proves — and what it doesn't).
+
 ## Docs
 
 Full docs: [docs.withwrit.com](https://docs.withwrit.com) ·

pywrit-0.2.4/src/pywrit.egg-info/PKG-INFO → pywrit-0.2.6/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.4
-Name: pywrit
-Version: 0.2.4
-Summary: Python client + CLI for Writ — the gate before the write
-License: MIT
-Project-URL: Homepage, https://github.com/AvenueDAdmin/pywrit
-Project-URL: Documentation, https://withwrit.com/docs
-Keywords: ai-agents,policy,audit-log,guardrails
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx>=0.27
-Dynamic: license-file
-
 # pywrit
 
 **Find the dangerous writes in your Python agent's code, then gate it.** `pywrit` is the Python
@@ -32,6 +18,18 @@ pip install pywrit
 
 Requires Python 3.9+. Installs the `writ` command and the `pywrit` Python client.
 
+**JavaScript/TypeScript devs:** run the scanner with no Python setup via npm:
+
+```bash
+npx writ-scan .
+```
+
+The `writ-scan` package wraps the same scanner (including TS/JS support). On
+first run it installs `pywrit[polyglot]` from PyPI using your Python 3.9+
+(one-time); afterwards it starts instantly. See [`npm/`](npm/) for details,
+environment overrides (`WRIT_PYTHON`, `WRIT_SCAN_NO_INSTALL`), and the
+install test.
+
 ## 60-second quickstart: scan → apply → gate
 
 **1. Scan.** See which functions write, and how many of them are gated.
@@ -114,13 +112,42 @@ Python (`.py`) files, parsed with the stdlib `ast` (no extra dependencies):
   calls such as `stripe.Refund.create(...)`, deferred task queues, or shared clients
   several layers down. The risk report lists these gaps every time.
 
-### TypeScript / JavaScript: coming soon (not yet released)
+### TypeScript / JavaScript (scan-only)
+
+`writ scan` also finds write sites in TypeScript and JavaScript. It needs the
+optional extra (tree-sitter based):
 
-> **Not available in `pywrit` 0.2.2 or on PyPI yet.** The current release scans
-> Python only. The preview below shows scan-only TS/JS support that is still in
-> development; the command it uses is not available yet.
+    pip install 'pywrit[polyglot]'
+    writ scan .
 
-![Preview, not yet released: writ scan on a TypeScript agent finds 5 write sites, 1 of 5 gated](https://raw.githubusercontent.com/AvenueDAdmin/pywrit/main/docs/assets/scan-tsjs.gif)
+Without the extra, the scanner prints a one-line hint and keeps going —
+Python scanning never needs it.
+
+TS/JS is **scan-only**: findings are listed with verbs for your policy file,
+but `writ scan --apply` never rewrites TS/JS files — gate those by hand.
+Covered patterns: `fetch`/`axios` writes, `fs` writes, SQL through knex-style
+clients, Prisma writes, and JS SDK calls such as `stripe.refunds.create(...)`.
+(Still not covered: the *Python* SDK equivalents like `stripe.Refund.create(...)`
+— see "Not covered" above.)
+
+![writ scan on a TypeScript agent finds 5 write sites, 1 of 5 gated](https://raw.githubusercontent.com/AvenueDAdmin/pywrit/main/docs/assets/scan-tsjs.gif)
+
+## GitHub Action
+
+Scan every pull request for ungated write sites. Findings land as check
+annotations on the exact file and line, plus a Markdown risk report in the
+job summary. The check fails when an ungated finding meets your
+`fail-on-risk` threshold (default: `high`).
+
+```yaml
+- uses: actions/checkout@v4
+- uses: AvenueDAdmin/pywrit@v1
+  with:
+    fail-on-risk: high   # high | medium | low | never
+```
+
+No API key needed. Full reference: [docs/github-action.md](docs/github-action.md) ·
+example workflow: [examples/github-action/writ-scan.yml](examples/github-action/writ-scan.yml)
 
 ## Python client
 
@@ -185,6 +212,32 @@ writ grant --sponsor acme --agent agent-7 --verb payments.refund \
 Sponsor-token commands (`revoke`, `reinstate`, `revoked`, `grant`) read
 `--sponsor-token` or `WRIT_SPONSOR_TOKEN`. Run `writ --help` for the full command list.
 
+## README badge
+
+Show that your agent's writes are gated by Writ. Two flavors:
+
+**Static** (works today, no API key) — same design, no live count:
+
+```md
+[![agent writes gated by Writ](https://cdn.jsdelivr.net/gh/AvenueDAdmin/pywrit@main/badge/writ-gated.svg)](https://withwrit.com)
+```
+
+**Dynamic** (live 30-day gated-write count from your audit log) — mint a badge
+token, then embed the snippet the API returns:
+
+```bash
+curl -s https://api.withwrit.com/v1/badge/tokens \
+  -H "Authorization: Bearer writ_..." \
+  -H "Content-Type: application/json" \
+  -d '{}'
+```
+
+The dynamic endpoint ships with the gate — until it's live, `POST /v1/badge/tokens`
+returns 404 and the static badge above is the one to use.
+
+See [`badge/`](badge/) for embed docs and the verification model (what the
+badge proves — and what it doesn't).
+
 ## Docs
 
 Full docs: [docs.withwrit.com](https://docs.withwrit.com) ·

{pywrit-0.2.4 → pywrit-0.2.6}/pyproject.toml

@@ -4,12 +4,21 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pywrit"
-version = "0.2.4"
+version = "0.2.6"
 description = "Python client + CLI for Writ — the gate before the write"
 readme = "README.md"
-license = { text = "MIT" }
+license = "MIT"
 requires-python = ">=3.9"
 dependencies = ["httpx>=0.27"]
+
+[project.optional-dependencies]
+# `pip install 'pywrit[polyglot]'`: lets `writ scan` parse TypeScript and
+# JavaScript (scan only). Python scanning never needs it.
+polyglot = [
+    "tree-sitter>=0.23",
+    "tree-sitter-typescript>=0.23",
+    "tree-sitter-javascript>=0.23",
+]
 keywords = ["ai-agents", "policy", "audit-log", "guardrails"]
 
 [project.urls]

{pywrit-0.2.4 → pywrit-0.2.6}/src/pywrit/__init__.py

@@ -27,7 +27,7 @@ from .errors import (
     WritError,
 )
 
-__version__ = "0.2.4"
+__version__ = "0.2.6"
 
 __all__ = [
     "WritClient",