augur-sdk 0.1.0__tar.gz

augur_sdk-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+dist/
+build/
+
+# Editors
+.vscode/
+.idea/
+*.swp
+.DS_Store
+
+# Secrets / env
+.env
+.env.local
+.env.*.local
+
+# Logs / bundles
+*.log
+augur-data/
+bundles/
+
+# MkDocs build output
+site/

augur_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to `augur-sdk` are recorded here. Format roughly follows
+[Keep a Changelog](https://keepachangelog.com/), with semver applied per
+`docs/versioning.md` upstream (`MAJOR.MINOR.PATCH`; pre-1.0 minors may break).
+
+## [Unreleased]
+
+## [0.1.0] — 2026-05-19
+
+Initial standalone release.
+
+### Added
+
+- `DebugSession` context manager — the only API a CUA needs to integrate.
+- Capture modes (`off` / `metadata` / `trace` / `screenshots` / `model_io` / `dispatch` / `replay` / `full`) spec'd in `augur_sdk.CaptureMode`.
+- Atomic local bundle writer with path-stable layout (`manifest.json`, `trace.json`, `steps/`, `events/`, `screenshots/`, `AGENT.md`, `schema/`).
+- DSN-based streaming sink (Sentry-style). Set `AUGUR_DSN=…` or pass `dsn=` directly; per-step + per-screenshot POSTs with a 15 s heartbeat. Bundle on disk is always written even if the network is flapping.
+- Vendored JSON Schemas (`augur_sdk._schema`) — zero monorepo dependency at install time.
+- `RedactionPolicy` + shipped `default-pii-v1` policy: drops `Authorization` / `Cookie` / `Set-Cookie` / `X-API-Key`; masks `token` / `api_key` / `ssn` / `credit_card` / `cvv`; regex-scrubs bearer tokens, AWS keys, JWTs, and password=… patterns.
+- Diagnostic rules engine + generic `cua` rule pack (10 rules). Adapter packs land via the `augur.rule_packs` entry-point group.
+- Adapter base protocol (`augur_sdk.Adapter`) + contract for adapter authors.
+- `LocalFSStore` (default) + `S3Store` stub for forward compatibility.
+- `validate_bundle()` — schema-validates every record in a bundle against the vendored JSON Schemas.
+
+### Compatibility
+
+- Schema version: `0.1`.
+- Python: ≥ 3.11.
+- Compatible with the Augur server's `/api/v1/*` ingest endpoints at server version 0.1.x.

augur_sdk-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 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 Support. 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 support.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 The Augur Authors
+
+   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.

augur_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,322 @@
+Metadata-Version: 2.4
+Name: augur-sdk
+Version: 0.1.0
+Summary: Augur SDK — instrument any screenshot-grounded computer-use agent (CUA). Sentry-style DSN streaming + local bundle writer.
+Project-URL: Homepage, https://mercurialsolo.github.io/augur-sdk/
+Project-URL: Repository, https://github.com/mercurialsolo/augur-sdk
+Project-URL: Documentation, https://mercurialsolo.github.io/augur-sdk/
+Project-URL: Issues, https://github.com/mercurialsolo/augur-sdk/issues
+Project-URL: Changelog, https://mercurialsolo.github.io/augur-sdk/changelog/
+Author-email: Augur Authors <barada@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: computer-use-agent,cua,debugger,instrumentation,observability,screenshot-grounding,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: jsonschema>=4.22
+Requires-Dist: referencing>=0.35
+Requires-Dist: urllib3>=2
+Description-Content-Type: text/markdown
+
+# augur-sdk
+
+[![PyPI](https://img.shields.io/pypi/v/augur-sdk.svg)](https://pypi.org/project/augur-sdk/)
+[![Python](https://img.shields.io/pypi/pyversions/augur-sdk.svg)](https://pypi.org/project/augur-sdk/)
+[![License: Apache 2.0](https://img.shields.io/badge/license-Apache_2.0-blue.svg)](LICENSE)
+[![Docs](https://img.shields.io/badge/docs-mercurialsolo.github.io/augur--sdk-blue.svg)](https://mercurialsolo.github.io/augur-sdk/)
+
+**Full docs:** https://mercurialsolo.github.io/augur-sdk/
+
+Instrument any **screenshot-grounded computer-use agent** (CUA) with one
+context manager. Streams traces to **Augur** (a hosted cloud service for
+CUA observability) over a Sentry-style DSN AND writes a path-stable
+bundle to disk — both work, both at once, no extra glue.
+
+> This is the **public client SDK**. The Augur server, viewer, and CLI
+> are a managed cloud service — sign up at augur (URL TBD) to get a DSN.
+> The SDK also works standalone in local-bundle mode with no account.
+
+```python
+from augur_sdk import CaptureMode, DebugSession
+
+with DebugSession(
+    run_id="run_abc",
+    client_name="myagent",
+    capture_mode=CaptureMode.SCREENSHOTS,
+    out_dir="/var/log/augur/run_abc",
+) as session:
+    pre  = session.attach_observation(step_index=0, kind="pre",  png_bytes=...)
+    post = session.attach_observation(step_index=0, kind="post", png_bytes=...)
+    session.record_step({
+        "step_id":          "run_abc/step/0000",
+        "step_index":       0,
+        "step_type":        "click",
+        "intent":           "Click the login button",
+        "status":           "succeeded",
+        "started_at":       "2026-05-19T00:00:00Z",
+        "observation_pre":  pre,
+        "observation_post": post,
+        "action":   {"type": "click", "params": {"x": 100, "y": 200},
+                     "coordinate_space": "viewport_css_px",
+                     "dispatch_backend": "playwright"},
+        "grounding": {"provider": "myagent", "provenance": "screenshot"},
+        "verdict":   {"status": "passed"},
+    })
+```
+
+Set `AUGUR_DSN=…` and the same code streams to your Augur server. No code
+change required to switch between local-only and hosted modes.
+
+## Install
+
+### From PyPI (when published)
+
+```bash
+pip install augur-sdk
+# or
+uv pip install augur-sdk
+```
+
+### From source (today)
+
+```bash
+git clone https://github.com/mercurialsolo/augur-sdk.git
+cd augur-sdk
+pip install -e .
+# or
+uv pip install -e .
+```
+
+### Requirements
+
+- Python ≥ 3.11
+- `jsonschema`, `referencing`, `urllib3` (installed automatically)
+
+The SDK is self-contained: JSON Schemas are vendored inside the package
+(`augur_sdk._schema`), so `import augur_sdk` requires no other Augur
+components. The Augur server, viewer, and CLI are operated as a hosted
+service — you only need this package on the **client side** (your CUA
+runtime).
+
+## Quickstart — three modes
+
+### 1. Local-only (no server)
+
+The default. Bundles are written under `out_dir/`. Use `augur view <dir>`
+from the main Augur repo to render them in the viewer, or hand the path
+to a coding agent.
+
+```python
+from augur_sdk import CaptureMode, DebugSession
+
+with DebugSession(
+    run_id="run_abc",
+    client_name="myagent",
+    out_dir="/var/log/augur/run_abc",
+    capture_mode=CaptureMode.SCREENSHOTS,
+) as session:
+    ...
+```
+
+### 2. Stream to an Augur server (Sentry-style)
+
+Set one env var; nothing else changes.
+
+```bash
+export AUGUR_DSN='https://augur.example/api/v1?token=<api_key>&tenant=<tenant_slug>'
+```
+
+The SDK heart-beats every 15 s while a session is open so the server's
+connection-status indicator stays green. Each step + screenshot + event
+streams over HTTPS with `Authorization: Bearer <api_key>`. The local
+bundle is still written; streaming is observe-only on top.
+
+Or pass the DSN directly:
+
+```python
+DebugSession(dsn="https://augur.example/api/v1?token=...&tenant=...", ...)
+```
+
+Get a DSN by asking an Augur admin to run:
+
+```bash
+augur admin dsn-issue --tenant <your-tenant> --label <client-name>
+```
+
+### 3. Adapter pattern (existing CUA exports)
+
+Already have a trace exporter (Mantis-style)? Write a small adapter that
+maps your shape to Augur records. See the
+[adapter authoring guide](docs/reference/adapter-authoring.md).
+
+## What gets written
+
+Every bundle is path-stable — no discovery needed:
+
+```text
+out_dir/
+  manifest.json           # envelope: schema_version, bundle_format, paths, signatures
+  trace.json              # session + ordered steps[]
+  AGENT.md                # coding-agent-friendly index (first-read hints, layout)
+  steps/0000.json         # one StepTrace per file
+  events/0000.jsonl       # decision events per step (planner / grounding / verifier / recovery)
+  screenshots/0000_pre.png
+  screenshots/0000_post.png
+  diagnostics/findings.json   # if `augur diagnose` has been run
+  schema/*.schema.json    # canonical record schemas (vendored for offline validation)
+```
+
+The same bundle drives the viewer, the CLI, and any coding agent. See
+[`docs/concepts/bundle-layout.md`](docs/concepts/bundle-layout.md) for
+the full normative spec.
+
+## Capture modes
+
+The `capture_mode` arg controls how much the SDK writes:
+
+| Mode          | What it captures                                                | Cost |
+|---------------|-----------------------------------------------------------------|------|
+| `off`         | Manifest envelope only                                          | none |
+| `metadata`    | + run/step ids, status, action type, failure class              | tiny |
+| `trace`       | + decisions, verifier output, recovery, grounding summary       | low  |
+| `screenshots` | + pre/post PNGs + coordinate overlays                           | med  |
+| `video`       | + video / MJPEG references                                      | med  |
+| `model_io`    | + prompts, model responses, redacted secrets                    | med  |
+| `dispatch`    | + input dispatch details, retries, post-action state checks     | low  |
+| `replay`      | + observation/task/context state for replay fixtures            | med  |
+| `full`        | All above, subject to redaction + retention                     | high |
+
+Set via `capture_mode=CaptureMode.FULL` or `AUGUR_CAPTURE_MODE=full`.
+
+## Redaction
+
+`default-pii-v1` ships in the box and is applied to every bundle:
+
+- Drops `Authorization`, `Cookie`, `Set-Cookie`, `X-API-Key` headers entirely.
+- Masks `token`, `api_key`, `ssn`, `credit_card`, `cvv` keys.
+- Regex-scrubs bearer tokens, AWS keys, JWTs, password=… patterns out of strings.
+- Honors `sensitive=True` on a step: pre/post screenshots are dropped.
+
+Subclass `augur_sdk.RedactionPolicy` for tighter rules:
+
+```python
+from augur_sdk import DebugSession, RedactionPolicy
+
+class StrictPolicy(RedactionPolicy):
+    id = "strict-v1"
+    drop_keys = RedactionPolicy.drop_keys | frozenset({"customer_email"})
+
+DebugSession(redaction_policy=StrictPolicy(), ...)
+```
+
+## Diagnostics
+
+Augur ships a generic CUA rules pack you can run against any bundle:
+
+```python
+from augur_sdk.diagnostics import RulesEngine, load_pack
+
+engine = RulesEngine(load_pack("cua"))
+findings = engine.evaluate("/path/to/bundle")
+for f in findings:
+    print(f["severity"], f["rule_id"], f["summary"])
+```
+
+Adapter-specific packs (e.g. `mantis`) are registered via the
+`augur.rule_packs` entry-point group; install the corresponding adapter
+package alongside this SDK and they appear automatically in
+`load_pack(...)`.
+
+## CUA contract — what the SDK enforces
+
+Per Augur's design invariant: **runtime action selection MUST remain
+screenshot-grounded**. The SDK doesn't enforce this at write time, but
+the diagnostic-rules engine and the viewer both flag DOM-derived
+coordinates that show up in `grounding.provenance != "screenshot"` and
+get used as runtime inputs. Tag DOM probes as `provenance: dom` so they
+stay visible as **diagnostic** evidence without being mistaken for the
+agent's real target.
+
+## Develop
+
+```bash
+git clone https://github.com/mercurialsolo/augur-sdk.git
+cd augur-sdk
+uv sync                 # creates .venv and installs dev deps
+uv run pytest           # tests
+uv run ruff check .     # lint
+uv run mypy -p augur_sdk  # types
+```
+
+## Publish to PyPI
+
+Releases are tag-driven and run through `.github/workflows/release.yml`,
+which authenticates to PyPI via **OIDC Trusted Publishing** — no API
+token is stored anywhere.
+
+### One-time setup
+
+1. Register the project on PyPI as a pending publisher:
+   https://pypi.org/manage/account/publishing/
+   - PyPI project name: `augur-sdk`
+   - Owner: `mercurialsolo`
+   - Repository: `augur-sdk`
+   - Workflow name: `release.yml`
+   - Environment name: `pypi`
+2. (Optional) Pre-create the `pypi` GitHub Environment if you want to
+   gate releases behind required reviewers:
+
+   ```bash
+   gh api -X PUT /repos/mercurialsolo/augur-sdk/environments/pypi
+   ```
+
+### Cut a release
+
+1. Bump `__version__` in `src/augur_sdk/_version.py` and `version` in
+   `pyproject.toml`.
+2. Move the `[Unreleased]` block in `CHANGELOG.md` under the new version.
+3. Commit, tag, push:
+
+   ```bash
+   git commit -am "Release v0.1.0"
+   git tag v0.1.0 -m "Initial release"
+   git push origin main v0.1.0
+   ```
+
+The tag push triggers `release.yml`: lint → typecheck → test → `uv build`
+→ publish to PyPI via OIDC. The wheel + sdist are also uploaded as
+workflow artefacts.
+
+### Local build / manual upload (escape hatch)
+
+If you need to publish outside CI (don't, normally):
+
+```bash
+uv build              # produces dist/*.whl + dist/*.tar.gz
+uv publish            # uses ~/.pypirc or UV_PUBLISH_TOKEN
+```
+
+## Where Augur lives
+
+Augur (server, viewer, CLI, diagnostic rule packs, Mantis adapter) is a
+**hosted cloud service** — not open source. This SDK is the only
+component your CUA runtime needs; everything else is operated for you.
+
+- **Get a DSN / sign up**: contact your Augur workspace admin, or reach
+  out at the project email below.
+- **Issues for this SDK**: https://github.com/mercurialsolo/augur-sdk/issues
+- **Schemas**: vendored under `src/augur_sdk/_schema/json/` in this repo.
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).