Vikrant26 commited on
Commit
ff283fd
·
verified ·
1 Parent(s): 0dcbfc5

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -148
README.md DELETED
@@ -1,148 +0,0 @@
1
- # Finance Buddy
2
-
3
- Finance Buddy is a sophisticated Streamlit application designed to analyze P&L documents and answer financial queries using Google Generative AI. This tool is perfect for financial analysts, accountants, and anyone dealing with financial statements.
4
-
5
- ## Table of Contents
6
-
7
- - [Features](#features)
8
- - [Prerequisites](#prerequisites)
9
- - [Setup](#setup)
10
- - [Using Docker](#using-docker)
11
- - [Local Setup](#local-setup)
12
- - [Usage](#usage)
13
- - [Contributing](#contributing)
14
- - [License](#license)
15
-
16
- ## Features
17
-
18
- - **Document Upload**: Upload multiple P&L documents in PDF format.
19
- - **Document Processing**: Process uploaded documents to extract and analyze financial data.
20
- - **Query System**: Ask questions about your financial data and get accurate, professional responses.
21
- - **Integration with Google Generative AI**: Leverage advanced AI capabilities for accurate and context-aware responses.
22
-
23
- ## Prerequisites
24
-
25
- - Docker (for containerized deployment)
26
- - Python 3.8+
27
- - Streamlit
28
- - Google Generative AI API Key
29
-
30
- ## Setup
31
-
32
- ### Using Docker
33
-
34
- 1. **Clone the repository:**
35
-
36
- ```sh
37
- git clone <repository_url>
38
- cd finance-buddy
39
- ```
40
-
41
- 2. **Build the Docker image:**
42
-
43
- ```sh
44
- docker build -t finance-buddy .
45
- ```
46
-
47
- 3. **Run the Docker container:**
48
-
49
- ```sh
50
- docker run -p 8501:8501 finance-buddy
51
- ```
52
-
53
- 4. **Access the application:**
54
-
55
- Open your browser and go to `http://localhost:8501`.
56
-
57
- ### Local Setup
58
-
59
- 1. **Clone the repository:**
60
-
61
- ```sh
62
- git clone <repository_url>
63
- cd finance-buddy
64
- ```
65
-
66
- 2. **Create a virtual environment and activate it:**
67
-
68
- ```sh
69
- python -m venv venv
70
- source venv/bin/activate # On Windows use `venv\Scripts\activate`
71
- ```
72
-
73
- 3. **Install the required packages:**
74
-
75
- ```sh
76
- pip install -r requirements.txt
77
- ```
78
-
79
- 4. **Create a `.env` file and add your Google API Key:**
80
-
81
- ```sh
82
- GOOGLE_API_KEY=your_google_api_key_here
83
- ```
84
-
85
- 5. **Run the Streamlit application:**
86
-
87
- ```sh
88
- streamlit run app.py
89
- ```
90
-
91
- 6. **Access the application:**
92
-
93
- Open your browser and go to `http://localhost:8501`.
94
-
95
- ## Usage
96
-
97
- ### Uploading and Processing Documents
98
-
99
- 1. **Upload P&L Documents:**
100
-
101
- Use the sidebar to upload your P&L documents in PDF format.
102
-
103
- 2. **Process Documents:**
104
-
105
- Click the "Process Documents" button to process the uploaded files.
106
-
107
- ### Asking Questions
108
-
109
- 1. **Enter Your Query:**
110
-
111
- Enter your financial queries in the input box.
112
-
113
- 2. **Get Responses:**
114
-
115
- The application will analyze the processed documents and provide accurate responses based on the financial data.
116
-
117
- ### Example Queries
118
-
119
- - "What was the total revenue for the last quarter?"
120
- - "How much did we spend on marketing last year?"
121
- - "What is the net profit margin for the current fiscal year?"
122
-
123
- ## Contributing
124
-
125
- Contributions are welcome! Please follow these steps to contribute:
126
-
127
- 1. Fork the repository.
128
- 2. Create a new branch (`git checkout -b feature-branch-name`).
129
- 3. Commit your changes (`git commit -am 'Add some feature'`).
130
- 4. Push to the branch (`git push origin feature-branch-name`).
131
- 5. Create a new Pull Request.
132
-
133
- ## License
134
-
135
- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
136
-
137
- ## Acknowledgments
138
-
139
- - Thanks to the Streamlit and Google Generative AI teams for their excellent tools and documentation.
140
- - Special thanks to the open-source community for their contributions and support.
141
-
142
- ## Contact
143
-
144
- For any questions or support, please open an issue or contact the maintainers directly.
145
-
146
- ---
147
-
148
- Made ❤️ by Vikrant Kumar