Skip to content

Commit 09bd578

Browse files
committed
stock data app documentation created using readme markdown
1 parent 1587040 commit 09bd578

File tree

1 file changed

+111
-0
lines changed

1 file changed

+111
-0
lines changed

stock-data-app/README.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# 📈 Stock Data Application
2+
3+
Welcome to the **Stock Data Application**!
4+
This project is a user-friendly web app built with [Streamlit](https://streamlit.io/) and [yfinance](https://github.com/ranaroussi/yfinance), designed to help you explore historical stock prices and company information with ease.
5+
6+
---
7+
8+
## 🌐 Live Demo
9+
10+
You can view the application live here:
11+
[Stock Data Application on Streamlit Cloud](https://python-programs-v9puvb4eqw5cfalfr8qgdi.streamlit.app/)
12+
13+
---
14+
15+
## 🚀 Features
16+
17+
- **Interactive Web UI**: Powered by Streamlit for instant feedback and easy navigation.
18+
- **Live Stock Data**: Fetches historical stock prices from Yahoo Finance using `yfinance`.
19+
- **Company Insights**: Displays sector, industry, and a business summary for selected stocks.
20+
- **Custom Date Range**: Choose your own start and end dates for data analysis.
21+
- **Beautiful Charts**: Visualize Open, High, Low, and Close prices with interactive line charts.
22+
- **Streaming Summaries**: Enjoy a smooth, animated display of business summaries.
23+
24+
---
25+
26+
## 🛠️ How to Run Locally
27+
28+
1. **Clone the repository**
29+
30+
```bash
31+
git clone https://github.com/your-username/Python-Programs.git
32+
cd Python-Programs/stock-data-app
33+
```
34+
35+
2. **Install dependencies**
36+
Make sure you have Python 3.8+ installed.
37+
38+
```bash
39+
pip install -r requirements.txt
40+
```
41+
42+
3. **Start the app**
43+
44+
```bash
45+
streamlit run main.py
46+
```
47+
48+
4. **Open in your browser**
49+
Streamlit will provide a local URL (usually [http://localhost:8501](http://localhost:8501)).
50+
51+
---
52+
53+
## 📂 Folder Structure
54+
55+
```
56+
stock-data-app/
57+
58+
├── main.py # Streamlit app source code
59+
├── requirements.txt # Python dependencies
60+
└── README.md # This documentation
61+
```
62+
63+
---
64+
65+
## 📊 Supported Stocks
66+
67+
Choose from a curated list of popular stocks:
68+
69+
- Microsoft (MSFT)
70+
- Apple (AAPL)
71+
- Amazon (AMZN)
72+
- Google (GOOGL)
73+
- Tesla (TSLA)
74+
- Meta (META)
75+
- Netflix (NFLX)
76+
- Nvidia (NVDA)
77+
- Palantir (PLTR)
78+
79+
---
80+
81+
## 🌐 Deployment
82+
83+
This app can be deployed for free using [Streamlit Community Cloud](https://streamlit.io/cloud):
84+
85+
1. Push this folder to your GitHub repository.
86+
2. Go to [Streamlit Cloud](https://streamlit.io/cloud) and connect your repo.
87+
3. Set the app path to `stock-data-app/main.py`.
88+
4. Click **Deploy**!
89+
90+
---
91+
92+
## 📚 References
93+
94+
- [Streamlit Documentation](https://docs.streamlit.io/library/api-reference)
95+
- [yfinance Documentation](https://ranaroussi.github.io/yfinance/index.html)
96+
97+
---
98+
99+
## 🙏 Acknowledgements
100+
101+
This application was adapted and deployed by **Jesus Torres** as an assignment for the CIDM 4310/5310 Business Intelligence and Decision Support Systems course at West Texas A&M University, under the guidance of Dr. Cheng (Carl) Zhang.
102+
103+
- The original codebase was provided as part of the course material.
104+
105+
Also Special thanks to the open-source community!
106+
107+
---
108+
109+
## 📝 License
110+
111+
This project is for educational and demonstration purposes.

0 commit comments

Comments
 (0)