# qarium/goga-tool-pybuggy architecture

> Architecture diagram of the GitHub repository qarium/goga-tool-pybuggy, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/qarium/goga-tool-pybuggy
- Repository: https://github.com/qarium/goga-tool-pybuggy

## Overview

pybuggy is a goga API-testing tool with two user-facing paths: a CLI for configuring and managing OpenAPI/Swagger specs and generated artifacts, and a pytest plugin that provides an API fixture and loads generated fixtures. Its documented API-test lifecycle produces accepted test suites, while the runtime library supplies HTTP and assertion capabilities. Some command and API internals were not excerpted, so uncertain connections are omitted or marked unverified.

Main entry points: [`goga_tool_pybuggy/cli.py`](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/cli.py) (CLI), [`goga_tool_pybuggy/commands/diff/diff.py`](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/diff.py) (Contract diff), [`goga_tool_pybuggy/config/storage.py`](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/config/storage.py) (Config loader), [`goga_tool_pybuggy/commands/generate/generate.py`](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/generate/generate.py) (Fixture generation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_cli["CLI<br/>[cli.py]"]
  node_pytest(("Pytest"))
end

subgraph group_management["Spec management"]
  node_config["Config loader<br/>[storage.py]"]
  node_init["Project init<br/>[init.py]"]
  node_pull["Spec pull<br/>[pull.py]"]
  node_list["Endpoint list<br/>[list.py]"]
  node_info["Spec info<br/>[info.py]"]
  node_generate["Fixture generation<br/>[generate.py]"]
  node_diff["Contract diff<br/>[diff.py]"]
  node_diff_contract["Spec contract<br/>[contract.py]"]
  node_diff_artifacts["Artifact scan<br/>[artifacts.py]"]
end

subgraph group_specs["Spec processing"]
  node_spec_loader["Spec loader<br/>[loader.py]"]
  node_extract["Endpoint extraction<br/>[extract.py]"]
  node_endpoint["Endpoint model<br/>[endpoint.py]"]
  node_endpoint_id["Endpoint IDs<br/>[endpoint_id.py]"]
end

subgraph group_plugin["Pytest integration"]
  node_plugin["Pytest plugin<br/>[plugin.py]"]
  node_loaders["Fixture loaders<br/>[loaders.py]"]
end

subgraph group_runtime["API and assertions"]
  node_api["HTTP API client<br/>[api.py]"]
  node_api_endpoint["API endpoint calls<br/>[endpoint.py]"]
  node_auth["Auth chaining<br/>[auth.py]"]
  node_assertions["API assertions<br/>[contexts.py]"]
  node_matchcrest["Matcher framework<br/>[base.py]"]
  node_response_matchers["Response matchers<br/>[response.py]"]
  node_value_matchers["Value matchers<br/>[value.py]"]
end

node_engineer(("Project engineer"))
node_artifact_tree["Generated artifacts"]

node_engineer -->|"runs commands"| node_cli
node_engineer -->|"runs tests"| node_pytest
node_cli -->|"dispatches"| node_init
node_cli -->|"dispatches"| node_pull
node_cli -->|"dispatches"| node_list
node_cli -->|"dispatches"| node_info
node_cli -->|"dispatches"| node_generate
node_cli -->|"dispatches"| node_diff
node_init -->|"configures"| node_config
node_init -->|"installs plugin"| node_plugin
node_pull -->|"loads settings"| node_config
node_list -->|"loads settings"| node_config
node_list -->|"reads specs"| node_spec_loader
node_info -.->|"loads settings"| node_config
node_generate -->|"loads settings"| node_config
node_generate -->|"reads specs"| node_spec_loader
node_generate -.->|"produces fixtures"| node_artifact_tree
node_diff -->|"loads settings"| node_config
node_diff -->|"extracts spec"| node_spec_loader
node_diff -->|"builds comparison"| node_diff_contract
node_diff -->|"scans artifacts"| node_diff_artifacts
node_diff -->|"reads artifacts"| node_artifact_tree
node_spec_loader -.->|"parses spec"| node_extract
node_extract -->|"creates endpoints"| node_endpoint
node_endpoint -->|"builds identifier"| node_endpoint_id
node_pytest -->|"loads plugin"| node_plugin
node_plugin -->|"loads fixtures"| node_loaders
node_plugin -->|"provides fixture"| node_api
node_api_endpoint -->|"combines auth"| node_auth
node_assertions -->|"uses matchers"| node_matchcrest
node_response_matchers -->|"extends base"| node_matchcrest
node_value_matchers -->|"extends base"| node_matchcrest

click node_cli "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/cli.py"
click node_config "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/config/storage.py"
click node_init "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/init/init.py"
click node_pull "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/pull/pull.py"
click node_list "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/list/list.py"
click node_info "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/info/info.py"
click node_generate "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/generate/generate.py"
click node_diff "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/diff.py"
click node_diff_contract "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/contract.py"
click node_diff_artifacts "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/artifacts.py"
click node_spec_loader "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/loader.py"
click node_extract "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/extract.py"
click node_endpoint "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/endpoint.py"
click node_endpoint_id "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/endpoint_id.py"
click node_plugin "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/plugin/plugin.py"
click node_loaders "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/plugin/loaders/loaders.py"
click node_api "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/api.py"
click node_api_endpoint "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/endpoint.py"
click node_auth "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/auth.py"
click node_assertions "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/asserts/contexts.py"
click node_matchcrest "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/base.py"
click node_response_matchers "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/response.py"
click node_value_matchers "https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/value.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_cli,node_pytest toneBlue
class node_config,node_init,node_pull,node_list,node_info,node_generate,node_diff,node_diff_contract,node_diff_artifacts toneAmber
class node_spec_loader,node_extract,node_endpoint,node_endpoint_id toneMint
class node_plugin,node_loaders toneRose
class node_api,node_api_endpoint,node_auth,node_assertions,node_matchcrest,node_response_matchers,node_value_matchers,node_engineer,node_artifact_tree toneIndigo
```

## Components

### User entry points

- [CLI](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/cli.py): `goga_tool_pybuggy/cli.py`
- **Pytest**

### Spec management

- [Config loader](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/config/storage.py): `goga_tool_pybuggy/config/storage.py`
- [Project init](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/init/init.py): `goga_tool_pybuggy/commands/init/init.py`
- [Spec pull](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/pull/pull.py): `goga_tool_pybuggy/commands/pull/pull.py`
- [Endpoint list](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/list/list.py): `goga_tool_pybuggy/commands/list/list.py`
- [Spec info](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/info/info.py): `goga_tool_pybuggy/commands/info/info.py`
- [Fixture generation](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/generate/generate.py): `goga_tool_pybuggy/commands/generate/generate.py`
- [Contract diff](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/diff.py): `goga_tool_pybuggy/commands/diff/diff.py`
- [Spec contract](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/contract.py): `goga_tool_pybuggy/commands/diff/contract.py`
- [Artifact scan](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/commands/diff/artifacts.py): `goga_tool_pybuggy/commands/diff/artifacts.py`

### Spec processing

- [Spec loader](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/loader.py): `goga_tool_pybuggy/spec/loader.py`
- [Endpoint extraction](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/extract.py): `goga_tool_pybuggy/spec/extract.py`
- [Endpoint model](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/endpoint.py): `goga_tool_pybuggy/spec/endpoint.py`
- [Endpoint IDs](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/spec/endpoint_id.py): `goga_tool_pybuggy/spec/endpoint_id.py`

### Pytest integration

- [Pytest plugin](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/plugin/plugin.py): `goga_tool_pybuggy/plugin/plugin.py`
- [Fixture loaders](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/plugin/loaders/loaders.py): `goga_tool_pybuggy/plugin/loaders/loaders.py`

### API and assertions

- [HTTP API client](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/api.py): `goga_tool_pybuggy/api/api.py`
- [API endpoint calls](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/endpoint.py): `goga_tool_pybuggy/api/endpoint.py`
- [Auth chaining](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/auth.py): `goga_tool_pybuggy/api/auth.py`
- [API assertions](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/api/asserts/contexts.py): `goga_tool_pybuggy/api/asserts/contexts.py`
- [Matcher framework](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/base.py): `goga_tool_pybuggy/matchcrest/matchers/base.py`
- [Response matchers](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/response.py): `goga_tool_pybuggy/matchcrest/matchers/response.py`
- [Value matchers](https://github.com/qarium/goga-tool-pybuggy/blob/2.0.x/goga_tool_pybuggy/matchcrest/matchers/value.py): `goga_tool_pybuggy/matchcrest/matchers/value.py`

### Other components

- **Project engineer**
- **Generated artifacts**

## Connections

- Project engineer → CLI: runs commands (evidence: `goga_tool_pybuggy/cli.py`)
- Project engineer → Pytest: runs tests
- CLI → Project init: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- CLI → Spec pull: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- CLI → Endpoint list: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- CLI → Spec info: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- CLI → Fixture generation: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- CLI → Contract diff: dispatches (evidence: `goga_tool_pybuggy/cli.py`)
- Project init → Config loader: configures (evidence: `goga_tool_pybuggy/commands/init/init.py`)
- Project init → Pytest plugin: installs plugin (evidence: `goga_tool_pybuggy/commands/init/init.py`)
- Spec pull → Config loader: loads settings (evidence: `goga_tool_pybuggy/commands/pull/pull.py`)
- Endpoint list → Config loader: loads settings (evidence: `goga_tool_pybuggy/commands/list/list.py`)
- Endpoint list → Spec loader: reads specs (evidence: `goga_tool_pybuggy/commands/list/list.py`)
- Spec info → Config loader: loads settings
- Fixture generation → Config loader: loads settings (evidence: `goga_tool_pybuggy/commands/generate/generate.py`)
- Fixture generation → Spec loader: reads specs (evidence: `goga_tool_pybuggy/commands/generate/generate.py`)
- Fixture generation → Generated artifacts: produces fixtures
- Contract diff → Config loader: loads settings (evidence: `goga_tool_pybuggy/commands/diff/diff.py`)
- Contract diff → Spec loader: extracts spec (evidence: `goga_tool_pybuggy/commands/diff/diff.py`)
- Contract diff → Spec contract: builds comparison (evidence: `goga_tool_pybuggy/commands/diff/diff.py`)
- Contract diff → Artifact scan: scans artifacts (evidence: `goga_tool_pybuggy/commands/diff/diff.py`)
- Contract diff → Generated artifacts: reads artifacts (evidence: `goga_tool_pybuggy/commands/diff/diff.py`)
- Spec loader → Endpoint extraction: parses spec
- Endpoint extraction → Endpoint model: creates endpoints (evidence: `goga_tool_pybuggy/spec/extract.py`)
- Endpoint model → Endpoint IDs: builds identifier (evidence: `goga_tool_pybuggy/spec/endpoint.py`)
- Pytest → Pytest plugin: loads plugin (evidence: `goga_tool_pybuggy/plugin/plugin.py`)
- Pytest plugin → Fixture loaders: loads fixtures (evidence: `goga_tool_pybuggy/plugin/plugin.py`)
- Pytest plugin → HTTP API client: provides fixture (evidence: `goga_tool_pybuggy/plugin/plugin.py`)
- API endpoint calls → Auth chaining: combines auth (evidence: `goga_tool_pybuggy/api/auth.py`)
- API assertions → Matcher framework: uses matchers (evidence: `goga_tool_pybuggy/api/asserts/contexts.py`)
- Response matchers → Matcher framework: extends base (evidence: `goga_tool_pybuggy/matchcrest/matchers/response.py`)
- Value matchers → Matcher framework: extends base (evidence: `goga_tool_pybuggy/matchcrest/matchers/value.py`)
