How himsheda/python_koans works
Main Components
a. Core Components:
• Test Runner System
• Koans Module Collection
• Helper Libraries
• User Interface Layer (Command-line)
User Interface Layer
Test Runner Layer
Koans Layer
Support Libraries Layer
Specific Component Details
a. User Interface Layer:
• Entry points: contemplate_koans.py
• Alternative entry: scent.py (for Sniffer support)
• Command-line interface components
b. Test Runner Layer (runner/ directory):
• Mountain (runner/mountain.py)
• Sensei (runner/sensei.py)
• Path to Enlightenment (runner/path_to_enlightenment.py)
• Helper utilities (runner/helper.py)
c. Koans Layer (koans/ directory):
• Individual koan modules (about_*.py files)
• Supporting modules (triangle.py, local_module.py, etc.)
• Package examples (a_package_folder)
d. Support Libraries Layer (libs/ directory):
• Colorama for terminal output
• Mock testing support
Relationships and Flows
• Test execution flow
• Module dependencies
• User interaction flow
┌─────────┐
• Module │ - Primary components
• ┘
↓ - Execution flow
→ - Dependencies
⟲ - TDD cycle
Implementation Notes
• The educational nature of the system
• The progressive learning path
• The test-driven development cycle
• The feedback mechanism
Key Interactions to Highlight
• User input → Test Runner → Koan execution
• Test Results → Sensei → User feedback
• Progressive advancement through koans
• Sniffer integration for continuous testing
Additional Recommendations
• A progress indicator component
• Relationship between koans and their test implementations
• Error reporting mechanism
Remember to include a clear indication of the entry points and the flow of execution, as this is crucial for understanding how the system guides users through the learning process.