mirror of
https://github.com/shawnkim1997/All-in-one-Financial-Analysis.git
synced 2026-08-14 02:48:06 +00:00
Complete migration from Streamlit to Next.js 14 App Router + FastAPI backend. Frontend (Next.js 14): - 10 pages: Overview, Research, Valuation, Technical, Markets, Earnings, News, Portfolio, Filings, Settings - Terminal Noir dark theme with custom Tailwind config - TradingView Lightweight Charts for candlestick/volume - Valuation: DCF, Sensitivity Matrix, Monte Carlo, Tornado, Reverse DCF - Financial Statements table with YoY growth badges and margin rows - SEC EDGAR inline filing viewer with section tabs - News split-view with iframe article embedding - Technical Analysis with RSI, MACD, Bollinger, Fibonacci, Moving Averages - Earnings beat/miss visualization - AI Copilot chat panel with Gemini integration Backend (FastAPI): - 13 routers: market_data, financials, valuation, technical, earnings, insider, edgar, news, portfolio, analysis, chat, estimates, fx - Services: DCF engine, Monte Carlo simulation, sensitivity analysis, risk metrics, SEC parser, technical indicators - yfinance + yahooquery data sources with fallback pattern - SQLite caching layer Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
383 lines
14 KiB
Python
383 lines
14 KiB
Python
"""SEC EDGAR 10-K download, parsing, section extraction, and caching.
|
|
|
|
Handles the full pipeline from downloading a 10-K filing via
|
|
``sec_edgar_downloader`` through HTML stripping to isolating individual
|
|
Item sections (1A, 3, 7, 8, 9A) and persisting the cleaned text to a
|
|
local JSON cache under ``data/``.
|
|
"""
|
|
|
|
import json
|
|
import re
|
|
import tempfile
|
|
from pathlib import Path
|
|
from typing import Dict, List, Optional
|
|
|
|
from bs4 import BeautifulSoup
|
|
|
|
from server.services.text_chunker import clean_text_for_llm, smart_chunk
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Paths
|
|
# ---------------------------------------------------------------------------
|
|
|
|
_DATA_DIR: Path = Path(__file__).resolve().parents[3] / "data"
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Section-header regex patterns
|
|
# ---------------------------------------------------------------------------
|
|
|
|
ITEM1A_PATTERNS: List[str] = [
|
|
r"Item\s+1A\s*[.:]\s*Risk\s+Factors",
|
|
r"ITEM\s+1A\s*[.:]\s*Risk\s+Factors",
|
|
]
|
|
|
|
ITEM7_PATTERNS: List[str] = [
|
|
r"Item\s+7\s*[.:]\s*Management['\u2019]s\s+Discussion\s+and\s+Analysis",
|
|
r"ITEM\s+7\s*[.:]\s*Management['\u2019]s\s+Discussion",
|
|
r"Item\s+7\s*[.:]\s*[\w\s]+MD&A",
|
|
]
|
|
|
|
ITEM8_PATTERNS: List[str] = [
|
|
r"Item\s+8\s*[.:]\s*Financial\s+Statements",
|
|
r"ITEM\s+8\s*[.:]\s*Financial\s+Statements",
|
|
]
|
|
|
|
ITEM3_PATTERNS: List[str] = [
|
|
r"Item\s+3\s*[.:]\s*Legal\s+Proceedings",
|
|
r"ITEM\s+3\s*[.:]\s*Legal\s+Proceedings",
|
|
]
|
|
|
|
ITEM9A_PATTERNS: List[str] = [
|
|
r"Item\s+9A\s*[.:]\s*Controls\s+and\s+Procedures",
|
|
r"Item\s+9A\s*[.:]\s*Internal\s+Control",
|
|
r"ITEM\s+9A\s*[.:]\s*Controls",
|
|
]
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# HTML helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _slice_html_items_1a_to_9a(raw_html: str) -> str:
|
|
"""Fast string-level slice: keep only Item 1A through end of Item 9A."""
|
|
if not raw_html or len(raw_html) < 5000:
|
|
return raw_html
|
|
start = -1
|
|
for needle in ("Item 1A", "ITEM 1A", "Item 1a"):
|
|
i = raw_html.find(needle)
|
|
if i != -1 and (start == -1 or i < start):
|
|
start = i
|
|
if start == -1:
|
|
m = re.search(r"Item\s+1A\s", raw_html, re.IGNORECASE)
|
|
start = m.start() if m else 0
|
|
else:
|
|
start = max(0, start - 200)
|
|
search_region = raw_html[start:]
|
|
end_match = re.search(
|
|
r"Item\s+10\s|Item\s+12\s|Part\s+III\b|PART\s+III\b",
|
|
search_region,
|
|
re.IGNORECASE,
|
|
)
|
|
end = start + end_match.start() if end_match else len(raw_html)
|
|
end = min(end, start + 8_000_000)
|
|
return raw_html[start:end]
|
|
|
|
|
|
def _extract_text_from_html_string(html_str: str) -> str:
|
|
"""Parse an HTML string and return plain text (tables/scripts removed)."""
|
|
if not html_str or not html_str.strip():
|
|
return ""
|
|
try:
|
|
soup = BeautifulSoup(html_str, "lxml")
|
|
except Exception:
|
|
soup = BeautifulSoup(html_str, "html.parser")
|
|
for tag in soup.find_all(["table", "img", "svg", "style", "script"]):
|
|
tag.decompose()
|
|
return soup.get_text(separator="\n", strip=True)
|
|
|
|
|
|
def extract_text_from_html(html_path: Path) -> str:
|
|
"""Read an HTML file, slice to Items 1A-9A, and return plain text."""
|
|
try:
|
|
with open(html_path, "r", encoding="utf-8", errors="replace") as f:
|
|
raw = f.read()
|
|
except Exception:
|
|
with open(html_path, "r", encoding="latin-1", errors="replace") as f:
|
|
raw = f.read()
|
|
chunk = _slice_html_items_1a_to_9a(raw)
|
|
return _extract_text_from_html_string(chunk)
|
|
|
|
|
|
def extract_text_from_file(file_path: Path) -> str:
|
|
"""Extract plain text from an HTML or TXT file."""
|
|
suf = file_path.suffix.lower()
|
|
if suf in (".htm", ".html"):
|
|
return extract_text_from_html(file_path)
|
|
if suf == ".txt":
|
|
with open(file_path, "r", encoding="utf-8", errors="replace") as f:
|
|
text = f.read()
|
|
text = re.sub(r"<[^>]+>", " ", text)
|
|
text = re.sub(r"\s+", " ", text)
|
|
return text
|
|
return ""
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Section finders
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _find_section_start(text: str, patterns: List[str], item_num: int) -> int:
|
|
"""Return character offset where *item_num* section begins, or -1."""
|
|
for pat in patterns:
|
|
m = re.search(pat, text, re.IGNORECASE)
|
|
if m:
|
|
return m.start()
|
|
m = re.search(r"\bItem\s+" + str(item_num) + r"\b", text, re.IGNORECASE)
|
|
return m.start() if m else -1
|
|
|
|
|
|
def find_item_section_generic(
|
|
text: str,
|
|
patterns: List[str],
|
|
item_num: int,
|
|
title_keywords: List[str],
|
|
max_chars: int = 120_000,
|
|
) -> str:
|
|
"""Extract a single Item section from full 10-K text."""
|
|
start = _find_section_start(text, patterns, item_num)
|
|
if start == -1:
|
|
pattern = re.compile(
|
|
r"\bItem\s+" + str(item_num)
|
|
+ r"\b[.\s]*[^\n]*("
|
|
+ "|".join(re.escape(k) for k in title_keywords)
|
|
+ r")?",
|
|
re.IGNORECASE,
|
|
)
|
|
match = pattern.search(text)
|
|
if not match:
|
|
return ""
|
|
start = match.start()
|
|
next_item = re.search(r"\n\s*Item\s+\d+[A-Z]?\s+", text[start + 100:], re.IGNORECASE)
|
|
end = start + 100 + next_item.start() if next_item else min(start + max_chars, len(text))
|
|
return text[start:end].strip()
|
|
|
|
|
|
def _extract_item_from_full(
|
|
text: str,
|
|
patterns: List[str],
|
|
item_num: int,
|
|
keywords: List[str],
|
|
max_chars: int = 60_000,
|
|
) -> str:
|
|
"""Extract one item section from full 10-K text."""
|
|
start = _find_section_start(text, patterns, item_num)
|
|
if start < 0:
|
|
pat = re.compile(
|
|
r"\bItem\s+" + str(item_num) + r"[A-Z]?\b[.\s]*[^\n]*",
|
|
re.IGNORECASE,
|
|
)
|
|
match = pat.search(text)
|
|
start = match.start() if match else -1
|
|
if start < 0:
|
|
return ""
|
|
next_item = re.search(r"\n\s*Item\s+\d+[A-Z]?\s+", text[start + 100:], re.IGNORECASE)
|
|
end = start + 100 + next_item.start() if next_item else min(start + max_chars, len(text))
|
|
return text[start:end].strip()
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Filing directory helpers
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _get_edgar_downloader() -> type:
|
|
"""Lazy import of ``sec_edgar_downloader.Downloader``."""
|
|
from sec_edgar_downloader import Downloader
|
|
return Downloader
|
|
|
|
|
|
def find_downloaded_10k_path(download_root: Path, ticker: str) -> Optional[Path]:
|
|
"""Locate the most recent 10-K filing directory on disk."""
|
|
ticker_upper = ticker.upper()
|
|
for base in (download_root / "sec-edgar-filings", download_root):
|
|
path_10k = base / ticker_upper / "10-K"
|
|
if path_10k.exists():
|
|
subdirs = sorted(
|
|
[d for d in path_10k.iterdir() if d.is_dir()],
|
|
key=lambda x: x.name,
|
|
reverse=True,
|
|
)
|
|
if subdirs:
|
|
return subdirs[0]
|
|
for base in (download_root / "sec-edgar-filings", download_root):
|
|
if not base.exists():
|
|
continue
|
|
for company_dir in base.iterdir():
|
|
if not company_dir.is_dir():
|
|
continue
|
|
path_10k = company_dir / "10-K"
|
|
if path_10k.exists():
|
|
subdirs = sorted(
|
|
[d for d in path_10k.iterdir() if d.is_dir()],
|
|
key=lambda x: x.name,
|
|
reverse=True,
|
|
)
|
|
if subdirs:
|
|
return subdirs[0]
|
|
return None
|
|
|
|
|
|
def find_all_10k_filing_dirs(download_root: Path, ticker: str) -> List[Path]:
|
|
"""Return all 10-K filing directories sorted newest-first."""
|
|
ticker_upper = ticker.upper()
|
|
for base in (download_root / "sec-edgar-filings", download_root):
|
|
path_10k = base / ticker_upper / "10-K"
|
|
if path_10k.exists():
|
|
return sorted(
|
|
[d for d in path_10k.iterdir() if d.is_dir()],
|
|
key=lambda x: x.name,
|
|
reverse=True,
|
|
)
|
|
return []
|
|
|
|
|
|
def get_main_10k_text(filing_dir: Path) -> str:
|
|
"""Return the longest extracted text from all files in *filing_dir*."""
|
|
all_text: List[tuple] = []
|
|
for ext in ("*.htm", "*.html", "*.txt"):
|
|
for path in filing_dir.rglob(ext):
|
|
try:
|
|
t = extract_text_from_file(path)
|
|
if len(t) > 1000:
|
|
all_text.append((path, t))
|
|
except Exception:
|
|
continue
|
|
if not all_text:
|
|
return ""
|
|
_, main_text = max(all_text, key=lambda x: len(x[1]))
|
|
return main_text
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Cache layer
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _get_10k_cache_path(ticker: str) -> Path:
|
|
"""Path for cached 10-K sections: ``data/TICKER_latest.json``."""
|
|
_DATA_DIR.mkdir(parents=True, exist_ok=True)
|
|
return _DATA_DIR / f"{ticker.upper()}_latest.json"
|
|
|
|
|
|
def _load_10k_from_cache(ticker: str) -> Optional[Dict[str, str]]:
|
|
"""Load cached sections or return ``None`` if absent."""
|
|
path = _get_10k_cache_path(ticker)
|
|
if not path.exists():
|
|
return None
|
|
try:
|
|
with open(path, "r", encoding="utf-8") as f:
|
|
return json.load(f)
|
|
except Exception:
|
|
return None
|
|
|
|
|
|
def _save_10k_to_cache(ticker: str, data: Dict[str, str]) -> None:
|
|
"""Persist cleaned 10-K sections to the JSON cache."""
|
|
path = _get_10k_cache_path(ticker)
|
|
_DATA_DIR.mkdir(parents=True, exist_ok=True)
|
|
with open(path, "w", encoding="utf-8") as f:
|
|
json.dump(data, f, ensure_ascii=False, indent=0)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# High-level download + extract
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def download_and_extract_all_items(ticker: str, email: str) -> Dict[str, str]:
|
|
"""Download latest 10-K, extract Items 1A/3/7/8/9A, clean and cache."""
|
|
Downloader = _get_edgar_downloader()
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
download_root = Path(tmpdir)
|
|
dl = Downloader("FQDC-10K-Analyzer", email, str(download_root))
|
|
dl.get("10-K", ticker.upper(), limit=1, download_details=True)
|
|
filing_dir = find_downloaded_10k_path(download_root, ticker)
|
|
if not filing_dir:
|
|
raise FileNotFoundError(f"Could not find 10-K for ticker '{ticker}'.")
|
|
full_text = get_main_10k_text(filing_dir)
|
|
if not full_text:
|
|
raise ValueError("Could not extract text from the 10-K.")
|
|
|
|
item1a = find_item_section_generic(full_text, ITEM1A_PATTERNS, 1, ["Risk", "Factors"], max_chars=80_000)
|
|
item3 = _extract_item_from_full(full_text, ITEM3_PATTERNS, 3, ["Legal", "Proceedings"], max_chars=40_000)
|
|
item9a = _extract_item_from_full(full_text, ITEM9A_PATTERNS, 9, ["Controls", "Procedures", "Internal"], max_chars=40_000)
|
|
|
|
start7 = _find_section_start(full_text, ITEM7_PATTERNS, 7)
|
|
text_after_7 = full_text[start7:] if start7 >= 0 else full_text
|
|
item7 = find_item_section_generic(text_after_7, ITEM7_PATTERNS, 7, ["Management's Discussion", "MD&A", "Analysis"], max_chars=100_000)
|
|
if not item7 and text_after_7:
|
|
item7 = text_after_7[:120_000]
|
|
item8 = _extract_item_from_full(full_text, ITEM8_PATTERNS, 8, ["Financial Statements", "Supplementary Data"], max_chars=200_000)
|
|
|
|
data: Dict[str, str] = {
|
|
"item1a": clean_text_for_llm(item1a or ""),
|
|
"item3": clean_text_for_llm(item3 or ""),
|
|
"item9a": clean_text_for_llm(item9a or ""),
|
|
"item7": clean_text_for_llm(item7 or ""),
|
|
"item8": clean_text_for_llm(item8 or ""),
|
|
}
|
|
_save_10k_to_cache(ticker, data)
|
|
return data
|
|
|
|
|
|
def get_10k_sections(ticker: str, email: str) -> tuple[Dict[str, str], str]:
|
|
"""Return ``(sections, status)``; *status* is ``'cache'`` or ``'downloaded'``."""
|
|
cached = _load_10k_from_cache(ticker)
|
|
if cached is not None:
|
|
return cached, "cache"
|
|
return download_and_extract_all_items(ticker, email), "downloaded"
|
|
|
|
|
|
def download_and_extract_item7_and_1a(ticker: str, email: str) -> tuple[str, str, str]:
|
|
"""Fetch 10-K and return ``(full_text, item1a, item7)``."""
|
|
sections, _ = get_10k_sections(ticker, email)
|
|
return "", sections.get("item1a", "") or "", sections.get("item7", "") or ""
|
|
|
|
|
|
def download_item7_latest_and_3y_ago(
|
|
ticker: str,
|
|
email: str,
|
|
) -> tuple[Optional[str], Optional[str], Optional[str], bool]:
|
|
"""Download up to 5 10-Ks; return item1a (latest), item7 latest, item7 3y ago, has_comparison."""
|
|
Downloader = _get_edgar_downloader()
|
|
with tempfile.TemporaryDirectory() as tmpdir:
|
|
download_root = Path(tmpdir)
|
|
dl = Downloader("FQDC-10K-Analyzer", email, str(download_root))
|
|
dl.get("10-K", ticker.upper(), limit=5, download_details=True)
|
|
filing_dirs = find_all_10k_filing_dirs(download_root, ticker)
|
|
if not filing_dirs:
|
|
raise FileNotFoundError(f"Could not find 10-K for ticker '{ticker}'.")
|
|
|
|
full_latest = get_main_10k_text(filing_dirs[0])
|
|
if not full_latest:
|
|
raise ValueError("Could not extract text from the latest 10-K.")
|
|
|
|
item1a = find_item_section_generic(full_latest, ITEM1A_PATTERNS, 1, ["Risk", "Factors"], max_chars=80_000)
|
|
|
|
s7 = _find_section_start(full_latest, ITEM7_PATTERNS, 7)
|
|
text_after_7 = full_latest[s7:] if s7 >= 0 else full_latest
|
|
item7_latest = find_item_section_generic(text_after_7, ITEM7_PATTERNS, 7, ["Management's Discussion", "MD&A", "Analysis"], max_chars=100_000)
|
|
if not item7_latest and text_after_7:
|
|
item7_latest = smart_chunk(text_after_7[:120_000], max_chars=20_000)
|
|
|
|
item7_3y_ago: Optional[str] = None
|
|
has_comparison = False
|
|
if len(filing_dirs) >= 4:
|
|
full_3y = get_main_10k_text(filing_dirs[3])
|
|
if full_3y:
|
|
s7_3y = _find_section_start(full_3y, ITEM7_PATTERNS, 7)
|
|
text_3y = full_3y[s7_3y:] if s7_3y >= 0 else full_3y
|
|
item7_3y_ago = find_item_section_generic(text_3y, ITEM7_PATTERNS, 7, ["Management's Discussion", "MD&A", "Analysis"], max_chars=100_000)
|
|
if not item7_3y_ago and text_3y:
|
|
item7_3y_ago = smart_chunk(text_3y[:120_000], max_chars=20_000)
|
|
has_comparison = bool(item7_3y_ago)
|
|
|
|
return item1a or "", item7_latest or "", item7_3y_ago, has_comparison
|