vyahello / guess-the-melody

🎵 Guess the melody telegram bot quiz (python + sqlite3 + telegramapi + travisCI)

Guess the melody quiz

Simple quiz telegram bot game written in python.

Tools

Production

• python 3.6, 3.7, 3.8
• pyTelegramBotAPI library

Development

• pytest
• flake8
• black
• travis

Usage

Prerequisites

Please follow instructions to be able to use a bot:

• Create own bot via telegram app
• Obtain API key from @botfather via telegram app
• Specify your telegram API key in config.py

Quick start

python -m quiz

⬆ back to top

Development notes

Project has Travis CI integration using .travis.yml file thus code analysis (black) and unittests (pytest) will be run automatically after every made change to the repository.

To be able to run code analysis, please execute command below:

./analyse-code.sh

Release notes

Please check CHANGELOG file to get more details about actual versions and it's release notes.

Meta

Author – Volodymyr Yahello. Please check AUTHORS to see all contributors.

Distributed under the MIT license. See LICENSE for more information.

You can reach out me at:

• [e-mail]
• https://twitter.com/vyahello
• https://www.linkedin.com/in/volodymyr-yahello-821746127

Contributing

1. clone the repository
2. configure Git for the first time after cloning with your name and email
3. pip install -r requirements.txt to install all project dependencies
4. pip install -r requirements-dev.txt to install all dev project dependencies

⬆ back to top