diff options
| author | Tyler <tyler@tylerhoang.xyz> | 2026-03-30 23:27:45 -0700 |
|---|---|---|
| committer | Tyler <tyler@tylerhoang.xyz> | 2026-03-30 23:27:45 -0700 |
| commit | ef2374a88c555257f84ad9e629910fb12986aea0 (patch) | |
| tree | 17f50c27bf14cb03e33cd4d1bb6f610434de83dd /README.html | |
| parent | 1cf833cc1820bb8ef4e22639d7ba29b58cf21e6a (diff) | |
Update README with all new features
Covers: score card, 52W range bar, short interest, Options tab, CSV exports,
7-tab Valuation panel, self-computed key ratios (no FMP quota), updated
project structure, corrected API usage table.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'README.html')
| -rw-r--r-- | README.html | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/README.html b/README.html new file mode 100644 index 0000000..f866d8d --- /dev/null +++ b/README.html @@ -0,0 +1,143 @@ +<!DOCTYPE html> +<html lang="en"> +<head> +<meta charset="UTF-8"> +<style> + body { font-family: sans-serif; max-width: 800px; line-height: 1.6; } + code, pre { font-family: monospace; background: #4d4d4d; padding: 0.2em 0.4em; border-radius: 3px; } + pre { padding: 0.75em 1em; overflow-x: auto; } + pre code { background: none; padding: 0; } + table { border-collapse: collapse; width: 100%; } + th, td { border: 1px solid #ccc; padding: 0.4em 0.75em; text-align: left; } + th { background: #4d4d4d; } +</style> +</head> +<body> +<h1>🔷 Prism</h1> +<p>A local financial analysis dashboard. Search any stock ticker to get a comprehensive view of financials, valuation, options flow, insider activity, SEC filings, and news — all in your browser.</p> +<hr /> +<h2>Features</h2> +<h3>Market Bar</h3> +<p>Live S&P 500, NASDAQ, DOW, and VIX at the top of every page.</p> +<h3>Overview</h3> +<ul> +<li><strong>Score card</strong> — at-a-glance green/yellow/red signal badges for Valuation, Growth, Profitability, Leverage, Momentum, and Short Interest</li> +<li><strong>52-week range bar</strong> — visual indicator showing where the current price sits between the 52W low and high, with % context</li> +<li><strong>Short interest</strong> — % of float, days to cover, shares short vs. prior month</li> +<li>Price chart (1M / 3M / 6M / 1Y / 5Y), key stats (market cap, P/E, volume, beta)</li> +</ul> +<h3>Financials</h3> +<p>Annual and quarterly Income Statement, Balance Sheet, and Cash Flow Statement with year-over-year % change columns color-coded green/red (cost/debt rows are correctly inverted). CSV export on every statement.</p> +<h3>Valuation</h3> +<p>Seven sub-tabs:</p> +<table> +<thead> +<tr><th>Tab</th><th>Contents</th></tr> +</thead> +<tbody> +<tr><td>Key Ratios</td><td>P/E, Forward P/E, P/S, P/B, EV/EBITDA, EV/Revenue, margins, ROE, ROA, ROIC, D/E, current/quick ratio, interest coverage, dividend yield, payout ratio</td></tr> +<tr><td>Historical Ratios</td><td>Annual P/E, P/B, P/S, EV/EBITDA, margins, ROE, ROA, D/E charted over time</td></tr> +<tr><td>DCF Model</td><td>Adjustable WACC, terminal growth, projection years, FCF growth; waterfall chart; EV/EBITDA implied price below</td></tr> +<tr><td>Comps</td><td>Peer valuation table with editable ticker set</td></tr> +<tr><td>Forward Estimates</td><td>Analyst revenue, EPS, and EBITDA estimates with low/avg/high ranges and chart overlay</td></tr> +<tr><td>Analyst Targets</td><td>Price target range (low/mean/median/high), upside to mean, recommendation distribution chart</td></tr> +<tr><td>Earnings History</td><td>EPS actual vs. estimate, surprise %, color-coded table, chart; CSV export</td></tr> +</tbody> +</table> +<blockquote><p>All Key Ratios are self-computed from raw yfinance quarterly statements — no FMP quota consumed.</p></blockquote> +<h3>Options</h3> +<ul> +<li>Put/call ratio by volume and open interest (with Bullish / Neutral / Bearish label)</li> +<li>IV smile chart (calls and puts) with ATM marker</li> +<li>Open interest by strike (calls above axis, puts mirrored below)</li> +<li>Full options chain table (expandable)</li> +</ul> +<h3>Insiders</h3> +<p>Buy/sell transaction history with monthly activity bar chart and filterable table.</p> +<h3>Filings</h3> +<p>Recent 10-K, 10-Q, and 8-K filings with direct EDGAR exhibit links, color-coded by type.</p> +<h3>News</h3> +<p>Recent articles with Bullish / Bearish / Neutral sentiment badges and a 7-day sentiment summary.</p> +<hr /> +<h2>Setup</h2> +<h3>1. Navigate to the project</h3> +<pre><code>cd ~/Work/prism</code></pre> +<h3>2. Activate the virtual environment</h3> +<pre><code>source .venv/bin/activate</code></pre> +<h3>3. Add API keys</h3> +<pre><code>cp .env.example .env</code></pre> +<p>Open <code>.env</code> and fill in your keys:</p> +<pre><code>FMP_API_KEY=your_key_here +FINNHUB_API_KEY=your_key_here</code></pre> +<p>Both are <strong>free</strong>:</p> +<ul> +<li><strong>FMP</strong> (Financial Modeling Prep) — <a href="https://financialmodelingprep.com/developer/docs">financialmodelingprep.com</a> — 250 requests/day</li> +<li><strong>Finnhub</strong> — <a href="https://finnhub.io">finnhub.io</a> — 60 requests/minute</li> +</ul> +<blockquote><p><strong>No keys?</strong> Most of Prism still works. Overview, Financials, Key Ratios, Historical Ratios (yfinance fallback), Options, Insiders, Filings, and the DCF model all run without any API key. The Comps peer list, Forward Estimates, and News require FMP/Finnhub keys.</p></blockquote> +<h3>4. Run the app</h3> +<pre><code>streamlit run app.py</code></pre> +<p>Opens at <code>http://localhost:8501</code></p> +<hr /> +<h2>Daily Usage</h2> +<pre><code>cd ~/Work/prism +source .venv/bin/activate +streamlit run app.py</code></pre> +<hr /> +<h2>Project Structure</h2> +<pre><code>prism/ +├── app.py # Entry point — sidebar, market bar, tab routing +├── requirements.txt +├── .env # Your API keys (not committed) +├── .env.example # Key template +├── .streamlit/ +│ └── config.toml # Dark theme + layout settings +├── assets/ +│ └── logo.png # Sidebar logo +├── services/ +│ ├── data_service.py # yfinance — price, financials, options, compute_ttm_ratios +│ ├── fmp_service.py # FMP API — peers, forward estimates, historical ratios, news +│ ├── news_service.py # Finnhub — news + sentiment +│ └── valuation_service.py # DCF engine + EV/EBITDA implied price +├── components/ +│ ├── market_bar.py # Index metrics row +│ ├── overview.py # Score card, 52W bar, short interest, price chart +│ ├── financials.py # Color-coded statement tables + CSV export +│ ├── valuation.py # 7-tab valuation panel +│ ├── options.py # Options flow — P/C ratio, IV smile, OI chart +│ ├── insiders.py # Insider buy/sell history +│ ├── filings.py # SEC filings +│ └── news.py # News feed + sentiment +└── utils/ + └── formatters.py # Number formatting helpers</code></pre> +<hr /> +<h2>DCF Model Notes</h2> +<p>The DCF uses historical <strong>Free Cash Flow</strong> from yfinance and projects forward using your chosen assumptions:</p> +<table> +<thead> +<tr><th>Input</th><th>Default</th><th>Range</th></tr> +</thead> +<tbody> +<tr><td>WACC</td><td>10%</td><td>5–20%</td></tr> +<tr><td>Terminal Growth Rate</td><td>2.5%</td><td>0.5–5%</td></tr> +<tr><td>Projection Years</td><td>5</td><td>3–10</td></tr> +<tr><td>FCF Growth Rate</td><td>Historical median</td><td>−20–30%</td></tr> +</tbody> +</table> +<p>Terminal value uses the <strong>Gordon Growth Model</strong>. Enterprise value is bridged to equity value using net debt before calculating value per share. The FCF growth slider defaults to the historical median and can be overridden.</p> +<p>The <strong>EV/EBITDA</strong> section derives an implied price from a target multiple applied to trailing EBITDA (sourced from the income statement, not the info dict). The slider defaults to the current computed market multiple.</p> +<hr /> +<h2>API Usage</h2> +<table> +<thead> +<tr><th>Source</th><th>Limit</th><th>Used For</th></tr> +</thead> +<tbody> +<tr><td>yfinance</td><td>None</td><td>Price, financials, options, insiders, filings, all key ratios</td></tr> +<tr><td>FMP (free)</td><td>250 req/day</td><td>Peer discovery, forward estimates, historical ratios, news</td></tr> +<tr><td>Finnhub (free)</td><td>60 req/min</td><td>News sentiment</td></tr> +</tbody> +</table> +<p>All key ratios are computed locally from quarterly statements — Prism only calls FMP for data that cannot be derived from raw statements. Data is cached per session (financials: 1h, news: 10min, indices: 5min, options: 15min).</p> +</body> +</html> |