# prooflinedev/sdk-python architecture

> Architecture diagram of the GitHub repository prooflinedev/sdk-python, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/prooflinedev/sdk-python
- Repository: https://github.com/prooflinedev/sdk-python

## Overview

proofline-sdk is a typed synchronous and asynchronous Python client for Proofline’s review API. The primary workflow is to request a review, read or poll its result, and interpret completion against review evidence; the SDK also supports exports, coverage uploads, and MCP knowledge and fix tools. The map distinguishes the public facade, generated API/model layer, transport policy, and optional MCP helpers. Some subsystem details are represented at directory level because their implementations were not sampled; edges are limited to documented or indexed relationships.

Main entry points: [`proofline/client.py`](https://github.com/prooflinedev/sdk-python/blob/main/proofline/client.py) (Client facade), [`proofline/_generated/api/default/get_pull_request_review.py`](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_pull_request_review.py) (Review reads), [`proofline/_generated/api/default/list_reviews.py`](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/list_reviews.py) (Review listing), [`proofline/_generated/api/default/get_review_routing.py`](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_review_routing.py) (Routing reads)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_public["Client interface"]
  node_facade["Client facade<br/>[client.py]"]
  node_public_exports["Public exports<br/>[__init__.py]"]
end

subgraph group_api["Review API"]
  node_review_requests["Review requests<br/>[request_review.py]"]
  node_patch_requests["Patch reviews"]
  node_commit_requests["Commit reviews"]
  node_file_requests["File reviews"]
  node_review_reads["Review reads"]
  node_review_lists["Review listing<br/>[list_reviews.py]"]
  node_routing_reads["Routing reads"]
  node_generated_models["Typed models"]
end

subgraph group_support["SDK capabilities"]
  node_outcomes["Outcome validation<br/>[outcomes.py]"]
  node_exports["Review exports<br/>[exports.py]"]
  node_coverage["Coverage uploads"]
  node_mcp["MCP tools<br/>[_mcp.py]"]
  node_knowledge["Knowledge helpers<br/>[knowledge.py]"]
  node_fixes["Fix helpers<br/>[fixes.py]"]
end

subgraph group_runtime["HTTP runtime"]
  node_api_client["HTTP client<br/>[client.py]"]
  node_transport["Transport policy<br/>[_transport.py]"]
  node_sync_http["Sync HTTP<br/>[_sync_http.py]"]
end

node_developer(("SDK caller"))
node_proofline_service["Proofline API"]

node_developer -->|"uses"| node_facade
node_public_exports -->|"exposes"| node_facade
node_facade -->|"dispatches"| node_review_requests
node_facade -->|"dispatches"| node_patch_requests
node_facade -->|"dispatches"| node_commit_requests
node_facade -->|"dispatches"| node_file_requests
node_facade -->|"dispatches"| node_review_reads
node_facade -->|"dispatches"| node_review_lists
node_facade -->|"dispatches"| node_routing_reads
node_facade -->|"interprets"| node_outcomes
node_facade -->|"exports pages"| node_exports
node_facade -->|"uploads reports"| node_coverage
node_facade -->|"offers tools"| node_knowledge
node_facade -->|"offers tools"| node_fixes
node_knowledge -->|"delegates"| node_mcp
node_fixes -->|"delegates"| node_mcp
node_review_requests -->|"requests review"| node_proofline_service
node_patch_requests -->|"requests review"| node_proofline_service
node_review_reads -->|"reads review"| node_proofline_service
node_review_lists -->|"lists reviews"| node_proofline_service
node_routing_reads -->|"reads routing"| node_proofline_service
node_coverage -->|"uploads reports"| node_proofline_service
node_review_reads -->|"parses responses"| node_generated_models
node_review_lists -->|"parses responses"| node_generated_models
node_routing_reads -->|"parses responses"| node_generated_models
node_api_client -->|"uses policy"| node_transport
node_transport -->|"uses"| node_sync_http
node_mcp -->|"uses"| node_transport

click node_facade "https://github.com/prooflinedev/sdk-python/blob/main/proofline/client.py"
click node_public_exports "https://github.com/prooflinedev/sdk-python/blob/main/proofline/__init__.py"
click node_review_requests "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_review.py"
click node_patch_requests "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_patch_review.py"
click node_commit_requests "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_commit_review.py"
click node_file_requests "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_file_review.py"
click node_review_reads "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_pull_request_review.py"
click node_review_lists "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/list_reviews.py"
click node_routing_reads "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_review_routing.py"
click node_generated_models "https://github.com/prooflinedev/sdk-python/tree/main/proofline/_generated/models"
click node_api_client "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/client.py"
click node_transport "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_transport.py"
click node_sync_http "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_sync_http.py"
click node_outcomes "https://github.com/prooflinedev/sdk-python/blob/main/proofline/outcomes.py"
click node_exports "https://github.com/prooflinedev/sdk-python/blob/main/proofline/exports.py"
click node_coverage "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/upload_coverage_reports.py"
click node_mcp "https://github.com/prooflinedev/sdk-python/blob/main/proofline/_mcp.py"
click node_knowledge "https://github.com/prooflinedev/sdk-python/blob/main/proofline/knowledge.py"
click node_fixes "https://github.com/prooflinedev/sdk-python/blob/main/proofline/fixes.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_facade,node_public_exports toneBlue
class node_review_requests,node_patch_requests,node_commit_requests,node_file_requests,node_review_reads,node_review_lists,node_routing_reads,node_generated_models toneAmber
class node_outcomes,node_exports,node_coverage,node_mcp,node_knowledge,node_fixes,node_proofline_service toneMint
class node_api_client,node_transport,node_sync_http toneRose
class node_developer toneIndigo
```

## Components

### Client interface

- [Client facade](https://github.com/prooflinedev/sdk-python/blob/main/proofline/client.py): `proofline/client.py`
- [Public exports](https://github.com/prooflinedev/sdk-python/blob/main/proofline/__init__.py): `proofline/__init__.py`

### Review API

- [Review requests](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_review.py): `proofline/_generated/api/default/request_review.py`
- [Patch reviews](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_patch_review.py): `proofline/_generated/api/default/request_patch_review.py`
- [Commit reviews](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_commit_review.py): `proofline/_generated/api/default/request_commit_review.py`
- [File reviews](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/request_file_review.py): `proofline/_generated/api/default/request_file_review.py`
- [Review reads](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_pull_request_review.py): `proofline/_generated/api/default/get_pull_request_review.py`
- [Review listing](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/list_reviews.py): `proofline/_generated/api/default/list_reviews.py`
- [Routing reads](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/get_review_routing.py): `proofline/_generated/api/default/get_review_routing.py`
- [Typed models](https://github.com/prooflinedev/sdk-python/tree/main/proofline/_generated/models): `proofline/_generated/models`

### SDK capabilities

- [Outcome validation](https://github.com/prooflinedev/sdk-python/blob/main/proofline/outcomes.py): `proofline/outcomes.py`
- [Review exports](https://github.com/prooflinedev/sdk-python/blob/main/proofline/exports.py): `proofline/exports.py`
- [Coverage uploads](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/api/default/upload_coverage_reports.py): `proofline/_generated/api/default/upload_coverage_reports.py`
- [MCP tools](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_mcp.py): `proofline/_mcp.py`
- [Knowledge helpers](https://github.com/prooflinedev/sdk-python/blob/main/proofline/knowledge.py): `proofline/knowledge.py`
- [Fix helpers](https://github.com/prooflinedev/sdk-python/blob/main/proofline/fixes.py): `proofline/fixes.py`

### HTTP runtime

- [HTTP client](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_generated/client.py): `proofline/_generated/client.py`
- [Transport policy](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_transport.py): `proofline/_transport.py`
- [Sync HTTP](https://github.com/prooflinedev/sdk-python/blob/main/proofline/_sync_http.py): `proofline/_sync_http.py`

### Other components

- **SDK caller**
- **Proofline API**

## Connections

- SDK caller → Client facade: uses (evidence: `README.md`)
- Public exports → Client facade: exposes (evidence: `proofline/__init__.py`)
- Client facade → Review requests: dispatches (evidence: `proofline/client.py`)
- Client facade → Patch reviews: dispatches (evidence: `proofline/client.py`)
- Client facade → Commit reviews: dispatches (evidence: `proofline/client.py`)
- Client facade → File reviews: dispatches (evidence: `proofline/client.py`)
- Client facade → Review reads: dispatches (evidence: `proofline/client.py`)
- Client facade → Review listing: dispatches (evidence: `proofline/client.py`)
- Client facade → Routing reads: dispatches (evidence: `proofline/client.py`)
- Client facade → Outcome validation: interprets (evidence: `README.md`)
- Client facade → Review exports: exports pages (evidence: `README.md`)
- Client facade → Coverage uploads: uploads reports (evidence: `README.md`)
- Client facade → Knowledge helpers: offers tools (evidence: `README.md`)
- Client facade → Fix helpers: offers tools (evidence: `README.md`)
- Knowledge helpers → MCP tools: delegates (evidence: `proofline/knowledge.py`)
- Fix helpers → MCP tools: delegates (evidence: `proofline/fixes.py`)
- Review requests → Proofline API: requests review (evidence: `proofline/_generated/api/default/request_review.py`)
- Patch reviews → Proofline API: requests review (evidence: `proofline/_generated/api/default/request_patch_review.py`)
- Review reads → Proofline API: reads review (evidence: `proofline/_generated/api/default/get_pull_request_review.py`)
- Review listing → Proofline API: lists reviews (evidence: `proofline/_generated/api/default/list_reviews.py`)
- Routing reads → Proofline API: reads routing (evidence: `proofline/_generated/api/default/get_review_routing.py`)
- Coverage uploads → Proofline API: uploads reports (evidence: `proofline/_generated/api/default/upload_coverage_reports.py`)
- Review reads → Typed models: parses responses (evidence: `proofline/_generated/api/default/get_pull_request_review.py`)
- Review listing → Typed models: parses responses (evidence: `proofline/_generated/api/default/list_reviews.py`)
- Routing reads → Typed models: parses responses (evidence: `proofline/_generated/api/default/get_review_routing.py`)
- HTTP client → Transport policy: uses policy (evidence: `proofline/_transport.py`)
- Transport policy → Sync HTTP: uses (evidence: `proofline/_transport.py`)
- MCP tools → Transport policy: uses (evidence: `proofline/_mcp.py`)
