https://github.com/dextiles/async-tg-bot-template
Template for an asynchronous Telegram bot using the pyTelegramBotAPI library with support for deployment via Docker.
https://github.com/dextiles/async-tg-bot-template
async asynchronous bot-template docker docker-compose pytelegrambotapi python telegram telegram-bot telegram-bot-template template templates
Last synced: about 1 year ago
JSON representation
Template for an asynchronous Telegram bot using the pyTelegramBotAPI library with support for deployment via Docker.
- Host: GitHub
- URL: https://github.com/dextiles/async-tg-bot-template
- Owner: Dextiles
- License: mit
- Created: 2025-03-19T23:18:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-19T23:42:11.000Z (about 1 year ago)
- Last Synced: 2025-03-20T00:28:36.719Z (about 1 year ago)
- Topics: async, asynchronous, bot-template, docker, docker-compose, pytelegrambotapi, python, telegram, telegram-bot, telegram-bot-template, template, templates
- Language: Python
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Архитектура асинхронного телеграм-бота
[Русский](#архитектура-асинхронного-телеграм-бота) | [English](#asynchronous-telegram-bot-architecture)
## Описание
Этот проект представляет собой асинхронного телеграм-бота, написанного на Python с использованием библиотеки `pyTelegramBotAPI`. Бот поддерживает бесконечное опросное взаимодействие и имеет возможность установки команд по умолчанию.
## Установка
Для установки и запуска бота выполните следующие шаги:
1. Клонируйте репозиторий:
```sh
git clone
cd <название репозитория>
```
2. Создайте файл `.env` в корне проекта и добавьте в него ваш токен телеграм-бота:
```env
BOT_TOKEN="ваш_токен"
```
Подробнее изучите шаблон файла `.env.template`.
### Вариант с Docker
3. Соберите и запустите контейнер Docker:
```sh
docker build -t telegram-bot .
docker run --env-file .env telegram-bot
```
### Вариант без Docker
3. Создайте и активируйте виртуальное окружение:
```sh
python -m venv venv
source venv/bin/activate # Для Windows используйте `venv\Scripts\activate`
```
4. Установите зависимости:
```sh
pip install -r requirements.txt
```
5. Запустите бота:
```sh
cd bot
python main.py
```
## Функционал
- **Асинхронная работа**: Бот работает асинхронно, что позволяет ему обрабатывать несколько запросов одновременно.
- **Установка команд по умолчанию**: При запуске бота устанавливаются команды по умолчанию, которые могут быть использованы пользователями.
- **Бесконечное опросное взаимодействие**: Бот постоянно опрашивает сервер Telegram на наличие новых сообщений и обрабатывает их.
## Лицензия
Этот проект лицензирован по лицензии MIT. Подробности можно найти в файле `LICENSE`.
---
# Asynchronous Telegram Bot Architecture
[Русский](#архитектура-асинхронного-телеграм-бота) | [English](#asynchronous-telegram-bot-architecture)
## 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:
```sh
git clone
cd
```
2. Create a `.env` file in the root of the project and add your Telegram bot token:
```env
BOT_TOKEN="your_token"
```
See the `.env.template` file for more details.
### Docker Option
3. Build and run the Docker container:
```sh
docker build -t telegram-bot .
docker run --env-file .env telegram-bot
```
### Non-Docker Option
3. Create and activate a virtual environment:
```sh
python -m venv venv
source venv/bin/activate # For Windows use `venv\Scripts\activate`
```
4. Install dependencies:
```sh
pip install -r requirements.txt
```
5. Run the bot:
```sh
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.