# finsight

**Repository Path**: rwwang/finsight

## Basic Information

- **Project Name**: finsight
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-30
- **Last Updated**: 2024-01-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# 💸 FinSight: 
**Financial Insights at Your Fingertips**

Finsight is a cutting-edge finance AI assistant tailored to meet the needs of portfolio managers, investors, and finance enthusiasts. By leveraging `GPT-4` and financial data, Finsight provides deep insights and actionable summaries about a company, aiding in more informed investment decisions.

![demo](docs/demo.gif)

If you'd like to learn more about the technical details of FinSight, check out the LlamaIndex blogpost below where I do a deep dive into the project:
           
[How I built the Streamlit LLM Hackathon winning app — FinSight using LlamaIndex.](https://blog.llamaindex.ai/how-i-built-the-streamlit-llm-hackathon-winning-app-finsight-using-llamaindex-9dcf6c46d7a0)

## Features
📊 **Finance Metrics Overview**:
- Dive deep into core financial metrics extracted from the income statement, balance sheet, and cash flow.
- Stay updated with the top news sentiment surrounding the company for the current year, ensuring you're always in the loop.
- These are the different sections:
  - **Company Overview**: Get a quick overview of the company.
  - **Income Statement**: Understand the company's revenue and expenses.
  - **Balance Sheet**: Get a grasp on the company's assets, liabilities, and shareholders' equity.
  - **Cash Flow**: Understand the company's cash flow from operating, investing, and financing activities.
  - **News Sentiment**: Stay updated with the top news sentiment surrounding the company for the current year.

📄 **Annual Report Analyzer**:
- Simply upload a company's annual report.
- FinSight will then provide comprehensive insights into:
  - **Fiscal Year Highlights**: Major achievements, milestones, and financial highlights.
  - **Strategy Outlook and Future Direction**: Understand the company's strategic plans and anticipated future trajectory.
  - **Risk Management**: Insight into the company's risk assessment, potential challenges, and mitigation strategies.
  - **Innovation and R&D**: Get a grasp on the company's commitment to innovation and its R&D endeavors.

## Tech Stack 
-- **Streamlit**: Powers the front end, providing a seamless user interface. 
-- **LangChain**: The foundation for integrating the LLM into the web app.
-- **Llama Index**: Simple, flexible data framework for connecting custom data sources to large language models.
-- **Alpha Vantage**: The go-to API service for fetching the most recent financial data about companies.

## How to Use
### Website Access: 
Head over to [Finsight](https://finsight-report.streamlit.app/)

### **Local Setup**:


1. **Clone the Repository**:
```bash
git clone https://github.com/vishwasg217/finsight.git
cd finsight
```

2. **Set Up a Virtual Environment** (Optional but Recommended):
```bash
# For macOS and Linux:
python3 -m venv venv

# For Windows:
python -m venv venv
```

3. **Activate the Virtual Environment**:
```bash
# For macOS and Linux:
source venv/bin/activate

# For Windows:
.\venv\Scripts\activate
```

4. **Install Required Dependencies**:
```bash
pip install -r requirements.txt
```

5. **Set up the Environment Variables**:
```bash
# create directory
mkdir .streamlit

# create toml file
touch .streamlit/secrets.toml
```

You can get your API keys here: [AlphaVantage](https://www.alphavantage.co/support/#api-key), [OpenAI](https://openai.com/blog/openai-api)

```bash
# add the following API keys
av_api_key = "ALPHA_VANTAGE API KEY"

openai_api_key = "OPEN AI API KEY"


```

6. **Run Finsight**:
```bash
streamlit run 🏡_Home.py
```

After running the command, Streamlit will provide a local URL (usually `http://localhost:8501/`) which you can open in your web browser to access Finsight.