Skip to content

suvvyai/telegram-user-bot

Repository files navigation

Telegram User Bot for Suvvy AI

GitHub Workflow Status Packaged with Poetry Uses Python 3.11 Code style: black Formatted with: isort Checked with mypy

About

The telegram-user-bot is a versatile and user-friendly integration tool designed for Suvvy AI, enabling seamless interaction between Telegram and Suvvy AI. It stands out for its ease of use, customizability, and the ability to streamline communication workflows efficiently.

Prerequisites

Before you begin, ensure you have the following installed:

  • Docker
  • Docker Compose
  • Basic understanding of Telegram user-bots and Docker Compose.

Installation using Docker Compose

Use Docker Compose for a quick and straightforward setup:

  1. Create a Dotenv File: Refer to the Configuration section to create a .env file with a Suvvy AI API key.
  2. Create a Pyrogram Session: Use barabum0/pyroauth to create a session file named client.session.
  3. Download docker-compose.yml File:
    • With wget:
      wget https://raw.githubusercontent.com/suvvyai/telegram-user-bot/main/docker-compose.yml
    • Manually: docker-compose.yml
  4. Start the Service:
    docker-compose up -d  # or docker compose up -d

Configuration

Create and customize your .env:

wget https://github.com/suvvyai/telegram-user-bot/blob/main/.env.example -O .env
nano .env
SESSION_NAME=client
SUVVY_API_KEY=<Your Suvvy AI API key goes here>
TIMEOUTS__BEFORE_READ_SECONDS=0
TIMEOUTS__BEFORE_ANSWER_SECONDS=0

Troubleshooting

If you encounter issues, open an issue in the GitHub repository.

Contributing

Contributions are welcome. Please fork the repository, make your changes, and submit a pull request.

License

This project is under the MIT License - see the LICENSE file for details.

Contact

For queries or suggestions, feel free to open an issue in the GitHub repository.