The Finance & Private Equity AI Assistant is an advanced AI-powered application designed to generate comprehensive financial reports and insights based on a set of provided metrics and details. This tool is ideal for professionals seeking detailed analysis in the finance and private equity sectors.
- Comprehensive Financial Reports: Generate detailed reports with insights tailored to selected topic categories.
- Downloadable Markdown Reports: Easily download reports in Markdown format for further use and sharing.
-
Clone this repository:
git clone <repository-url>
-
Install dependencies:
pip install -r requirements.txt
-
Configure API Key:
- Create a
.env
file in the root directory with your OpenAI API key:OPENAI_API_KEY=your_api_key_here
- Alternatively, use a
.streamlit/secrets.toml
file:OPENAI_API_KEY = "your_api_key_here"
The application will prioritize the
.env
file for the API key. If it doesn't exist, it will fall back tosecrets.toml
. - Create a
-
Run the application:
- Using Streamlit:
streamlit run app.py
- Alternatively, run locally with the
run.bat
file:./run.bat
- Using Streamlit:
- Select functionality from the sidebar.
- Input financial data or questions.
- The AI processes your request and provides insights.
- Python 3.8+
- OpenAI API key
- Internet connection for API access
The application uses a secure method to manage API keys:
- Environment Variables: Preferred method using a
.env
file. - Streamlit Secrets: Alternative method using
.streamlit/secrets.toml
.
Ensure sensitive information is not committed to your repository by adding these files to .gitignore
.