smart-bot-factory 2.0.1

Библиотека для создания умных чат-ботов

Smart Bot Factory

Smart Bot Factory — это Python CLI и библиотека для создания Telegram AI-ботов с OpenAI, aiogram, персистентностью через Supabase, CRM-интеграциями и опциональными RAG-бэкендами.

Установка

Установите пакет из PyPI:

pip install smart-bot-factory

Опционально: для изоляции окружения сначала создайте и активируйте виртуальное окружение (python -m venv .venv и source .venv/bin/activate), затем выполните pip install.

Проект требует Python >= 3.10.

Быстрый старт

1. Проверьте точку входа CLI:

sbf --help

2. Создайте каркас бота:

sbf create clinic-bot

Команда создаст bots/clinic-bot/ с каркасом для prompt, message, test, file и .env.

3. Заполните обязательные значения в bots/clinic-bot/.env, особенно TELEGRAM_BOT_TOKEN и OPENAI_API_KEY.

4. Запустите бота:

sbf run clinic-bot

Примеры использования

Управление проектами ботов

С помощью sbf CLI можно просматривать, копировать, диагностировать, тестировать и удалять проекты ботов:

sbf list
sbf copy clinic-bot clinic-bot-staging
sbf doctor clinic-bot
sbf test clinic-bot
sbf update
sbf env-sync clinic-bot
sbf rm clinic-bot-staging

Обновление CLI (sbf update)

Команда sbf update работает только в локальном проекте с существующим .venv и завершится с явной ошибкой, если .venv отсутствует.

sbf update

Регистрация бизнес-событий

Сгенерированные лаунчеры ботов используют BotBuilder и EventRouter, чтобы подключать пользовательские бизнес-действия, которые ассистент может вызывать из структурированных AI-метаданных:

from smart_bot_factory.creation import BotBuilder
from smart_bot_factory.message import send_message_by_human
from smart_bot_factory.router import EventRouter

event_router = EventRouter()
bot_builder = BotBuilder()


@event_router.event_handler(once_only=True)
async def collect_contact(user_id: int, contact_data: str) -> dict[str, str]:
    await send_message_by_human(
        user_id=user_id,
        message_text=f"Thanks, your contact is saved: {contact_data}",
    )
    return {"status": "success", "contact": contact_data}


bot_builder.register_routers(event_router)

Документация

• Начало работы: docs/GETTING-STARTED.md
• Архитектура: docs/ARCHITECTURE.md
• Конфигурация: docs/CONFIGURATION.md
• Тестирование: docs/TESTING.md
• Процесс разработки: docs/DEVELOPMENT.md
• Деплой: docs/DEPLOYMENT.md
• Устранение неполадок: docs/troubleshooting.md

Лицензия

Проект распространяется по лицензии MIT License.