FundFinder is a powerful and intuitive Streamlit app designed to help investors select the best mutual funds by providing detailed comparisons and insights. The app scrapes mutual fund data from the internet, calculates returns before and after taxes, and compares funds based on their performance and expense ratios. It also visualizes the data to aid in making informed investment decisions.
To set up FundFinder, you need to have Python and Streamlit installed. Follow these steps to get started:
Clone the Repository:
git clone https://github.com/yourusername/FundFinder.git
cd FundFinder
Create and Activate a Virtual Environment (optional but recommended):
python -m venv venv
source venv/bin/activate # On Windows use `venvScriptsactivate`
Install Required Packages:
pip install -r requirements.txt
Set up AI Features:
You can customize the AI-generated insights by adding your GROQ_API_KEY
and specifying the model name in the .env
file. The AI model currently used is GROQ_LLama
. To set up, update the .env
file like this:
GROQ_API_KEY=your_api_key
GROQ_LLama=model_name
Run the Streamlit App:
streamlit run app.py
Interact with the App:
|---_temp
| |-- config.py
|
|---components
| |-- footer.py
|
|--- data
| |-- mutual_fund_data.csv
|
|--- dump
| |-- temp_data.csv
|
|--- notebooks
| |-- test.ipynb
|
|--- pages
| |-- admin_page.ipynb
| |-- fund_list.ipynb
| |-- plot_return.ipynb
| |-- return_calculator.ipynb
|
|--- schema
| |-- LLM_output.py
|
|--- scrap
| |-- scrape.py
|
|--- utils
| |-- calculate_return.py
| |-- auth.py
| |-- generate_response.py
|
|--- app.py
|--- .env
|--- config.yml
|--- .gitignore
|--- LICENSE
|--- README.md
|--- requirements.txt
This project is licensed under the MIT License. See the LICENSE file for details.
Contributions are welcome! Please fork the repository and submit a pull request with your changes. For major changes, please open an issue first to discuss what you would like to change.
For any questions or feedback, please reach out to [email protected].
Happy Investing!