How aaguiar10/gflows works
Main Components
a) Data Layer:
• External Data Source (CBOE API/Yahoo Finance)
• Data Storage System (JSON and CSV files in data/ directory)
• Both data formats supported (JSON and CSV directories)
b) Application Core:
• Background Scheduler System
• Data Processing Modules
• Web Server (Dash/Flask)
c) Frontend Layer:
• Dash UI Components
• CSS Styling
• JavaScript Theme Handler
Data Flow
• External API → Data Downloader (ticker_dwn.py) → Storage (data/)
• Storage → Data Processing (calc.py, stats.py) → UI Layout (layout.py)
Control Flow
• Background Scheduler → Data Downloader
• User Interactions → Layout Module → Calculation Module
Specific Implementation Details
• Blue Rectangles: Core Application Components
• Yellow Diamonds: External Services
• Orange Rectangles: Processing Modules
• Purple Rectangles: UI Components
Key Elements to Highlight
a) Scheduler System:
• 15-minute update cycle (9:00 AM - 4:30 PM ET)
• Retry mechanism (5-second intervals)
b) Data Processing Pipeline:
• Options data ingestion
• Greeks calculations (Delta, Gamma, Vanna, Charm)
• IV averaging
c) Configuration System:
• Environment variables
• Application settings
Architectural Patterns to Emphasize
• Modular Design (separate modules for different functionalities)
• Event-Driven Architecture (scheduler-based updates)
• MVC-like Pattern (separation of layout, calculation, and data)
Technical Details
Languages/Frameworks:
• Python 3.9+
• Dash/Flask
• Background Scheduler
• CBOE/Custom API Integration
[User Interface Layer]
• ↑↓
[Application Layer]
• ↑↓
[Data Processing Layer]
• ↑↓
[Data Storage Layer]
• ↑↓
[External Services Layer]
• Component types
• Update frequencies
• Time zone specifications
Additional Considerations:
Monitoring points for the scheduler
Remember to add notes about:
• Timezone handling (America/New_York)
• Market hours constraints
• Data format flexibility (JSON/CSV)
• Configuration options via .env file
This will provide a complete picture of how G|Flows operates while maintaining clarity and usefulness for development and maintenance purposes.