Chatbot-For-Studying

Удивительный чат-бот для классов/учебных групп!

Сообщить об ошибках

Содержание:

1. О проекте
   • Разработано с помощью
   • Функционал
2. Начало работы
   • Настройка
   • Добавление администратора
   • Настройка еженедельного скрипта
3. Использование
4. Лицензия
5. Контакты

О проекте

Проект представляет собой реализацию быстрого и простого доступа к расписанию занятий и домашнему заданию на определённый день. Администратору бота доступен расширенный функционал - добавление, удаление и редактирование домашнего задания.

Проект выполнен в виде чат-бота на платформе «ВКонтакте» – это очень удобное решение, так как у пользователей нет необходимости скачивать какой-либо посторонний софт, практически все они зарегистрированы в этой социальной сети, а значит получить доступ к боту не составит труда.

Чтобы посмотреть пример работы бота нажмите сюда.

Функционал

• Просмотр расписания на определённый день
• Просмотр домашнего задания на определённый день
• Добавление домашнего задания
• Редактирование домашнего задания (изменение самого задания, либо смена даты его сдачи)
• Удаление домашнего задания

Разработано с помощью

• vk_api
• Loguru

Начало работы

Это пример того, как вы можете локально настроить проект. Чтобы запустить чат-бота, следуйте этим простым указаниям.

Настройка и запуск

1. Клонируйте репозиторий и зайдите в его директорию

   $ git clone https://github.com/3x0d2s/chatbot-for-studying.git
   $ cd chatbot-for-studying

2. Установите необходимые для работы чат-бота библиотеки одной командой

   $ pip3 install -r requirements.txt

3. Скопируйте файл bot/config/initial_config.py в файл bot/config/config.py

   $ cp bot/config/initial_config.py bot/config/config.py

4. Раскомментируйте строки токена и id вашей группы и заполните их своими значениями в файле bot/config/config.py. Вот так должно получиться:

   TOKEN = "YOUR_API_TOKEN"
   GROUP_ID = 'YOUR_GROUP_ID'

   В сообществе должна быть выбрана Long Poll - 5.80 Подробнее про получение токена тут
5. Откройте файл bot/db/db_dump.sql и заполните его своим расписаем подобно тому, как оно заполнено изначально
6. Запустите файл bot/main.py

   $ python3 bot/main.py

Добавление администратора

Чтобы сделать определённого пользователя администратором, в базе данных в таблице "users" необходимо у этого пользователя изменить значение флага "isAdmin" - замените "0" на "1".

Настройка еженедельного скрипта

Еженедельных скрипт bot/scripts/newWeekScript.py очищает БД от старого домашнего задания, предварительно делая бэкап. Чтобы настроить его еженедельное выполнение на сервере, воспользуйтесь cron.

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

Лицензия

Распространяется по лицензии MIT. См. LICENSE.md для дополнительной иформации.

Контакты

Максим Жданов (разработчик) - по всем вопросам отвечу тут --> @ex0d2s