Metadata-Version: 2.1
Name: quiz-bots
Version: 0.1.1
Summary: 
Home-page: https://github.com/velivir/quiz-bots
Author: Vitaliy Antonov
Author-email: vitaliyantonoff@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: environs (>=7.4.0,<8.0.0)
Requires-Dist: python-telegram-bot (>=12.7,<13.0)
Requires-Dist: redis (>=3.5.1,<4.0.0)
Requires-Dist: vk-api (>=11.8.0,<12.0.0)
Project-URL: Repository, https://github.com/velivir/quiz-bots
Description-Content-Type: text/markdown

# Bots for quiz

<p align="center">
  <a href="https://link_to_docs">
    <img width="400"
         src="https://sales-generator.ru/upload/resize_cache/iblock/bf9/790_395_2/bf9b6fa5187139c2dfc9819ec3115848.jpg"
         alt="Bots for quiz" />
  </a>
</p>

[![Build Status](https://travis-ci.com/velivir/quiz-bots.svg?branch=master)](https://travis-ci.com/velivir/quiz-bots)
[![Maintainability](https://api.codeclimate.com/v1/badges/7bfc3ff61843cbf93a51/maintainability)](https://codeclimate.com/github/velivir/quiz-bots/maintainability)
![GitHub](https://img.shields.io/github/license/velivir/quiz-bots)
![Platform](https://img.shields.io/badge/platform-linux-brightgreen)
[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](https://github.com/wemake-services/wemake-python-styleguide)


## How to install

1. Create a bot in Telegram @via BotFather, and get it API token.
2. Create redis account in [Redislabs](https://redislabs.com/), and after that create [cloud database](https://docs.redislabs.com/latest/rc/quick-setup-redis-cloud/) (you can choose free plan).
Get your endpoint database url and port.
3. Create VK's group, allow it send messages, and get access token for it.
5. Put all necessary parameters to .env file.

```
TG_TOKEN=telegram_token
DB_ENDPOINT=redis endpoint
DB_PASSWORD=redis_password
VK_GROUP_TOKEN=token_vkontakte
VK_GROUP_ID=
```

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/vitaliy-antonov/quiz-bots/blob/master/LICENSE) file for details


## Project Goals

The code is written for educational purposes on online-course for
web-developers [dvmn.org](https://dvmn.org/).

