diff --git a/README.md b/README.md new file mode 100644 index 0000000..f2bb3ff --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# 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 + +```bash +pip install flask +python app.py +``` + +Navigate to `http://localhost:5001` + +### Docker + +```bash +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. + +## License + +MIT