# oltrematica/github_analyzer architecture

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

- Interactive diagram: https://gitdiagram.com/oltrematica/github_analyzer
- Repository: https://github.com/oltrematica/github_analyzer

## Overview

DevAnalyzer is a CLI for collecting GitHub repository and Jira project data, calculating activity and quality metrics, and writing CSV reports. The principal workflow starts at the CLI, selects sources and configuration, fetches source data, analyzes it, then exports results. GitHub coverage includes commits, issues, pull requests, productivity, and quality; Jira coverage includes issue/comment extraction and quality metrics. The source index supports the main orchestration and module references; unsampled implementation details are represented only where documented or referenced.

Main entry points: [`src/github_analyzer/cli/main.py`](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/cli/main.py) (CLI Orchestrator), [`src/github_analyzer/api/models.py`](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/models.py) (GitHub Data Models), [`src/github_analyzer/api/client.py`](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/client.py) (GitHub API Client), [`src/github_analyzer/analyzers/jira_metrics.py`](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/jira_metrics.py) (Jira Quality Metrics)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli_config["CLI and Configuration"]
  node_main["CLI Orchestrator<br/>[main.py]"]
  node_terminal["Terminal Output<br/>[output.py]"]
  node_settings["Source Settings<br/>[settings.py]"]
  node_validation["Input Validation<br/>[validation.py]"]
end

subgraph group_github["GitHub Analysis"]
  node_github_api["GitHub API Client<br/>[client.py]"]
  node_commits["Commit Analysis<br/>[commits.py]"]
  node_prs["Pull Request Analysis<br/>[pull_requests.py]"]
  node_issues["GitHub Issue Analysis<br/>[issues.py]"]
  node_productivity["Productivity Scoring<br/>[productivity.py]"]
  node_quality["GitHub Quality Metrics<br/>[quality.py]"]
end

subgraph group_jira["Jira Analysis"]
  node_jira_api["Jira API Client<br/>[jira_client.py]"]
  node_jira_issues["Jira Issue Extraction<br/>[jira_issues.py]"]
  node_jira_metrics["Jira Quality Metrics<br/>[jira_metrics.py]"]
end

subgraph group_shared["Shared Data and Errors"]
  node_models["GitHub Data Models<br/>[models.py]"]
  node_errors["Error Types<br/>[exceptions.py]"]
end

subgraph group_exports["Reporting and Security"]
  node_csv_export["GitHub CSV Export<br/>[csv_exporter.py]"]
  node_jira_export["Jira CSV Export<br/>[jira_exporter.py]"]
  node_jira_metrics_export["Jira Metrics Export"]
  node_security["Output Security<br/>[security.py]"]
end

node_user(("CLI User"))
node_github_service["GitHub API"]
node_jira_service["Jira Service"]

node_user -->|"runs"| node_main
node_main -->|"displays via"| node_terminal
node_main -->|"loads settings"| node_settings
node_main -->|"validates inputs"| node_validation
node_main -->|"coordinates analysis"| node_commits
node_main -->|"coordinates analysis"| node_prs
node_main -->|"coordinates analysis"| node_issues
node_main -->|"coordinates analysis"| node_productivity
node_main -->|"coordinates analysis"| node_quality
node_main -->|"coordinates extraction"| node_jira_issues
node_main -->|"coordinates calculation"| node_jira_metrics
node_commits -->|"fetches data"| node_github_api
node_prs -->|"fetches data"| node_github_api
node_issues -->|"fetches data"| node_github_api
node_commits -->|"builds models"| node_models
node_prs -->|"builds models"| node_models
node_issues -->|"builds models"| node_models
node_productivity -->|"scores contributors"| node_models
node_quality -->|"evaluates data"| node_models
node_github_api -.->|"requests API"| node_github_service
node_jira_issues -->|"retrieves issues"| node_jira_api
node_jira_metrics -->|"retrieves Jira data"| node_jira_api
node_jira_api -.->|"requests API"| node_jira_service
node_main -->|"exports GitHub reports"| node_csv_export
node_main -->|"exports Jira data"| node_jira_export
node_main -->|"exports Jira metrics"| node_jira_metrics_export
node_jira_export -->|"uses metrics"| node_jira_metrics
node_jira_metrics_export -->|"exports results"| node_jira_metrics
node_csv_export -->|"sanitizes output"| node_security
node_jira_export -->|"sanitizes output"| node_security
node_jira_metrics_export -->|"sanitizes output"| node_security
node_main -->|"handles failures"| node_errors

