pawc-kit 0.5.0__tar.gz

pawc_kit-0.5.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 the 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 the 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 any 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
+
+   Copyright 2025 pawc-kit contributors
+
+   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.

pawc_kit-0.5.0/PKG-INFO

@@ -0,0 +1,430 @@
+Metadata-Version: 2.4
+Name: pawc-kit
+Version: 0.5.0
+Summary: PAWC Core: shared SDK for workflow models, state, layout, and orchestration
+Author-email: agsuy <37564412+agsuy@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/agsuy/pawc-kit
+Project-URL: Issues, https://github.com/agsuy/pawc-kit/issues
+Keywords: workflow,orchestration,llm,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: semver<4,>=3.0
+Requires-Dist: toon-formatter>=1.0
+Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.28.0; extra == "otel"
+Requires-Dist: opentelemetry-sdk>=1.28.0; extra == "otel"
+Provides-Extra: semantic
+Requires-Dist: semantic-text-splitter>=0.18; extra == "semantic"
+Dynamic: license-file
+
+# pawc-kit
+
+`pawc-kit` is a Python library for **multi-phase execution and review workflows**: execution graphs from native `config.yaml`, **discovery** graphs from `DiscoveryConfig`, filesystem-backed default adapters, and a stable **LLM** integration layer (backends, structured output, prompt assembly, LLM roles). Sync and **async** engines and sessions are both first-class.
+
+The supported public surface is:
+
+- `pawc_kit` (slim: version, `utc_now`, config loaders, `WorkflowSession`, `AsyncWorkflowSession`)
+- `pawc_kit.config`
+- `pawc_kit.contracts`
+- `pawc_kit.workflow`
+- `pawc_kit.ports`
+- `pawc_kit.adapters` (built-in adapters; submodules like `adapters.fs` remain valid)
+- `pawc_kit.context`
+- `pawc_kit.llm`
+
+Example YAML by schema (`RootConfig`, `DiscoveryConfig`, `RoleConfig`) lives under [`templates/`](templates/) — see [`templates/README.md`](templates/README.md). Field-by-field native `config.yaml` reference: [`docs/workflow-config-reference.md`](docs/workflow-config-reference.md). **How the library is layered** (contracts → ports → workflow → adapters): [`docs/architecture.md`](docs/architecture.md). For the HTTP control plane and server-side deployment, see the **pawc-server** repository (`docs/architecture.md`, `templates/README.md`).
+
+## Install
+
+Using `uv`:
+
+```bash
+uv sync --dev
+```
+
+Core dependencies include [**semver**](https://pypi.org/project/semver/) for SemVer 2.0 validation of skill/role and session version fields.
+
+Optional extras:
+
+- **OpenTelemetry** — metrics and tracing: `uv sync --dev --extra otel` or `pip install -e .[otel]`
+- **Semantic compression** — [semantic-text-splitter](https://github.com/benbrandt/text-splitter) for chunk-based prompt compression: `uv sync --dev --extra semantic` or `pip install -e .[semantic]`
+
+Requires Python 3.12+.
+
+## Releases
+
+The repo includes [python-semantic-release](https://python-semantic-release.readthedocs.io/)
+configuration for SemVer bumps, [`CHANGELOG.md`](CHANGELOG.md), and `v*`
+release tags based on conventional commits (see
+[`CONTRIBUTING.md`](CONTRIBUTING.md)).
+
+## Quick Start (config-driven)
+
+The recommended way to run a workflow is via `WorkflowSession`, which reads
+`config.yaml` and builds the workflow graph, engine policy, and directory
+layout from it. Only role bindings and optional runtime objects (observer,
+clock) are supplied in code.
+
+**config.yaml**
+
+```yaml
+skill:
+  name: my-skill
+  version: "1.0.0"
+state_directory: sessions
+
+workflow:
+  phases:
+    - phase_id: work
+      role_id: worker
+      kind: executor
+      on_complete: [review]
+    - phase_id: review
+      role_id: reviewer
+      kind: review
+      can_request_changes_from: [work]
+  confidence_threshold: 85
+  max_iterations: 10
+  max_feedback_rounds: 3
+  run_directory: sessions/execution
+  state_filename: state.json
+
+observability:
+  observer: otel           # "otel" | "logging" | "none" (default: none)
+  meter_name: pawc_kit.workflow   # for otel; ignored when observer != "otel"
+  tracer_name: pawc_kit.workflow   # for otel; ignored when observer != "otel"
+  logger_name: pawc_kit.workflow  # for logging; ignored when observer != "logging"
+```
+
+**Python**
+
+```python
+from pawc_kit import WorkflowSession
+
+session = WorkflowSession.from_config("config.yaml")
+session.register_role("worker", my_worker)
+session.register_role("reviewer", my_reviewer)
+
+state = session.run(session_id="run-001")
+print(state.status)
+```
+
+Any `workflow.*` value can be overridden in code when needed:
+
+```python
+session = WorkflowSession.from_config(
+    "config.yaml",
+    confidence_threshold=90,   # override config value
+    run_directory="sessions/custom",
+)
+```
+
+`WorkflowSession.run()` is resumable — calling it again with the same
+`session_id` picks up where it left off.
+
+Async equivalent (`from_config` is synchronous; `run` is async):
+
+```python
+from pawc_kit import AsyncWorkflowSession
+
+session = AsyncWorkflowSession.from_config("config.yaml")
+session.register_role("worker", my_async_worker)
+session.register_role("reviewer", my_async_reviewer)
+state = await session.run(session_id="run-001")
+```
+
+### Low-level engine usage
+
+For full control over stores and paths, use `WorkflowEngine` directly:
+
+```python
+from pathlib import Path
+from pawc_kit.adapters.fs import FsArtifactStore, FsStateStore
+from pawc_kit.workflow import WorkflowEngine
+
+run_dir = Path(".tmp") / "demo-run"
+engine = WorkflowEngine(graph, FsStateStore(run_dir), FsArtifactStore(run_dir))
+engine.register_role("worker", my_worker)
+engine.register_role("reviewer", my_reviewer)
+
+state = engine.run(
+    session_id="session-1",
+    skill_name="demo-skill",
+    skill_version="0.1.0",
+)
+```
+
+`WorkflowEngine` keeps the active session state in memory and only persists at commit points:
+
+- run start
+- phase transition
+- iteration commit
+- review commit
+- finalize
+
+You can pass a `ContextPack` into `session.run(context_pack=pack)` or `engine.run(context_pack=pack)`. The engine scopes it per phase via `PhaseDefinition.context_sources` and injects it into `ExecutionContext.context` and `ReviewContext.context` for roles.
+
+## Stable API
+
+### Config Infrastructure
+
+- `load_yaml_config`, `load_root_config`, `load_role_config`
+- `RootConfig`, `SkillConfig`, `ContextConfig`, `EfficiencyConfig`, `RoleConfig`
+- `ContextInjectionConfig`, `CompressionConfig`, `ChunkPolicyConfig`
+- `WorkflowSession`, `AsyncWorkflowSession`
+- `LayoutManager`
+- `ContextPack`, `load_context_pack`, `accessible_packs`
+- `check_quality_gates`, `validate_composition`
+
+### Contracts
+
+- `SessionState`, `IterationEntry`, `ReviewEntry`, `ArtifactRef`
+- `DecisionPayload`, `HandoffContext`, handoff artifact types (`HandoffArtifact`, …)
+- **Discovery:** `DiscoveryConfig`, `DiscoveryPhaseConfig`, `QuestionEntry`, …
+- **Events:** `RunStarted`, `RunCompleted`, `PhaseStarted`, `IterationCommitted`, `ReviewCommitted`, … plus `event_to_dict` / `event_from_dict` helpers
+- **Errors:** `PawcError`, `LLMError`, `ConcurrencyError`, …
+
+### Workflow
+
+- `PhaseDefinition`, `PhaseGraph` (including discovery-shaped graphs when built from `DiscoveryConfig`)
+- `ExecutionContext`, `ReviewContext`
+- `ExecutionResult`, `ReviewDecision`, `ReviewResult`
+- `WorkflowEngine`, `AsyncWorkflowEngine`
+- `Executor`, `Reviewer`, `AsyncExecutor`, `AsyncReviewer`
+
+### Ports
+
+- `StateStore`, `AsyncStateStore`
+- `ArtifactStore`, `AsyncArtifactStore`
+- `WorkflowObserver`, `AsyncWorkflowObserver`
+- `Clock`, `AsyncClock`
+- `ContextCompressor` — pluggable text compression for prompt injection
+
+### Filesystem Adapters
+
+- `FsStateStore`, `AsyncFsStateStore`
+- `FsArtifactStore`, `AsyncFsArtifactStore`
+
+## Generic Config Loading
+
+The `config/` subpackage provides a generic YAML loader so that no consumer
+needs to implement its own config processing:
+
+```python
+from pydantic import BaseModel
+from pawc_kit import load_yaml_config
+
+class RunnerConfig(BaseModel):
+    max_retries: int = 3
+
+# Flat config
+cfg = load_yaml_config("my-config.yaml", RunnerConfig)
+
+# Keyed config (e.g. runner-config.yaml with top-level "runner:" key)
+cfg = load_yaml_config("runner-config.yaml", RunnerConfig, root_key="runner")
+```
+
+Convenience wrappers for PAWC-defined config types:
+
+```python
+from pawc_kit import load_root_config, load_role_config
+
+root = load_root_config("config.yaml")           # -> RootConfig
+role = load_role_config("worker/config.yaml")     # -> RoleConfig
+```
+
+## LLM Integrations
+
+LLM helpers are available under the stable namespace:
+
+```python
+from pawc_kit.llm import (
+    MockBackend,
+    LLMExecutorRole,
+    LLMReviewerRole,
+    StructuredOutput,
+    AsyncStructuredOutput,
+)
+```
+
+Backends implement `LLMBackend` / `AsyncLLMBackend` (`complete(..., max_tokens: int | None = None)`). `StructuredOutput` / `AsyncStructuredOutput` call the backend, parse JSON into Pydantic models (trying multiple fenced blocks / extractions), and retry on validation failure; async structured output supports optional exponential backoff between retries (`retry_delay` on `AsyncStructuredOutput`).
+
+### Context injection and compression
+
+Context pack data (request files, discovery handoff, child packs) is injected into executor and reviewer prompts according to `RootConfig.context_injection` (`ContextInjectionConfig`). You control:
+
+- **What to include** — `include_request_files`, `include_discovery`, `include_children`
+- **Filtering** — `file_allowlist`, `file_blocklist`, `max_file_chars`, `discovery_sections`
+- **Compression** — `compression.mode`: `"simple"` (default regex-based `MarkdownCompressor`), `"semantic"` (chunk → classify → policy → reassemble, requires `pawc-kit[semantic]`), or `"none"` (`PassthroughCompressor`)
+
+With `mode: "semantic"`, per-chunk-type policies are configurable in YAML (`compression.policies`): `heading`, `paragraph`, `list`, `code`, `table`, `diagram`, each with `action` (`keep` / `truncate` / `collapse` / `strip`) and optional limits (`max_sentences`, `max_items`, `max_lines`, `max_rows`). The semantic pipeline uses [semantic-text-splitter](https://github.com/benbrandt/text-splitter) as the boundary oracle, then a heuristic classifier and your policies.
+
+Implementations: `MarkdownCompressor`, `PassthroughCompressor`, `SemanticCompressor`; all implement the `ContextCompressor` protocol. The prompt builder resolves the compressor from config when building request and discovery sections; an explicit `compressor` argument overrides.
+
+## Observability
+
+`pawc_kit` emits immutable workflow events through the `WorkflowObserver` port. Built-in adapters are available for standard-library logging and OpenTelemetry.
+
+### Config-driven observer selection
+
+Set `observability.observer` in `config.yaml` to auto-construct an observer without writing any wiring code. The session resolves the observer with the following precedence:
+
+1. Explicit `observer=SomeObserver()` kwarg wins.
+2. Explicit `observer=None` suppresses the observer (even if config says `otel`).
+3. Omitted kwarg -- auto-constructed from `config.observability` (default: `"none"`).
+
+```yaml
+observability:
+  observer: otel     # "otel" | "logging" | "none"
+```
+
+The `otel` value requires `pawc-kit[otel]`. An explicit `observer=` kwarg on `WorkflowSession` / `AsyncWorkflowSession` always takes precedence.
+
+### Logging adapter
+
+```python
+import logging
+
+from pawc_kit.adapters import LoggingWorkflowObserver
+
+logging.basicConfig(level=logging.INFO)
+logging.getLogger("pawc_kit.workflow").setLevel(logging.DEBUG)
+
+observer = LoggingWorkflowObserver()
+```
+
+Level selection follows normal Python library conventions:
+
+- configure `pawc_kit.workflow` to request lifecycle logs at `DEBUG`, `INFO`, `WARNING`, or `ERROR`
+- configure `pawc_kit.llm` to include structured-output retry and failure logs
+- the library installs a `NullHandler` on `pawc_kit` and never calls `basicConfig()`
+
+Default logging adapter level mapping:
+
+- `INFO`: `RunStarted`, `RunResumed`, successful `RunCompleted`
+- `DEBUG`: `PhaseStarted`, `PhaseTransitioned`, `IterationCommitted`, approved `ReviewCommitted`
+- `WARNING`: `ReviewCommitted` with `REQUEST_CHANGES`, abandoned `RunCompleted`
+- `ERROR`: `RunFailed`
+
+### OpenTelemetry adapter
+
+Requires `pawc-kit[otel]`. Handles all 8 workflow event types with **metrics** (counters and histograms) and **traces** (nested spans).
+
+```python
+from pawc_kit.adapters import OpenTelemetryWorkflowObserver
+
+observer = OpenTelemetryWorkflowObserver(
+    meter_name="pawc_kit.workflow",
+    tracer_name="pawc_kit.workflow",
+)
+```
+
+Span hierarchy (parent → child): **run** → **phase** → **iteration** / **review**.
+
+| Span name | Created on | Ended on | Typical attributes |
+|---|---|---|---|
+| `pawc.workflow.run` | `RunStarted`, `RunResumed` | `RunCompleted`, `RunFailed` | `session_id`, `phase_id`, `resumed`, `skill_name` (when `RunStarted`); on completion: `run.status`, `run.feedback_loops` or `error.type` / `error.message` |
+| `pawc.workflow.phase` | `PhaseStarted` | `PhaseTransitioned`, run end | `session_id`, `phase_id`, `role_id`, `phase_kind` |
+| `pawc.workflow.iteration` | `IterationCommitted` | same event (duration from event timestamps) | `session_id`, `phase_id`, `iteration`, `confidence_score` |
+| `pawc.workflow.review` | `ReviewCommitted` | same event (duration from event timestamps) | `session_id`, `phase_id`, `review`, `decision`, `confidence_score` |
+
+Metrics emitted:
+
+| Instrument | Type | Attributes | Event |
+|---|---|---|---|
+| `pawc.workflow.runs` | counter | `phase_id`, `outcome` | `RunStarted`, `RunCompleted` |
+| `pawc.workflow.run_failures` | counter | `phase_id` | `RunFailed` |
+| `pawc.workflow.iterations` | counter | `phase_id`, `outcome` | `IterationCommitted` |
+| `pawc.workflow.reviews` | counter | `phase_id`, `outcome` | `ReviewCommitted` |
+| `pawc.workflow.phases` | counter | `phase_id`, `phase_kind` | `PhaseStarted` |
+| `pawc.workflow.transitions` | counter | `from_phase`, `to_phase` | `PhaseTransitioned` |
+| `pawc.workflow.resumes` | counter | `phase_id`, `phase_kind` | `RunResumed` |
+| `pawc.workflow.run.duration.seconds` | histogram | `outcome` | `RunCompleted` |
+| `pawc.workflow.iteration.duration.seconds` | histogram | `phase_id` | `IterationCommitted` |
+| `pawc.workflow.review.duration.seconds` | histogram | `phase_id` | `ReviewCommitted` |
+
+Design notes:
+
+- **Metrics:** low-cardinality attributes only; `session_id` is never included in metric labels.
+- **Traces:** `session_id` is included on spans (expected for request-scoped traces and distinct from the metrics policy).
+- **Threading:** the observer assumes single-threaded event delivery per session (same model as the default filesystem stores); span state is not locked.
+- **Defensive behavior:** if events arrive without a parent span (e.g. `PhaseStarted` before `RunStarted`), child spans are still recorded as roots; duplicate `RunStarted` for the same session ends the previous run span before opening a new one.
+- `AsyncOpenTelemetryWorkflowObserver` delegates to the sync observer (OTEL SDK calls are CPU-bound)
+
+## Architecture
+
+**Narrative and diagrams:** [`docs/architecture.md`](docs/architecture.md) (execution vs discovery config, async vs sync, related docs).
+
+The public architecture is split into layers:
+
+```mermaid
+flowchart TD
+    contracts["contracts<br/>models, events, errors"]
+    ports["ports<br/>abstract interfaces"]
+    workflow["workflow<br/>graph, roles, engine"]
+    adapters["adapters<br/>filesystem, logging, OpenTelemetry"]
+    config["config<br/>YAML loading and validation"]
+    llm["llm<br/>backends, prompts, roles, structured output, compressors"]
+    session["session.py / async_session.py<br/>config-driven orchestration"]
+    context["context.py<br/>context pack loading and scoping"]
+    layout["layout.py<br/>run directory management"]
+    validators["validators.py<br/>composition and quality gates"]
+
+    contracts --> ports
+    contracts --> workflow
+    contracts --> adapters
+    contracts --> config
+    contracts --> llm
+    ports --> workflow
+    ports --> adapters
+    workflow --> llm
+    config --> session
+    config --> context
+    config --> llm
+    workflow --> session
+    workflow --> llm
+    adapters --> session
+    context --> workflow
+    validators --> context
+    validators --> llm
+    layout --> session
+```
+
+Execution wiring follows the same direction: config/session code builds the graph and
+adapters, then hands execution to the workflow engine and role implementations.
+
+1. `contracts` — pure data models and error types
+2. `ports` — abstract interfaces (state, artifacts, observers, clock)
+3. `workflow` — engine, phase graph, role protocols
+4. `adapters` — filesystem and observability implementations
+5. `config` — YAML config loading and validation infrastructure
+6. `llm` — LLM backend integration (roles, structured output, prompts, context injection, compressors: `MarkdownCompressor`, `SemanticCompressor`, `PassthroughCompressor`)
+
+Top-level modules bridge config with the engine:
+
+- `session.py` — `WorkflowSession` orchestrator (config -> layout -> stores -> engine)
+- `context.py` — context pack loading, resolution, scoping
+- `layout.py` — run directory structure management
+- `validators.py` — composition and quality-gate validation
+
+## Development
+
+Primary local workflow:
+
+```bash
+./scripts/verify.sh   # lint (fix), test, lint-check, type-check, test
+```
+
+Or run individual steps: `./scripts/lint.sh`, `./scripts/test.sh`, `./scripts/lint-check.sh`, `./scripts/type-check.sh`. Use `./scripts/commit.sh "type(scope): subject"` for commit message validation.
+
+## License
+
+Apache-2.0