# ashu-tosh-kumar/todo_notifier architecture

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

- Interactive diagram: https://gitdiagram.com/ashu-tosh-kumar/todo_notifier
- Repository: https://github.com/ashu-tosh-kumar/todo_notifier

## Overview

##### Main Components

a) Core Components:
- Scanner Module (todonotifier/driver.py)
- Configuration System (todonotifier/config.py)
- Connection Handler (todonotifier/connect.py)
- Summary Generators (todonotifier/summary_generators.py)
- Notification System (todonotifier/notifier.py)
- Models (todonotifier/models.py)

b) External Components:
- Git Repository/Local Directory (Input Source)
- SMTP Server (for email notifications)
- File System (for HTML report storage)

##### Component Relationships and Data Flow

**Input Layer → Processing Layer → Output Layer**

##### Specific Design Elements

a) Input Layer:
- Git Clone
- Local Directory
- Single File

b) Processing Layer (Core):
- It to the Configuration System
- Models component for TODO item representation
- Utils for helper functions

c) Output Layer:
- Summary Generators (show multiple instances)
- Notification System
- HTML Report Storage

##### Specific Implementation Details

**[Input Sources] → [Connect Handler]**
- ↓
**[Configuration] → [Scanner Module] ← [Models]**
- ↓
- [Summary Generators]
- ↙     ↘
- [Email Notifier]  [HTML Reports]

##### Important Notes

- Configuration's influence on all components
- Extensibility points:
- Custom Summary Generators
- Custom Notifiers
- Custom Configuration
- Annotations for key features like:
- Case-sensitive/insensitive TODO matching
- Directory/file exclusion patterns
- Summary generation types

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef core fill:#2374f7,color:white
    classDef input fill:#4CAF50,color:white
    classDef output fill:#8BC34A,color:white
    classDef config fill:#FFC107,color:black
    classDef external fill:#9E9E9E,color:white
    classDef storage fill:#795548,color:white

    %% Input Layer
    subgraph Input
        GitRepo["Git Repository"]:::external
        LocalDir["Local Directory"]:::external
        SingleFile["Single File"]:::external
        ConnHandler["Connection Handler"]:::input
    end

    %% Core Processing Layer
    subgraph Core
        Config["Configuration System"]:::config
        Scanner["Scanner Module"]:::core
        Models["Models"]:::core
        Utils["Utility Functions"]:::core
        Constants["System Constants"]:::core
        Orchestrator["Main Orchestrator"]:::core
        EntryPoint["User Entry Point"]:::core
    end

    %% Output Layer
    subgraph Output
        SummaryGen["Summary Generators"]:::output
        Notifier["Notification System"]:::output
        HTMLStorage["HTML Reports Storage"]:::storage
        SMTP["SMTP Server"]:::external
    end

    %% Relationships
    GitRepo --> ConnHandler
    LocalDir --> ConnHandler
    SingleFile --> ConnHandler
    ConnHandler --> Scanner
    Config --> Scanner
    Config --> SummaryGen
    Config --> Notifier
    Scanner --> Models
    Scanner --> Utils
    Scanner --> Constants
    Models --> SummaryGen
    SummaryGen --> HTMLStorage
    SummaryGen --> Notifier
    Notifier --> SMTP
    Orchestrator --> Scanner
    Orchestrator --> SummaryGen
    Orchestrator --> Notifier
    EntryPoint --> Orchestrator

    %% Click Events
    click Scanner "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/driver.py"
    click Config "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/config.py"
    click ConnHandler "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/connect.py"
    click SummaryGen "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/summary_generators.py"
    click Notifier "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/notifier.py"
    click Models "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/models.py"
    click HTMLStorage "https://github.com/ashu-tosh-kumar/todo_notifier/tree/development/.report/"
    click Utils "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/utils.py"
    click Constants "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/constants.py"
    click Orchestrator "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/todonotifier/todo_notifier.py"
    click EntryPoint "https://github.com/ashu-tosh-kumar/todo_notifier/blob/development/user_driver.py"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Input Components"]:::input
        L3["Output Components"]:::output
        L4["Configuration"]:::config
        L5["External Services"]:::external
        L6["Storage"]:::storage
    end
```
