Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shubhamprajapati7748/stockbotx

StockBotX is an intelligent chatbot designed to provide insightful answers to your stock-related queries. It offers a user-friendly interface for market trends, stock performance, and financial insights.
https://github.com/shubhamprajapati7748/stockbotx

agents ai duckduckgo stock-analysis stock-analyzer stock-data yahoo-finance yahoo-finance-api

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/shubhamprajapati7748/stockbotx
Owner: shubhamprajapati7748
License: gpl-3.0
Created: 2024-12-28T11:12:01.000Z (27 days ago)
Default Branch: main
Last Pushed: 2024-12-28T11:55:18.000Z (27 days ago)
Last Synced: 2024-12-28T12:25:46.619Z (27 days ago)
Topics: agents, ai, duckduckgo, stock-analysis, stock-analyzer, stock-data, yahoo-finance, yahoo-finance-api
Language: Python
Homepage: https://stockbotx.streamlit.app/
Size: 227 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: Readme.md
- License: LICENSE

Awesome Lists containing this project

README

# StockBotX

## About The Project

## Screenshot

![StockBotX](stockbotX.png)

## Demo

You can view the demo of StockBotX [here](https://vimeo.com/1042608166)

## Social Media

You can check out more about the project on LinkedIn: [StockBotX LinkedIn Post](https://www.linkedin.com/posts/shubhamprajapati7748_ai-stockbotx-agenticai-activity-7278757239966867456-pVSh/)

## Table of Contents

- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)

### Prerequisites

Before getting started, make sure you have the following:

- **GROQ API Key** (for stock-related data)
- **PHI API Key** (for additional stock market insights)

### Getting Started

To get started with this project locally, you’ll need Python 3.10+ installed on your machine along with the necessary Python packages. You can either clone the repository and install dependencies manually or use Docker for an isolated environment.

## Installation Steps

1. Clone the repository:

- Open your terminal or command prompt.
- Navigate to the directory where you want to install the project.
- Run the following command to clone the GitHub repository:
```bash
git clone https://github.com/shubhamprajapati7748/StockBotX
```

2. Create a Virtual Environment (Optional)

- It's a good practice to create a virtual environment to manage project dependencies. Run the following command:
```bash
conda create -p python== -y
```

3. Activate the Virtual Environment (Optional)

- Activate the virtual environment based on your operating system:
```bash
conda activate /
```

4. Install Dependencies

- Navigate to the project directory:
```bash
cd [project_directory]
```
- Run the following command to install project dependencies:
```bash
pip install -r requirements.txt
```

5. Create `.env` file and add your API keys

6. Run the Project

```bash
streamlit run app.py
```

7. Access the Project
- Visit `http://localhost:8501` in your browser to use the app.

## Contributing

Contributions to the Google Gemini-Pro Chat Application are welcome! If you have suggestions, enhancements, or bug fixes, please follow the steps below:

1. Fork the project.
2. Create your feature branch (`git checkout -b feature/YourFeature`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.

## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact

- Shubham Prajapati - [[email protected]](mailto:[email protected])

## Acknowledgement

- **PHIDATA** for providing stock data.
- **Groq** for powering the AI models.