Billy10111/financial-research-tool

Financial Research Tool Demo 📊

A comprehensive financial research tool for individual investors to analyze stocks, track portfolios, and make informed investment decisions.

🎯 Features

• —📈 Stock Analysis Dashboard: Detailed analysis with technical indicators, charts, and performance metrics
• —🏠 Market Overview: At-a-glance view of market indices, top gainers/losers, and sector performance
• —📥 Data Export: Export historical data and fundamentals to CSV for external analysis
• —💼 Portfolio Tracking: Track your investments and monitor performance (coming soon)
• —⚠️ Watchlists: Create and manage custom stock watchlists (coming soon)

🚀 Quick Start

Prerequisites

• —Python 3.9 or higher
• —pip (Python package installer)
• —Internet connection for fetching market data

Installation

1. 1.Clone or download the repository

1. 1.Install dependencies

   pip install -r requirements.txt

1. 1.Run the setup script

   python scripts/setup_env.py

This will:

• —Initialize the SQLite database
• —Create necessary directories
• —Download required NLTK data
• —Optionally fetch initial market data

1. 1.Launch the application

   streamlit run main.py

1. 1.Open your browser to the URL displayed (typically http://localhost:8501)

📁 Project Structure

Financial research tool/
├── main.py                 # Main Streamlit application entry point
├── requirements.txt        # Python dependencies
├── README.md              # This file
│
├── app/                   # Streamlit pages
│   ├── dashboard.py       # Stock analysis dashboard
│   ├── market_overview.py # Market overview page
│   └── data_export.py     # Data export functionality
│
├── config/                # Configuration files
│   ├── settings.py        # Application settings
│   └── watchlists.py      # Default watchlists
│
├── src/                   # Core source code
│   ├── api/              # API integration
│   │   └── data_fetcher.py
│   ├── processing/       # Data processing
│   │   ├── data_cleaner.py
│   │   └── feature_engineer.py
│   ├── analysis/         # Analysis modules
│   │   ├── historical_analysis.py
│   │   ├── portfolio_tracker.py
│   │   └── sentiment_analyzer.py
│   ├── components/       # UI components
│   │   ├── chart_generator.py
│   │   └── table_display.py
│   └── utils/           # Utilities
│       └── database.py
│
├── scripts/             # Helper scripts
│   ├── setup_env.py    # Environment setup
│   └── update_data.py  # Data update script
│
└── data/               # Data storage
    ├── raw/           # Raw API data
    ├── processed/     # Processed data
    └── exports/       # Exported CSV files

📊 Usage Guide

Market Overview

• —View major market indices (S&P 500, Dow Jones, NASDAQ)
• —See top gainers and losers
• —Analyze sector performance
• —Check overall market sentiment

Stock Dashboard

1. 1.Enter a stock symbol (e.g., AAPL, MSFT, GOOGL)
2. 2.Select time period for analysis
3. 3.Click "Analyze" to load data
4. 4.View:
5. 5.Current price and key statistics
6. 6.Interactive price charts (candlestick or line)
7. 7.Technical indicators (Moving Averages, RSI, MACD)
8. 8.Performance metrics (returns, volatility, Sharpe ratio)
9. 9.Company information

Data Export

1. 1.Choose export type:
2. 2.Historical Prices
3. 3.Company Fundamentals
4. 4.Multiple Stocks Comparison
5. 5.Configure parameters (ticker, time period, etc.)
6. 6.Click "Generate CSV"
7. 7.Preview the data
8. 8.Click "Download CSV" to save

🔧 Configuration

API Keys

For advanced features (news data), you can set API keys:

• —Create a .env file in the project root
• —Add: NEWS_API_KEY=your_key_here

Default Settings

Edit config/settings.py to customize:

• —Default stocks and indices
• —Chart colors and themes
• —Cache settings
• —Update frequency

📈 Technical Indicators

The tool provides various technical indicators:

• —Moving Averages (20, 50, 200-day)
• —RSI (Relative Strength Index)
• —MACD (Moving Average Convergence Divergence)
• —Bollinger Bands
• —Volatility (Daily and Annualized)

🔄 Updating Data

To fetch the latest market data:

python scripts/update_data.py

This script can be scheduled to run periodically (e.g., hourly) using cron (Linux/Mac) or Task Scheduler (Windows).

📝 Data Sources

• —Stock Data: Yahoo Finance (via yfinance library)
• —Market Indices: Yahoo Finance
• —Company Fundamentals: Yahoo Finance

⚠️ Limitations

• —Data is delayed (not real-time)
• —Free API rate limits apply
• —Local deployment only (single user)
• —Demo version with basic features

🛠️ Troubleshooting

Issue: Module not found error

Solution: Ensure all dependencies are installed:

pip install -r requirements.txt

Issue: No data returned for ticker

Solution:

• —Check the ticker symbol is correct
• —Verify internet connection
• —Try a different ticker
• —Check if market is open

Issue: Charts not displaying

Solution:

• —Clear browser cache
• —Refresh the page
• —Check console for errors

🔮 Future Enhancements

• —[ ] Real-time data integration
• —[ ] Advanced portfolio analytics
• —[ ] Alert notifications
• —[ ] Custom watchlists with persistence
• —[ ] Social sentiment analysis
• —[ ] Comparison tools
• —[ ] Mobile-responsive design
• —[ ] Cloud deployment

📄 License

This is a demo project for personal use.

🤝 Contributing

This is a personal demo project, but suggestions are welcome!

📧 Contact

For questions or issues, please refer to the project documentation.

Disclaimer: This tool is for educational and research purposes only. It does not provide investment advice. Always do your own research and consult with financial professionals before making investment decisions.