Skip to content

CryptoX3trove/Async-tg-bot-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Архитектура асинхронного телеграм-бота

Русский | English

Описание

Этот проект представляет собой асинхронного телеграм-бота, написанного на Python с использованием библиотеки pyTelegramBotAPI. Бот поддерживает бесконечное опросное взаимодействие и имеет возможность установки команд по умолчанию.

Установка

Для установки и запуска бота выполните следующие шаги:

  1. Клонируйте репозиторий:

    git clone <URL вашего репозитория>
    cd <название репозитория>
  2. Создайте файл .env в корне проекта и добавьте в него ваш токен телеграм-бота:

    BOT_TOKEN="ваш_токен"

    Подробнее изучите шаблон файла .env.template.

Вариант с Docker

  1. Соберите и запустите контейнер Docker:
    docker build -t telegram-bot .
    docker run --env-file .env telegram-bot

Вариант без Docker

  1. Создайте и активируйте виртуальное окружение:

    python -m venv venv
    source venv/bin/activate  # Для Windows используйте `venv\Scripts\activate`
  2. Установите зависимости:

    pip install -r requirements.txt
  3. Запустите бота:

    cd bot
    python main.py

Функционал

  • Асинхронная работа: Бот работает асинхронно, что позволяет ему обрабатывать несколько запросов одновременно.
  • Установка команд по умолчанию: При запуске бота устанавливаются команды по умолчанию, которые могут быть использованы пользователями.
  • Бесконечное опросное взаимодействие: Бот постоянно опрашивает сервер Telegram на наличие новых сообщений и обрабатывает их.

Лицензия

Этот проект лицензирован по лицензии MIT. Подробности можно найти в файле LICENSE.


Asynchronous Telegram Bot Architecture

Русский | English

Description

This project is an asynchronous Telegram bot written in Python using the pyTelegramBotAPI library. The bot supports infinite polling interaction and has the ability to set default commands.

Installation

To install and run the bot, follow these steps:

  1. Clone the repository:

    git clone <your-repository-url>
    cd <repository-name>
  2. Create a .env file in the root of the project and add your Telegram bot token:

    BOT_TOKEN="your_token"

    See the .env.template file for more details.

Docker Option

  1. Build and run the Docker container:
    docker build -t telegram-bot .
    docker run --env-file .env telegram-bot

Non-Docker Option

  1. Create and activate a virtual environment:

    python -m venv venv
    source venv/bin/activate  # For Windows use `venv\Scripts\activate`
  2. Install dependencies:

    pip install -r requirements.txt
  3. Run the bot:

    cd bot
    python main.py

Features

  • Asynchronous operation: The bot works asynchronously, allowing it to handle multiple requests simultaneously.
  • Setting default commands: When the bot starts, default commands are set, which can be used by users.
  • Infinite polling interaction: The bot constantly polls the Telegram server for new messages and processes them.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Template for an asynchronous Telegram bot using the pyTelegramBotAPI library with support for deployment via Docker.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors