Metadata-Version: 2.3
Name: tg-feedback-bot-ru
Version: 0.4.3
Summary: Telegram feedback bot that routes user messages to administrators.
Author: Gleb Chipiga
License: MIT License
         
         Copyright (c) 2018-2025 Gleb Chipiga
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Intended Audience :: Customer Service
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Internet
Classifier: Topic :: Communications :: Chat
Classifier: Framework :: AsyncIO
Requires-Dist: aiorunner>=0.2.5,<0.3.0
Requires-Dist: aiojobs>=1.4.0,<2.0.0
Requires-Dist: aiotgbot[sqlalchemy]>=0.18.8,<0.19.0
Requires-Dist: more-itertools>=10.8.0,<11.0.0
Requires-Dist: msgspec>=0.20.0,<0.21.0
Requires-Dist: pydantic>=2.12.4,<3.0.0
Requires-Dist: pydantic-settings>=2.12.0,<3.0.0
Requires-Dist: sqlalchemy[postgresql-asyncpg]>=2.0.44,<3.0.0
Requires-Dist: uvloop>=0.22.1,<0.23.0
Requires-Python: >=3.13, <3.14
Project-URL: Homepage, https://github.com/gleb-chipiga/tg-feedback-bot-ru
Project-URL: Issues, https://github.com/gleb-chipiga/tg-feedback-bot-ru/issues
Project-URL: Repository, https://github.com/gleb-chipiga/tg-feedback-bot-ru
Description-Content-Type: text/markdown

# tg-feedback-bot-ru

Телеграм‑бот для обработки пользовательских обращений: принимает сообщения из личных чатов, пересылает их администраторам и позволяет отвечать пользователям из приватных и групповых чатов. Хранение состояния всегда выполняется в PostgreSQL (SQLAlchemy + aiotgbot storage).

## Требования

- Python 3.13+
- PostgreSQL для хранения состояния

## Переменные окружения

Приложение полностью конфигурируется через env vars (см. `src/tg_feedback_bot_ru/settings.py`). Подготовьте файл `.env` или используйте пример `bot_env.example`.

| Переменная      | Назначение                                                                 |
|-----------------|-----------------------------------------------------------------------------|
| `TZ`            | Часовой пояс процесса (`Europe/Moscow`, `UTC` и т.д.).                      |
| `TG_TOKEN`      | Bot API token. Можно передать напрямую или через Docker secret.            |
| `ADMIN_USERNAME`| Telegram username администратора без `@`.                                   |
| `CHAT_LIST_SIZE`| Размер списка последних чатов для быстрых ответов (1–20).                   |
| `POSTGRES_DSN`  | DSN PostgreSQL в формате SQLAlchemy async (`postgresql+asyncpg://…`).       |

Все переменные обязательны (для `CHAT_LIST_SIZE` и `POSTGRES_DSN` есть значения по умолчанию, но в проде лучше задавать их явно).

## Локальная разработка

```bash
uv sync --group dev
uv run python -m tg_feedback_bot_ru
```

Полезные команды:

- `uv run ruff format --check src/tg_feedback_bot_ru`
- `uv run ruff check src/tg_feedback_bot_ru`
- `uv run mypy src/tg_feedback_bot_ru`
- `uv run basedpyright`

## Docker

Официальный образ собирается GitHub Actions из опубликованной версии PyPI. Локально можно:

```bash
docker build --build-arg BOT_VERSION=0.3.0 -t tg-feedback-bot-ru:0.3.0 .
docker run --env-file bot_env.example tg-feedback-bot-ru:0.3.0
```

В проде используйте образ `ghcr.io/gleb-chipiga/tg-feedback-bot-ru:<tag>` (теги совпадают с `v*` релизами). Он ожидает переменные окружения из таблицы выше и запускает консольный скрипт `tg-feedback-bot-ru`.
