quiz-bots 0.2.2

Quiz bots for TG and VK

Bots for quiz

Description

This repository contains Vk and TG bots for the quiz. They get used to the questions and check the correctness of the answers to them.

Bot examples:

• Tg bot
• Vk bot - write a message "Новый вопрос" to the group

Table of content

• Installation
• How to use
• License
• Project goal

Installation

• Install using pip:

  pip install quiz-bots
  

• Create a bot in Telegram via BotFather, and get it API token.

• Create redis account in Redislabs, and after that create cloud database (you can choose free plan). Get your endpoint database url and port.

• Create VK's group, allow it send messages, and get access token for it.

• Register environment variables in the operating system:

  export TELEGRAM_TOKEN=telegram_token
  export DB_ENDPOINT=redis endpoint
  export DB_PASSWORD=redis_password
  export VK_GROUP_TOKEN=token_vkontakte
  

• Put the question files in a folder(sample files are in the repository folder quiz_files_example) and export quiz content to Redis:

  quiz-bots export_quiz_content [path_to_questions_folder]
  

How to use

Run TG bot:

quiz-bots tg-bot

Run VK bot:

quiz-bots vk-bot

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Project Goal

The code is written for educational purposes on online-course for web-developers dvmn.org.