|
1 | 1 | # StockDataView |
| 2 | + |
2 | 3 | StockDataView is a Streamlit application designed to display and visualize stock data fetched from the Financial Modeling Prep (FMP) API. It provides users with bar charts, tables of stock fundamentals, and ratings for a given stock ticker. |
3 | 4 |
|
4 | 5 | ## Features |
@@ -84,11 +85,34 @@ uv sync |
84 | 85 | * `builder` stage: Used for development (linting, testing) |
85 | 86 | * `production` stage: Final app image for running StockDataView |
86 | 87 |
|
| 88 | + |
87 | 89 | ## CI/CD Workflow |
88 | 90 | * GitHub Actions automates building the `production` image and pushing it to Docker Hub (`skytics/stockdataview:latest`) on `main` branch updates |
89 | 91 | * The `builder` stage is used for linting and testing in CI |
90 | 92 | * See `.github/workflows/ci-cd.yml` for details |
91 | 93 |
|
| 94 | + |
| 95 | +## Data Source |
| 96 | + |
| 97 | +StockDataView project utilizes data from the free tier of the Financial Modeling Prep (FMP) API. Due to the limitations of the free plan, the primary focus is on **US-listed stocks**. Data for international markets and more advanced features may not be available in this version. |
| 98 | + |
| 99 | +**Limitations due to Free FMP API Plan:** |
| 100 | + |
| 101 | +* **Data Coverage:** Primarily focused on US stock market data. |
| 102 | +* **Historical Data:** Limited historical data availability (typically up to 5 years for most endpoints). |
| 103 | +* **Real-time Data:** Data may be end-of-day or delayed real-time. |
| 104 | +* **API Call Limits:** Functionality might be limited by the daily API call restrictions of the free plan. |
| 105 | + |
| 106 | +**Potential Future Enhancements:** |
| 107 | + |
| 108 | +With access to a paid FMP API plan, future versions of this dashboard could include: |
| 109 | + |
| 110 | +* Support for international stock markets. |
| 111 | +* Access to more extensive historical data. |
| 112 | +* Real-time data updates. |
| 113 | +* Integration of additional financial data and features. |
| 114 | + |
| 115 | + |
92 | 116 | ## Contributing |
93 | 117 | Contributions are welcome! Please feel free to submit a pull request. |
94 | 118 |
|
|
0 commit comments