How yobibyte/report works
Core Library Components (Central Layer)
• AbstractReport Base Class
• Block System
• Template Engine
• Utility Functions
Input Layer (Top)
• Python Report Files (.py)
• Configuration (.report files)
• User Data Sources
Processing Layer (Middle)
• Report Generation Pipeline:
• Data Loading Phase
• Preparation Phase
• Block Assembly
• HTML Generation
Output Layer (Bottom)
• Static HTML Reports
• Associated Assets (images, etc.)
• [Input] → [Processing] → [Output]
Component Relationships
Detailed Component Breakdown:
• Report Library |
• base.py |
• block.py |
• template.py |
• util.py |
• app.py |
Configuration Flow
• Priority order:
1. Local .report
2. Git repo root .report
3. Home directory .report
4. Default values
Report Generation Pipeline
• [Python Report File] → [AbstractReport] → [Block Assembly] → [HTML Generation]
Block System
• Supported block types:
• Headers (H1, H2, H3)
• Figures
• Tables
• Paragraphs
Important Elements to Highlight:
File Organization
• Separation between source files and generated reports
• Configurable nature of input/output directories
Execution Flow
• load_data() and prepare() methods
• How blocks are sequentially added
• Demonstrate the final HTML generation process
Integration Points
• How the library integrates with matplotlib for figures
• Data input flexibility
• Asset management for generated content
• Symbols for different block types
• File extensions (.py, .html, .report)
Level of Detail:
Static HTML output
This system design should help developers understand both the high-level architecture and the detailed components while maintaining clarity about the project's purpose of providing a more disciplined alternative to Jupyter notebooks.