toolframe-audit 0.1.0__tar.gz

toolframe_audit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: Validate Python distribution
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  validate:
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 25
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-24.04, macos-15]
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
+        with:
+          version: '0.12.8'
+          enable-cache: false
+      - name: Test and install wheel and source distribution
+        run: python scripts/validate_release.py --output dist/validated
+      - name: Retain only validated distributions
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-dist-${{ matrix.os }}
+          path: dist/validated/*
+          if-no-files-found: error
+          retention-days: 14

toolframe_audit-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,65 @@
+name: Publish Python distribution
+
+on:
+  workflow_dispatch:
+    inputs:
+      index:
+        description: Package index; run against the matching vVERSION tag
+        type: choice
+        options: [testpypi, pypi]
+        default: testpypi
+        required: true
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-${{ inputs.index }}
+  cancel-in-progress: false
+
+jobs:
+  release-tag:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: '3.14.7'
+      - name: Require the exact package version tag
+        env:
+          RELEASE_REF: ${{ github.ref }}
+        run: |
+          python - <<'PYCODE'
+          import os, pathlib, tomllib
+          project = tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']
+          expected = 'refs/tags/v' + project['version']
+          if os.environ['RELEASE_REF'] != expected:
+              raise SystemExit('Publication requires ' + expected)
+          PYCODE
+
+  validate:
+    needs: release-tag
+    uses: ./.github/workflows/ci.yml
+    secrets: inherit
+
+  publish:
+    needs: [release-tag, validate]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    environment:
+      name: ${{ inputs.index }}
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-dist-ubuntu-24.04
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2
+        with:
+          packages-dir: dist/
+          repository-url: ${{ inputs.index == 'testpypi' && 'https://test.pypi.org/legacy/' || 'https://upload.pypi.org/legacy/' }}

toolframe_audit-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+/.venv/
+/build/
+/dist/
+/.pytest_cache/
+/.ruff_cache/
+/examples/outbox-producer/.venv/
+/examples/outbox-producer/dist/
+/examples/outbox-producer/build/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.DS_Store
+
+# Local working documents, issue state, and development worktrees.
+/.local/
+/.issues/
+/.worktrees/

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

toolframe_audit-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.5
+Name: toolframe-audit
+Version: 0.1.0
+Summary: Durable source-fenced audit events and transactional outbox helpers for Toolframe
+Project-URL: Homepage, https://github.com/toolframe/toolframe-audit
+Project-URL: Repository, https://github.com/toolframe/toolframe-audit
+Project-URL: Documentation, https://github.com/toolframe/toolframe-audit#readme
+Project-URL: Issues, https://github.com/toolframe/toolframe-audit/issues
+Author-email: byfb <62798989+byfb@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: toolframe-sdk==0.3.0
+Provides-Extra: ui
+Requires-Dist: streamlit<2,>=1.61; extra == 'ui'
+Description-Content-Type: text/markdown
+
+# Toolframe Audit
+
+Audit stores bounded, durable event history from trusted Toolframe producers. It
+provides a filtered Dashboard page, a read-only MCP tool, JSONL page exports and
+explicit retention management. A reusable transactional outbox helper keeps a
+producer's business mutation and pending audit event in the same SQL transaction.
+
+## Quick start
+
+Python 3.14 or later, Toolframe SDK 0.3.0 and a running Toolframe application with
+a SQL storage provider are required. Install from PyPI:
+
+```sh
+toolframe --home ./my-app plugin add pypi:toolframe-audit==0.1.0 --enable
+toolframe --home ./my-app plugin status audit --check
+```
+
+An application with Dashboard, MCP and llms providers publishes the Audit page,
+`audit__list_events` tool and usage document. Grant `audit.read` for read access and
+the existing Manage plugins permission (`system.plugins.manage`) only to retention
+operators. No client ingestion endpoint exists;
+events arrive from a plugin declaring the `audit.events` dependency. Public
+access policy still applies: configure authentication before exposing audit data.
+
+For a complete local producer walkthrough, see
+[the independently built example](examples/outbox-producer/README.md).
+[Producer integration](docs/producer-integration.md) describes the reusable
+helper, transaction boundary and replay behavior.
+
+## Support limits
+
+Version 0.1.0 uses only public SDK service and storage contracts. SQLite is tested
+with real managed stores and Core worker processes. PostgreSQL migration SQL is
+provided, but PostgreSQL runtime behavior requires separate verification.
+Producers are trusted Python plugins: this is traceable operational history,
+not tamper-proof storage or cryptographic proof of historical actor identity.
+
+Events have a 16 KiB metadata limit and a 20 KiB total payload limit. The default
+capacity is 100,000 retained events; `max_events` accepts 1–1,000,000. Full stores
+reject new events while pending outbox items remain for retry. Reads and exports
+contain at most 100 rows per page. Retention previews and explicit prune calls
+handle at most 1,000 rows per batch; no automatic purge runs. Data survives plugin
+reload, disable and application restart. Pruning permanently removes selected
+history and advances a cutoff that rejects late older events.
+
+See [architecture and trust](docs/architecture.md),
+[usage](src/toolframe_audit/docs/usage.md) and
+[verification](docs/verification.md) for contracts and reproducible checks.
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).

toolframe_audit-0.1.0/README.md

@@ -0,0 +1,50 @@
+# Toolframe Audit
+
+Audit stores bounded, durable event history from trusted Toolframe producers. It
+provides a filtered Dashboard page, a read-only MCP tool, JSONL page exports and
+explicit retention management. A reusable transactional outbox helper keeps a
+producer's business mutation and pending audit event in the same SQL transaction.
+
+## Quick start
+
+Python 3.14 or later, Toolframe SDK 0.3.0 and a running Toolframe application with
+a SQL storage provider are required. Install from PyPI:
+
+```sh
+toolframe --home ./my-app plugin add pypi:toolframe-audit==0.1.0 --enable
+toolframe --home ./my-app plugin status audit --check
+```
+
+An application with Dashboard, MCP and llms providers publishes the Audit page,
+`audit__list_events` tool and usage document. Grant `audit.read` for read access and
+the existing Manage plugins permission (`system.plugins.manage`) only to retention
+operators. No client ingestion endpoint exists;
+events arrive from a plugin declaring the `audit.events` dependency. Public
+access policy still applies: configure authentication before exposing audit data.
+
+For a complete local producer walkthrough, see
+[the independently built example](examples/outbox-producer/README.md).
+[Producer integration](docs/producer-integration.md) describes the reusable
+helper, transaction boundary and replay behavior.
+
+## Support limits
+
+Version 0.1.0 uses only public SDK service and storage contracts. SQLite is tested
+with real managed stores and Core worker processes. PostgreSQL migration SQL is
+provided, but PostgreSQL runtime behavior requires separate verification.
+Producers are trusted Python plugins: this is traceable operational history,
+not tamper-proof storage or cryptographic proof of historical actor identity.
+
+Events have a 16 KiB metadata limit and a 20 KiB total payload limit. The default
+capacity is 100,000 retained events; `max_events` accepts 1–1,000,000. Full stores
+reject new events while pending outbox items remain for retry. Reads and exports
+contain at most 100 rows per page. Retention previews and explicit prune calls
+handle at most 1,000 rows per batch; no automatic purge runs. Data survives plugin
+reload, disable and application restart. Pruning permanently removes selected
+history and advances a cutoff that rejects late older events.
+
+See [architecture and trust](docs/architecture.md),
+[usage](src/toolframe_audit/docs/usage.md) and
+[verification](docs/verification.md) for contracts and reproducible checks.
+
+For release validation and Trusted Publisher setup, see [releasing](docs/releasing.md).

toolframe_audit-0.1.0/docs/architecture.md

@@ -0,0 +1,114 @@
+# Audit architecture and trust model
+
+Toolframe Audit is an ordinary service plugin that stores bounded event history
+in the application's SQL storage. Version 0.1.0 requires Python 3.14 or later
+and `toolframe-sdk==0.3.0`. It requires the public
+`toolframe.storage.sql` service and uses only public SDK and service contracts;
+it does not import Core internals or extend the provider-kind registry.
+
+## Service boundary
+
+The plugin exposes `audit.events@1`:
+
+- `ingest` is an internal method available to declared producer dependencies.
+  There is no public client ingestion endpoint and no caller-supplied source
+  identity field.
+- `list_events` is a read-only business method requiring `audit.read`.
+- `prune_events` is a system method requiring the existing Manage plugins operator
+  permission (`system.plugins.manage`). It previews or applies one explicitly
+  bounded retention batch. Public business access does not grant this permission.
+
+The plugin also publishes a Dashboard page, the read-only MCP tool
+`audit__list_events`, and an `audit.read`-protected usage document. The
+scoped service route is
+`/_toolframe/v1/services/audit/audit.events/list_events`; it requires
+`audit.read`. The Dashboard shows exact filters, empty and error states,
+bounded pages, keyset navigation, and a JSONL download of the displayed page.
+A page export is limited to 100 events; callers that need a larger review must
+continue with `next_before`.
+
+## Event and storage contract
+
+An event has these fields: `event_id`, UTC `occurred_at`, `action`,
+`entity_type`, `entity_id`, `metadata`, and `source_attested_actor`. Text
+fields are bounded; metadata is a JSON object of at most 16 KiB, 1,024 JSON
+values including container objects, arrays and the root, and eight nesting
+levels. The complete canonical event payload is at most 20
+KiB. A small set of obvious credential and secret key names is rejected as a
+basic defense. Producers must still minimize and redact metadata at the source.
+
+Each stored row receives a monotonic `sequence`, the application and source
+identity, the source generation, `received_at`, the original payload, and a
+`delivery_actor` snapshot. Indexes support source, action, entity, and
+occurred-time queries. Reads accept `limit` 1–100 and can be filtered by
+source owner, action, entity type, entity ID, and UTC `since`/`until` times.
+The response is additionally bounded to 512,000 encoded bytes, so a page can
+contain fewer rows than its requested limit; continue with `next_before`.
+The uniqueness key is
+`(application_id, source_owner, event_id)`. A retry with the same key and the
+same canonical content returns `duplicate` and does not consume capacity. The
+same logical ID with different content is rejected. Data and deduplication
+state are stored in the managed SQL store and survive reload, disable, and
+restart. SQLite and PostgreSQL migration SQL are packaged; PostgreSQL runtime
+support requires separate verification.
+
+The configured `max_events` capacity defaults to 100,000 and accepts values
+from 1 through 1,000,000. New events are rejected when retained capacity is
+full, while producer outbox records remain available for retry. Accepted
+duplicates do not consume capacity.
+
+Capacity bounds retained event rows and payloads, rather than the complete
+database file size. Storage-provider transaction receipts, indexes and database
+allocation have their own overhead. Explicit pruning does not promise that a
+SQLite file immediately shrinks; plan disk capacity and provider maintenance
+separately.
+
+## Identity and trust
+
+At the ingestion boundary, Audit takes `owner`, `owner_generation`,
+`application_id`, `root_id`, and `principal` from the host-admitted call
+context. Missing or malformed owner/application context is rejected, and a
+producer cannot select another source by putting an override in its event.
+When Core invokes Audit through a producer dependency, a missing visitor
+principal is represented as the `background` delivery actor; it is not a
+reason to reject an otherwise admitted service call.
+
+The reusable producer helper captures the admitted principal at enqueue time
+as `source_attested_actor`. Audit records the host-admitted delivery principal as
+`delivery_actor` on first insertion; retries do not rewrite it. The historical
+source actor is vouched for by the producer that supplied the snapshot. It is
+not cryptographically attested by Core, and a delivery actor does not prove
+who originally caused the business action. Audit is durable, traceable
+operational history, not a tamper-proof ledger.
+
+Audit is intended for trusted Python plugins. A plugin with permission to run
+arbitrary code can fabricate an otherwise valid event or alter its own local
+outbox before delivery. Never put credentials, tokens, cookies, session
+material, or full request and response bodies in event metadata or logs.
+
+## Retention
+
+Retention is explicit and scoped. An operator with `system.plugins.manage` first asks
+for a preview with a UTC cutoff and a batch limit of at most 1,000 rows. The
+preview returns a `through_sequence` high-water mark. Applying a prune requires
+an explicit sequence cap and `preview=False`; there is no automatic purge. The
+Dashboard preserves the preview's cutoff, limit and sequence cap and invalidates
+the preview when inputs change. The service does not save or bind preview intent:
+API operators explicitly choose the apply inputs, and eligible rows can change
+under concurrent pruning. An apply never fills in a newer cap automatically. The
+persisted cutoff advances monotonically, and the selected rows are deleted in
+a bounded transaction.
+
+Pruning removes the corresponding event and deduplication history. A later new
+or replayed event older than the retained cutoff is rejected with
+`audit_retention`; an already-existing duplicate can still acknowledge a
+previously accepted outbox item. Pending producer items that fall behind the
+cutoff require operator attention.
+
+Keyset traversal is not a consistent snapshot. Inserts or explicit pruning
+between requests can change which rows appear on later pages; callers that
+need a point-in-time report must coordinate that operationally.
+
+For the reusable same-store delivery pattern, see
+[Producer integration](producer-integration.md). For the public read and
+retention call shapes, see the packaged [usage guide](../src/toolframe_audit/docs/usage.md).

toolframe_audit-0.1.0/docs/producer-integration.md

@@ -0,0 +1,116 @@
+# Producer integration
+
+The Audit package includes a small transactional outbox helper for business
+plugins. It lets a producer commit its business mutation and the pending audit
+event in one SQL transaction, then deliver events to Audit with finite,
+at-least-once retries.
+
+## Add the producer migration
+
+Append the migration returned by `outbox_migration()` to the producer's own
+linear SQL store schema. The default revision is `audit_outbox_v1`; pass a
+different revision or `parent` when that is required by the producer's
+migration history.
+
+```python
+from toolframe_audit import outbox_migration
+
+# Append this value after the producer's existing store migration.
+audit_outbox = outbox_migration(parent="producer_v1")
+```
+
+The migration creates the producer-local pending outbox and its bounded
+capacity counter. It does not create a second database or claim a cross-store
+transaction.
+
+## Enqueue with the business write
+
+Use the producer's live `StorageClient` transaction for both operations. The
+helper must receive the same transaction context; it never opens a second
+transaction.
+
+Pass the exact client used for the business mutation, including any custom
+storage alias. The helper rejects a client from another runtime context. If the
+producer uses a nondefault alias, pass that same alias as `storage_alias` when
+draining; Core still fences each store by producer ownership.
+
+```python
+from toolframe_audit import enqueue
+
+async with context.storage().transaction() as tx:
+    await tx.execute(
+        "UPDATE invoices SET status = ? WHERE invoice_id = ?",
+        ("paid", invoice_id),
+    )
+    await enqueue(
+        context,
+        tx,
+        event_id=f"invoice:{invoice_id}:paid:v1",
+        action="invoice.paid",
+        entity_type="invoice",
+        entity_id=invoice_id,
+        metadata={"payment_method": "card"},
+    )
+```
+
+`event_id` is the producer's stable logical identifier. `action`,
+`entity_type`, and `entity_id` are required. `metadata` defaults to `{}` and
+`occurred_at` defaults to the current UTC time; both are validated against the
+event limits. `max_pending` defaults to 1,000 and accepts 1 through 100,000.
+Reuse the same timestamp and payload when enqueueing an existing logical ID;
+changing `occurred_at` is conflicting content, even if the action is unchanged.
+If pending capacity is full, enqueue raises and the surrounding business
+transaction rolls back, leaving no business state without its audit intent.
+
+The collector takes the source owner from the admitted producer context. The
+helper snapshots the original actor and accepts no source or actor overrides. An
+admitted background task without a visitor principal records `background`. The captured
+`source_attested_actor` is an original snapshot vouched for by the producer;
+it is not cryptographic proof supplied by Core. Redact passwords, tokens,
+credentials, cookies, session material, and full request or response bodies
+before calling the helper. The key-name check in Audit is only a basic defense,
+not a complete redaction system.
+
+## Drain a finite batch
+
+Run the drain from an admitted producer root, such as a bounded maintenance or
+worker invocation:
+
+```python
+from toolframe_audit import drain
+
+result = await drain(context, limit=25, budget_seconds=10)
+```
+
+`limit` defaults to 25 and is capped at 100. `budget_seconds` defaults to 10
+and is capped at 30. The drain reads pending rows in enqueue order, calls the
+internal `audit.events/ingest` service, and accepts only an `accepted` or
+`duplicate` response for the same event ID and producer source. It then deletes
+that exact pending payload in a new producer-store transaction and decrements
+the pending counter. A successful delivery and acknowledgment are counted in
+the returned `delivered` and `acknowledged` values.
+
+The collector's delivery identity comes from the admitted context at the
+Audit boundary. A background drain may therefore have a `background` delivery
+actor when no visitor principal is present. The original actor remains the
+source-attested snapshot captured during enqueue; replay does not replace it
+with the actor that happens to run the drain.
+
+There is no cross-store transaction. If the process stops after Audit inserts
+the event but before the producer deletes its pending row, the next drain
+replays the event. The `(application_id, source_owner, event_id)` uniqueness
+key and canonical content hash make that replay a safe duplicate. A conflicting
+payload for the same logical ID is rejected and requires producer attention.
+
+## Operational limits
+
+The drain is deliberately short and finite. Retry remaining rows with another
+admitted root rather than turning one invocation into an unbounded worker. Audit
+capacity rejects new events while full; pending rows stay at the producer for
+retry. If an operator prunes past a pending event's `occurred_at`, that item
+may be rejected by the retention cutoff and needs explicit operational
+handling.
+
+The independently built fixture under
+[`examples/outbox-producer`](../examples/outbox-producer/README.md) demonstrates
+this pattern without becoming part of the Audit wheel.