🎯 Target Assistant Bot Documentation

Версия: v0.2.4 | Лицензия: MIT | GitHub: bivlked/target-assistant-bot

—

📋 Содержание

API документация

• Core Package
  • BotError
  • LLMError
  • RateLimitExceeded
  • StorageError
  • GoalManager
  • AsyncLLMInterface
  • AsyncStorageInterface
  • LLMInterface
  • StorageInterface
• Handlers Package
  • cancel_handler()
  • cancel_reset()
  • confirm_reset()
  • help_handler()
  • reset_handler()
  • start_handler()
  • unknown_handler()
  • build_setgoal_conv()
  • cancel_check()
  • check_command()
  • choose_goal()
  • get_task_handlers()
  • motivation_command()
  • quick_status_update()
  • status_command()
  • today_command()
  • update_task_status()
• Scheduler Package
  • Scheduler
• Utils Package
  • SheetCache
  • cached_sheet_method()
  • invalidate_sheet_cache()
  • escape_markdown_v2()
  • format_date()
  • get_day_of_week()
  • setup_logging()
  • parse_period()
  • RateLimitException
  • TokenBucket
  • UserRateLimiter
  • setup_sentry()

🚀 О проекте

Target Assistant Bot — это персональный Telegram-ассистент, который помогает:

• 🎯 Формулировать четкие цели

• 📅 Разбивать их на ежедневные задачи

• 📊 Отслеживать прогресс достижения

• 💪 Поддерживать мотивацию

Все данные хранятся в Google Sheets, а планирование и мотивационные сообщения генерируются с помощью OpenAI GPT-4.

✨ Ключевые возможности

Команда	Описание
/start	🚀 Начать работу с ботом
/help	ℹ️ Справка по доступным командам
/setgoal	🎯 Установить новую цель
/today	📅 Задача на сегодня
/check	✍️ Отметить выполнение задачи
/status	📊 Посмотреть прогресс
/motivation	💡 Получить мотивацию
/reset	🗑️ Сбросить все цели

🏗️ Архитектура

Проект построен на современной асинхронной архитектуре:

• Асинхронность: Все компоненты работают через asyncio

• DI: Dependency Injection через интерфейсы

• Кэширование: Google Sheets данные кэшируются в памяти

• Rate Limiting: Защита от превышения лимитов API

• Мониторинг: Prometheus метрики и Sentry для ошибок

📊 Статистика проекта

• Покрытие тестами: 98.62% ✅

• Поддерживаемые Python: 3.12+ (рекомендуется 3.12)

• Основные зависимости:

  • python-telegram-bot 22.0

  • openai 1.77+

  • gspread 6.0.2

  • APScheduler 3.11.0

🔗 Полезные ссылки

• GitHub репозиторий

• Руководство по установке

• Чек-лист разработки

• Issues и баг-репорты

📝 Индексы и таблицы

• Алфавитный указатель

• Состав модуля

• Поиск