How ashu-tosh-kumar/todo_notifier works
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