10k-viewer/README.md
Jarian Cottingham fa7e3eb545
Some checks are pending
Test / test (push) Waiting to run
chore: polish for public release
- Real contact in SEC User-Agent (required by EDGAR)
- Fix Dockerfile cache dir (was missing, build would fail)
- Pin flask>=3.0,<4
- Harden clean_ereader to strip single-quoted attributes
- Remove unused templates (archive.html, more.html)
- Add pytest suite (10 tests) and CI workflow
2026-08-20 21:11:29 +00:00

1.0 KiB

10k Viewer

Web interface for browsing SEC 10-K filings. Query any publicly traded company by ticker, fetch filings data from SEC EDGAR API, and render structured HTML views.

Features

  • Search 10-K filings by company ticker symbol
  • Built-in fallback CIK database for S&P 500 companies
  • SEC EDGAR API integration with retry logic
  • Flask-based web interface with template rendering
  • Local caching for fast repeat queries
  • Docker-ready for deployment

Tech Stack

  • Backend: Python 3.12, Flask
  • Frontend: HTML templates (Jinja2)
  • API: SEC EDGAR REST API
  • Deployment: Docker, port 5001

Setup

Local

pip install flask
python app.py

Navigate to http://localhost:5001

Docker

docker build -t 10k-viewer .
docker run -p 5001:5001 10k-viewer

Usage

Enter a stock ticker (e.g. AAPL, MSFT, GOOGL) to fetch and browse the latest 10-K filing data. Supports any company with a valid CIK identifier.

Tests

pip install -r requirements.txt pytest
python -m pytest tests/

License

MIT