A cutting-edge Telegram bot repository that empowers users with comprehensive fundamental and technical analysis insights, coupled with real-time buy-sell signals for diverse financial assets.

• Prerequisites
• Installation
• Usage
• Contributing
• License

Before setting up the project, ensure that you have the following prerequisites installed on your machine:

• Python (version 3.9): (https://www.python.org/downloads/)
• Poetry (version 1.4.0): (https://python-poetry.org/docs/#installation)

1. Clone the project repository:

git clone https://github.com/invictus-21/Signal_Savant.git

2. Navigate to the project directory:

cd signal_savant

3. Install project dependencies using Poetry:

poetry install

This command will create a virtual environment and install all the necessary dependencies specified in the pyproject.toml file.

1. Activate the virtual environment created by Poetry:

poetry shell

2. Run the project:

streamlit run "signal_savant/app.py"

or click start.bat file in Windows

If you would like to contribute to this project, follow the guidelines below:

1. Fork the repository and clone it locally.

2. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-feature
   

3. Make your changes and commit them with descriptive commit messages.

4. Push your changes to your forked repository:

   git push origin feature/your-feature
   

5. Open a pull request in the original repository, describing your changes in detail.

GPL v3