This directory is the main documentation home for pyvalue. Each file owns one topic and should be treated as the canonical source for that topic.
- Getting Started: first install, environment setup, and first successful workflow.
- Configuration: credentials, environment variables, database path defaults, and local config rules.
- EODHD: global fundamentals, universe loading, and market-data behavior.
- Ingestion and Normalization: how raw payloads become normalized facts.
- Market Data: quote refresh, bulk market updates, and market-cap recalculation.
- Screening: metric computation, YAML screens, and bulk screen runs.
- CLI Reference: command-by-command CLI reference.
- Metrics Catalog: all supported metrics in grouped tables.
- EODHD Concept Normalization: per-concept mapping from raw EODHD payloads to
financial_facts. - Anchor Watchlist: the fixed stock set used to tune screeners, with listing ids and scope lines.
- Position Notes: per-holding quarterly tracking notes — yields on cost vs latest price, quality tripwires, and pre-committed sell rules.
- Screener NA Investigation: which screener metrics come out NA, why, and what to change.
- QARP & DVG Metric Verification (2026-07): watchlist metrics recomputed against SEC/DART filings; EODHD-garbage and pyvalue calc findings with a prioritised fix backlog.
- Data Model and Storage: SQLite tables and persistence flow.
- Database Review Guide: table-by-table schema review, indexes, and query hotspots.
- Normalization and Facts: provider-agnostic concept model and metric inputs.
- Local Development: repo layout, editable install, and common dev workflows.
- Testing and Quality Checks: pytest, ruff, mypy, and contribution expectations.
- Troubleshooting: common setup, provider, freshness, and metric-computation failures.