# hovosukiasyan/project-summarizer architecture

> Architecture diagram of the GitHub repository hovosukiasyan/project-summarizer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hovosukiasyan/project-summarizer
- Repository: https://github.com/hovosukiasyan/project-summarizer

## Overview

##### Identification of Project Type and Purpose
- This is an open-source CLI tool (exporter) written in Python.
- Purpose: scan a target project folder, filter files, send code to OpenRouter AI for formatting/correction, and generate a structured Markdown export (`project_export.md`) plus logs.

##### High-Level File Structure Analysis
- Top-level files:
- `export.py` – main script containing orchestration logic
- `requirements.txt` – Python dependencies (`requests`, `python-dotenv`)
- `.gitignore` / `.env` – configuration and VCS ignores
- No subdirectories, so logical modules live inside `export.py` (or could be refactored into separate modules).

##### Key Insights from README
- Core steps:
a. Load environment configuration (`.env`)
b. Recursively collect files from `FOLDER_PATH`
c. Apply filters (ignore patterns, max size)
d. Call OpenRouter API for AI processing
e. Generate `project_export.md`
f. Log to `export_log.txt`
- Dependencies and external service: OpenRouter API.

##### Main Components
a. Configuration Loader
- Reads `.env` variables (API key, model, folder path, size limit) via `python-dotenv`.
b. File System Module
- FileCollector: recursive directory walker
- FileFilter: applies ignore rules (`.git`, `node_modules`, large files)
c. AI Processing Module
- AIClient: wraps HTTP calls to OpenRouter API via `requests`
d. Export Module
- MarkdownGenerator: formats project tree and code snippets
- FileWriter: writes `project_export.md`
e. Logging Module
- Logger: writes `export_log.txt` for errors and processing details
f. External Service
- OpenRouter API (model inference endpoint)

##### Relationships and Data Flow
- Start: `export.py` (CLI entry)
→ Configuration Loader
→ FileCollector
→ FileFilter
→ AIClient (requests to OpenRouter)
→ MarkdownGenerator
→ FileWriter
→ Logger
- Error paths from FileFilter or API errors into Logger.

##### Important Architectural Patterns
- Pipeline pattern: data flows through sequential stages (collect → filter → process → export).
- Single responsibility: each module has one clear function.
- Separation of concerns: configuration, I/O, processing, and logging are distinct.

##### Technologies and Frameworks
- Python 3.6+
- `requests` for HTTP
- `python-dotenv` for configuration
- OpenRouter API
- Markdown (`.md`) as output format

##### Final Advice
- Error flows explicitly (e.g., “on API failure → Logger”).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Input Documents
    env[".env"]:::doc
    gitignore[".gitignore"]:::doc
    readme["README.md"]:::doc
    requirements["requirements.txt"]:::doc

    %% Modules
    subgraph "CLI Tool Pipeline"
        direction TB
        Config["Configuration Loader"]:::internal
        FileCollector["FileCollector"]:::internal
        FileFilter["FileFilter"]:::internal
        AIClient["AIClient"]:::internal
        MarkdownGen["MarkdownGenerator"]:::internal
        FileWriter["FileWriter"]:::internal
        Logger["Logger"]:::internal
    end

    %% External Service
    ExternalAPI(("OpenRouter API")):::external

    %% Outputs
    OutputMD["project_export.md"]:::output
    LogFile["export_log.txt"]:::output

    %% Flow
    env -->|"load variables"| Config
    requirements -->|"defines deps"| Config
    Config -->|"collect files"| FileCollector
    FileCollector -->|"filter list"| FileFilter
    FileFilter -->|"filtered files"| AIClient
    FileFilter -->|"filter errors"| Logger
    AIClient -->|"POST code"| ExternalAPI
    ExternalAPI -->|"AI response"| AIClient
    AIClient -->|"send snippets"| MarkdownGen
    AIClient -->|"API errors"| Logger
    MarkdownGen -->|"formatted markdown"| FileWriter
    FileWriter -->|"write export"| OutputMD
    FileWriter -->|"write logs"| Logger
    Logger -->|"log output"| LogFile

    %% Click Events
    click Config "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click FileCollector "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click FileFilter "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click AIClient "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click MarkdownGen "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click FileWriter "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click Logger "https://github.com/hovosukiasyan/project-summarizer/blob/main/export.py"
    click requirements "https://github.com/hovosukiasyan/project-summarizer/blob/main/requirements.txt"
    click gitignore "https://github.com/hovosukiasyan/project-summarizer/blob/main/.gitignore"
    click readme "https://github.com/hovosukiasyan/project-summarizer/blob/main/README.md"

    %% Styles
    classDef internal fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef external fill:#90EE90,stroke:#000,stroke-width:1px,stroke-dasharray: 5 5
    classDef output fill:#FFA500,stroke:#000,stroke-width:1px
    classDef doc fill:#EFEFEF,stroke:#000,stroke-width:1px,stroke-dasharray: 2 2
```
