omeh2003 / FeinmanBot

This project is a Telegram bot designed to emulate Richard Feynman's learning method. The bot tutors the user on a chosen topic over a specified number of iterations, using OpenAI's API to gather information.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Feynman Learning Bot

Описание

Этот проект представляет собой бота для Telegram, который имитирует метод обучения Ричарда Фейнмана. Бот учит пользователя на выбранную тему за указанное количество итераций, используя API OpenAI для получения информации.

Установка и запуск

Использование Docker

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

    git clone https://github.com/omeh2003/FeinmanBot.git
  2. В корневой директории проекта создайте файл .env и добавьте следующие строки, заменив your_telegram_token и your_openai_token на соответствующие токены:

    TELEGRAM_TOKEN=your_telegram_token
    OPENAI_TOKEN=your_openai_token
    

    Внимание! Никогда не делитесь своими токенами и не публикуйте их в открытом доступе.

  3. Используйте Docker Compose для сборки и запуска контейнера:

    docker-compose up --build

После запуска бот будет слушать новые сообщения в Telegram и будет готов к обучению на выбранную тему.

Использование Python

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

    git clone https://github.com/omeh2003/FeinmanBot.git
  2. Установите необходимые зависимости:

    pip install -r requirements.txt
  3. В корневой директории проекта создайте файл .env и добавьте следующие строки, заменив your_telegram_token и your_openai_token на соответствующие токены:

    TELEGRAM_TOKEN=your_telegram_token
    OPENAI_TOKEN=your_openai_token
    

    Внимание! Никогда не делитесь своими токенами и не публикуйте их в открытом доступе.

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

    python bot.py

После запуска бот будет слушать новые сообщения в Telegram и будет готов к обучению на выбранную тему.

Взаимодействие с ботом

Чтобы начать обучение, напишите боту в чате и следуйте его инструкциям. Бот спросит вас о теме для обучения и о количестве итераций, которые вы хотите провести.

Зависимости

  • Python 3.10
  • Aiogram 3.0
  • OpenAI 0.27.0
  • python-dotenv 0.19.1

Лицензия

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

About

This project is a Telegram bot designed to emulate Richard Feynman's learning method. The bot tutors the user on a chosen topic over a specified number of iterations, using OpenAI's API to gather information.

License:MIT License


Languages

Language:Python 90.9%Language:Dockerfile 9.1%