How abtonmoy/vault-investment works
Project Type and Purpose
• This is a single‐page web application built with Streamlit, focused on portfolio tracking, optimization, and risk analysis.
• Users upload brokerage CSV/PDF files, view visualizations, run Modern Portfolio Theory optimizations, and analyze risk metrics using historical market data from yfinance.
File Structure Analysis
• Top Level
• app.py – Entry point, orchestrates the Streamlit UI.
• assets/ – Static images for documentation or UI.
• requirements.txt, LICENSE, README.md, .gitignore, .devcontainer – Supporting files.
• core/
• data_fetcher.py – Fetches historical price data via yfinance.
• robinhood_parser.py – Parses broker‐specific CSV/PDF.
• portfolio_optimizer.py – Implements optimization algorithms (Sharpe maximization, min volatility).
• interfaces/
• investment_tracker.py – UI tabs/components for data upload and portfolio overview.
• portfolio_optimizer_interface.py – UI for selecting optimization strategies.
• risk_analysis_interface.py – UI for displaying risk metrics and charts.
• utils/
• portfolio_charts.py, equity_vis.py – Rendering charts (Sankey, scatter, drawdown).
• risk_analysis.py, risk_beta_analysis.py – Statistical computations (VaR, beta).
• helpers.py, theme.py – Shared helpers and styling.
Key Architectural Patterns
• Layered (Presentation → Business Logic → Utilities/Data)
• Modular separation ensures UI code in interfaces/ calls business logic in core/, which in turn uses utils/ for computations and charting.
• External Integration: yfinance (market data), fuzzywuzzy/pdfplumber (optional parsing).
Main Components
a. Presentation Layer
• Streamlit App (app.py)
• UI Modules (interfaces/*.py)
b. Business Logic Layer
• Data Fetcher (core/data_fetcher.py)
• Parser (core/robinhood_parser.py)
• Optimizer (core/portfolio_optimizer.py)
c. Utility Services
• Charting & Visualization (utils/portfolio_charts.py, utils/equity_vis.py)
• Risk Calculators (utils/risk_analysis.py, utils/risk_beta_analysis.py)
• Helpers & Theme (utils/helpers.py, utils/theme.py)
d. External Services
• yfinance API (historical price data)
• File System (CSV/PDF uploads)
e. Data Flow & Storage
• Uploaded Files → Parser → Pandas DataFrame
• DataFrame → Fetcher → Merged price & transaction data
• Data → Optimizer & Risk Modules → Results → UI Components
Relationships and Interactions
• UI triggers file upload → core.robinhood_parser parses → returns DataFrame.
• UI requests historical prices → core.data_fetcher calls yfinance → DataFrame.
• Parsed + price data passed to portfolio_optimizer → returns allocation/results.
• Risk interface invokes utils.risk_analysis → computes VaR, Sharpe, drawdown.
• Chart utilities invoked by UI modules to render visualizations.