Metadata-Version: 2.4
Name: finance-chatbot
Version: 1.0.11
Summary: An intelligent document analysis and Q&A system for Santa Clara University Finance Department
Home-page: https://github.com/pradeept3/finance-chatbot
Author: Pradeep Kumar Tripathy
Author-email: Pradeep Kumar Tripathy <tripathy.pradeep@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/pradeept3/finance-chatbot
Project-URL: Documentation, https://github.com/pradeept3/finance-chatbot/blob/main/README.md
Project-URL: Repository, https://github.com/pradeept3/finance-chatbot.git
Project-URL: Issues, https://github.com/pradeept3/finance-chatbot/issues
Keywords: chatbot,finance,document-analysis,qa-system,streamlit,flask,generative-ai
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Education
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Education
Classifier: Topic :: Office/Business
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: streamlit>=1.28.1
Requires-Dist: streamlit-option-menu>=0.3.6
Requires-Dist: Flask>=2.3.0
Requires-Dist: Flask-CORS>=4.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: chromadb>=1.3.4
Requires-Dist: sentence-transformers>=2.2.2
Requires-Dist: unstructured[local-inference]>=0.18.20
Requires-Dist: python-docx>=1.2.0
Requires-Dist: pypdf>=6.3.0
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: requests>=2.32.0
Requires-Dist: beautifulsoup4>=4.13.5
Requires-Dist: google-generativeai>=0.6.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: pandas>=2.1.3
Requires-Dist: scikit-learn>=1.3.2
Requires-Dist: scipy>=1.11.4
Requires-Dist: Pillow>=10.1.0
Requires-Dist: lxml>=4.9.3
Requires-Dist: Werkzeug>=2.3.7
Requires-Dist: typing-extensions>=4.8.0
Requires-Dist: pydantic>=2.5.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: black>=23.0; extra == "dev"
Requires-Dist: flake8>=6.0; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: requires-python

PyPI installation
-------------------
pip install finance-chatbot


Prerequisites
----------------
Python 3.8+
pip (Python package manager)
Google Gemini API Key
Ollama (optional)


Installation
------------------
1. Clone the Repository

```console
git clone https://github.com/pradeept3/finance-chatbot.git
cd finance-chatbot
```
2. Install Dependencies
```python
pip install -r requirements.txt
```


3. update the /backend/.env file:
  
  ```css
  GOOGLE_API_KEY=your_google_api_key_here
  OLLAMA_API_URL=http://localhost:11434
  PORT=5000
  UPLOAD_DIR=./uploaded_documents
  MAX_UPLOAD_SIZE=50
  ```


4. Running the Application
    
  ```python
  Start Backend Server
    Open Terminal/ Command prompt:
    Goto the finance-chatbot folder and type cd backend
    python app.py
    Backend runs on: http://127.0.0.1:5000
  Start Frontend (in new terminal)
    Goto the finance-chatbot folder and type cd frontend
    streamlit run main.py
    Frontend runs on: http://localhost:8501
  ```

5. Checklist Before Deployment

  A.  All dependencies installed (pip install -r requirements.txt)
  B.  .env file configured with API keys
  C.  Backend tested (python app.py)
  D.  Frontend tested (streamlit run main.py)
  E.  Sample documents uploaded and searched
  F.  Admin/Student/Guest roles working

