# jackplowman/source_scan architecture

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

- Interactive diagram: https://gitdiagram.com/jackplowman/source_scan
- Repository: https://github.com/jackplowman/source_scan

## Overview

##### Main Components Identification

a) Core Scanner Engine
- Located in scanner/app.py
- Main processing logic
- Utility modules in scanner/utils/

b) Input/Output System
- Markdown file readers/writers
- GitHub interactions module

c) Custom Support Systems
- Logging system
- Type definitions
- Test framework

##### Component Relationships

Key relationships:
a) Input Flow:
- PROJECT_TECHNOLOGIES.md → Markdown Reader → Core Scanner
b) Processing Flow:
- Core Scanner → Technology Analysis → Report Generation
c) Output Flow:
- Report Generation → Markdown Writer → tech_report.md

##### Key Technical Aspects to Highlight

- The modular utility structure (scanner/utils/)
- The separation of concerns between reading, processing, and writing
- The test coverage architecture
- GitHub integration capabilities

**[CLI Entry Point] → [Application Core]**
- ↓
**[Markdown Processing Layer]**
- ↙           ↘
**[Reader]      [Writer]**
- ↓           ↑
**[Core Scanner Engine]**
- ↓
**[Support Systems Layer]**

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Entry
        CLI[CLI Entry Point]
        App[Application Core]
    end

    subgraph "Processing Layer"
        Scanner[Core Scanner Engine]
        GH[GitHub Integration]
    end

    subgraph "I/O Layer"
        Reader[Markdown Reader]
        Writer[Markdown Writer]
    end

    subgraph "Support Systems"
        Log[Custom Logging]
        Types[Type Definitions]
        Tests[Test Framework]
    end

    subgraph "CI/CD"
        Workflows[Workflows]
        Issues[Issue Templates]
        Docs[Documentation]
    end

    %% Main Flow
    CLI --> App
    App --> Scanner
    Scanner --> Reader
    Scanner --> Writer
    Scanner --> GH

    %% Support System Connections
    Scanner --> Log
    Scanner --> Types
    Tests -.-> Scanner
    
    %% CI/CD Connections
    Workflows -.-> Scanner
    Issues -.-> Scanner
    Docs -.-> Scanner

    %% Styling
    classDef core fill:#2374ab
    classDef io fill:#48a9a6
    classDef support fill:#a4a9ad
    classDef cicd fill:#d4b483
    
    class CLI,App,Scanner core
    class Reader,Writer,GH io
    class Log,Types,Tests support
    class Workflows,Issues,Docs cicd

    %% Click Events
    click CLI "https://github.com/JackPlowman/source_scan/blob/main/scanner/__main__.py"
    click App "https://github.com/JackPlowman/source_scan/blob/main/scanner/app.py"
    click Reader "https://github.com/JackPlowman/source_scan/blob/main/scanner/utils/read_markdown.py"
    click Writer "https://github.com/JackPlowman/source_scan/blob/main/scanner/utils/write_markdown.py"
    click GH "https://github.com/JackPlowman/source_scan/blob/main/scanner/utils/github_interactions.py"
    click Log "https://github.com/JackPlowman/source_scan/blob/main/scanner/utils/custom_logging.py"
    click Types "https://github.com/JackPlowman/source_scan/blob/main/scanner/utils/custom_types.py"
    click Tests "https://github.com/JackPlowman/source_scan/tree/main/scanner/tests/"
    click Workflows "https://github.com/JackPlowman/source_scan/tree/main/.github/workflows/"
    click Issues "https://github.com/JackPlowman/source_scan/tree/main/.github/ISSUE_TEMPLATE/"
    click Docs "https://github.com/JackPlowman/source_scan/tree/main/docs/"
```
