How lifanc/quant-flow-docs works
Quant Flow is a command-line stock screener and historical backtester. Its main workflow loads symbols and prices, normalizes data, derives moving-average signals, simulates account trades and a buy-and-hold benchmark, then exports metrics, charts, and replay inputs. Screening and historical-run comparison are separate user-facing capabilities. The README documents the current account model; unsampled modules are represented only where the source index or README supports their role, so some internal links are omitted.
Main entry points: main.py Run coordinator · screening.py Symbol screening · execution.py Target execution · account_simulator.py Account backtest
Components 22
Command workflow
- CLI arguments
src/quant_flow/cli.py - Run coordinator
src/quant_flow/main.py
Market data
- Watchlist loader
src/quant_flow/data/symbols.py - Yahoo prices
src/quant_flow/data/providers/yahoo_finance.py - CSV price loader
src/quant_flow/data/providers/csv_provider.py - Price normalizer
src/quant_flow/data/normalizer.py - CSV format
src/quant_flow/data/csv_format.py
Screening and strategy
- Symbol screening
src/quant_flow/screening.py - Moving averages
src/quant_flow/strategy/moving_average.py - Trade events
src/quant_flow/signals/signal.py
Account simulation
- Account backtest
src/quant_flow/backtest/account_simulator.py - Target execution
src/quant_flow/backtest/execution.py - Order model
src/quant_flow/orders/order.py - Fill model
src/quant_flow/fills/fill.py - Cash and holdings
src/quant_flow/portfolio/portfolio.py - Position model
src/quant_flow/positions/position.py
Analysis and reports
- Performance metrics
src/quant_flow/performance/metrics.py - Report exporter
src/quant_flow/reporting/exporter.py - Equity charts
src/quant_flow/reporting/charts.py - Report guide
src/quant_flow/reporting/guide.py - Run comparison
src/quant_flow/reporting/comparison.py
Other components
- Investor
Connections 29
- Investor → CLI arguments: sets options
README.md - CLI arguments → Run coordinator: starts run
README.md - Run coordinator → CLI arguments: parses options
src/quant_flow/main.py - Run coordinator → Watchlist loader: loads symbols
src/quant_flow/main.py - Run coordinator → Symbol screening: dispatches screening
src/quant_flow/main.py - Symbol screening → Yahoo prices: downloads prices
src/quant_flow/screening.py - Symbol screening → Moving averages: applies rule
src/quant_flow/screening.py - Symbol screening → Watchlist loader: loads watchlist
src/quant_flow/screening.py - Symbol screening → CSV format: writes results
src/quant_flow/screening.py - Run coordinator → Yahoo prices: downloads prices
src/quant_flow/main.py - Run coordinator → CSV price loader: loads saved prices
src/quant_flow/main.py - CSV price loader → CSV format: reads CSV
src/quant_flow/data/providers/csv_provider.py - Run coordinator → Price normalizer: normalizes prices
src/quant_flow/main.py - Run coordinator → Moving averages: calculates signals
src/quant_flow/main.py - Run coordinator → Trade events: generates events
src/quant_flow/main.py - Run coordinator → Account backtest: runs strategy and benchmark
src/quant_flow/main.py - Account backtest → Price normalizer: validates data
src/quant_flow/backtest/account_simulator.py - Account backtest → Target execution: executes targets
src/quant_flow/backtest/account_simulator.py - Target execution → Order model: creates orders
src/quant_flow/backtest/execution.py - Target execution → Fill model: creates fills
src/quant_flow/backtest/execution.py - Target execution → Cash and holdings: updates account
src/quant_flow/backtest/execution.py - Cash and holdings → Position model: applies fills
src/quant_flow/portfolio/portfolio.py - Position model → Fill model: applies fill
src/quant_flow/positions/position.py - Run coordinator → Performance metrics: calculates performance
src/quant_flow/main.py - Run coordinator → Report exporter: exports reports
src/quant_flow/main.py - Run coordinator → Equity charts: saves chart
src/quant_flow/main.py - Run coordinator → Report guide: writes guide
src/quant_flow/main.py - Investor → Run comparison: compares runs
README.md - Watchlist loader → CSV format: uses headers
src/quant_flow/data/symbols.py