click node_main "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/cli/main.py"
click node_terminal "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/cli/output.py"
click node_settings "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/config/settings.py"
click node_validation "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/config/validation.py"
click node_github_api "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/client.py"
click node_commits "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/commits.py"
click node_prs "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/pull_requests.py"
click node_issues "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/issues.py"
click node_productivity "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/productivity.py"
click node_quality "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/quality.py"
click node_jira_api "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/jira_client.py"
click node_jira_issues "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/jira_issues.py"
click node_jira_metrics "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/jira_metrics.py"
click node_models "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/models.py"
click node_errors "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/core/exceptions.py"
click node_csv_export "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/csv_exporter.py"
click node_jira_export "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/jira_exporter.py"
click node_jira_metrics_export "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/jira_metrics_exporter.py"
click node_security "https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/core/security.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_main,node_terminal,node_settings,node_validation,node_user toneBlue
class node_github_api,node_commits,node_prs,node_issues,node_productivity,node_quality toneAmber
class node_jira_api,node_jira_issues,node_jira_metrics,node_github_service toneMint
class node_models,node_errors toneRose
class node_csv_export,node_jira_export,node_jira_metrics_export,node_security,node_jira_service toneIndigo
```

## Components

### CLI and Configuration

- [CLI Orchestrator](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/cli/main.py): `src/github_analyzer/cli/main.py`
- [Terminal Output](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/cli/output.py): `src/github_analyzer/cli/output.py`
- [Source Settings](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/config/settings.py): `src/github_analyzer/config/settings.py`
- [Input Validation](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/config/validation.py): `src/github_analyzer/config/validation.py`

### GitHub Analysis

- [GitHub API Client](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/client.py): `src/github_analyzer/api/client.py`
- [Commit Analysis](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/commits.py): `src/github_analyzer/analyzers/commits.py`
- [Pull Request Analysis](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/pull_requests.py): `src/github_analyzer/analyzers/pull_requests.py`
- [GitHub Issue Analysis](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/issues.py): `src/github_analyzer/analyzers/issues.py`
- [Productivity Scoring](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/productivity.py): `src/github_analyzer/analyzers/productivity.py`
- [GitHub Quality Metrics](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/quality.py): `src/github_analyzer/analyzers/quality.py`

### Jira Analysis

- [Jira API Client](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/jira_client.py): `src/github_analyzer/api/jira_client.py`
- [Jira Issue Extraction](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/jira_issues.py): `src/github_analyzer/analyzers/jira_issues.py`
- [Jira Quality Metrics](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/analyzers/jira_metrics.py): `src/github_analyzer/analyzers/jira_metrics.py`

### Shared Data and Errors

- [GitHub Data Models](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/api/models.py): `src/github_analyzer/api/models.py`
- [Error Types](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/core/exceptions.py): `src/github_analyzer/core/exceptions.py`

### Reporting and Security

- [GitHub CSV Export](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/csv_exporter.py): `src/github_analyzer/exporters/csv_exporter.py`
- [Jira CSV Export](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/jira_exporter.py): `src/github_analyzer/exporters/jira_exporter.py`
- [Jira Metrics Export](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/exporters/jira_metrics_exporter.py): `src/github_analyzer/exporters/jira_metrics_exporter.py`
- [Output Security](https://github.com/oltrematica/github_analyzer/blob/main/src/github_analyzer/core/security.py): `src/github_analyzer/core/security.py`

### Other components

- **CLI User**
- **GitHub API**
- **Jira Service**

## Connections

- CLI User → CLI Orchestrator: runs (evidence: `README.md`)
- CLI Orchestrator → Terminal Output: displays via (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Source Settings: loads settings (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Input Validation: validates inputs (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Commit Analysis: coordinates analysis (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Pull Request Analysis: coordinates analysis (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → GitHub Issue Analysis: coordinates analysis (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Productivity Scoring: coordinates analysis (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → GitHub Quality Metrics: coordinates analysis (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Jira Issue Extraction: coordinates extraction (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Jira Quality Metrics: coordinates calculation (evidence: `src/github_analyzer/cli/main.py`)
- Commit Analysis → GitHub API Client: fetches data (evidence: `src/github_analyzer/analyzers/commits.py`)
- Pull Request Analysis → GitHub API Client: fetches data (evidence: `src/github_analyzer/analyzers/pull_requests.py`)
- GitHub Issue Analysis → GitHub API Client: fetches data (evidence: `src/github_analyzer/analyzers/issues.py`)
- Commit Analysis → GitHub Data Models: builds models (evidence: `src/github_analyzer/analyzers/commits.py`)
- Pull Request Analysis → GitHub Data Models: builds models (evidence: `src/github_analyzer/analyzers/pull_requests.py`)
- GitHub Issue Analysis → GitHub Data Models: builds models (evidence: `src/github_analyzer/analyzers/issues.py`)
- Productivity Scoring → GitHub Data Models: scores contributors (evidence: `src/github_analyzer/analyzers/productivity.py`)
- GitHub Quality Metrics → GitHub Data Models: evaluates data (evidence: `src/github_analyzer/analyzers/quality.py`)
- GitHub API Client → GitHub API: requests API
- Jira Issue Extraction → Jira API Client: retrieves issues (evidence: `src/github_analyzer/analyzers/jira_issues.py`)
- Jira Quality Metrics → Jira API Client: retrieves Jira data (evidence: `src/github_analyzer/analyzers/jira_metrics.py`)
- Jira API Client → Jira Service: requests API
- CLI Orchestrator → GitHub CSV Export: exports GitHub reports (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Jira CSV Export: exports Jira data (evidence: `src/github_analyzer/cli/main.py`)
- CLI Orchestrator → Jira Metrics Export: exports Jira metrics (evidence: `src/github_analyzer/cli/main.py`)
- Jira CSV Export → Jira Quality Metrics: uses metrics (evidence: `src/github_analyzer/exporters/jira_exporter.py`)
- Jira Metrics Export → Jira Quality Metrics: exports results (evidence: `src/github_analyzer/exporters/jira_metrics_exporter.py`)
- GitHub CSV Export → Output Security: sanitizes output (evidence: `src/github_analyzer/exporters/csv_exporter.py`)
- Jira CSV Export → Output Security: sanitizes output (evidence: `src/github_analyzer/exporters/jira_exporter.py`)
- Jira Metrics Export → Output Security: sanitizes output (evidence: `src/github_analyzer/exporters/jira_metrics_exporter.py`)
- CLI Orchestrator → Error Types: handles failures (evidence: `src/github_analyzer/cli/main.py`)
