Giter Club home page Giter Club logo

devman-api's Introduction

Devman API bot

screenshot

Назначение

Телеграм бот для проверки статуса работ отправленных на проверку в рамках обучения на сайте Devman. В случае изменения статуса проверки, бот присылает об этом уведомление в телеграм.

Подготовка к запуску, настройка окружения

Для запуска Вам понадобится установленный Python версии 3.10

Скачайте код с GitHub. Затем установите зависимости командой

pip install -r requirements.txt

Используйте как образец .env.example чтобы создать в той же папке файл .env и сохранить параметры в нем. Минимально необходимо задать токен бота полученный у BotFather

Запуск и использование бота

Бот можно исполоьзовать в режиме консольного запуска, либо режиме интерактивного диалога в чате телеграм.

Режим консольного запуска

Можно запусть бота для получения списка работ командой:

python review_list.py <Devman API token> <ChatID>

Можно запустить наблюдение за изменением статуса проверки работ:

python polling.py <Devman API token> <ChatID>

Режим диалогового бота

Запустите бота командой:

python bot.py

После запуска добавьте себе в контакт лист телеграм бота, используя имя указанное при регистрации в BotFather и отправьте ему свой Devman API token командой:

/start <Devman API token>

После регистрации токена Вы сможете использовать команды /list и /polling для запуска соответствующих проверок.

Кроме этих команд доступна команда /help для получения справки о командах и команда /forget для удаления токена и возврата к началу работы с ботом.

Запуск с использованием Docker

Вы можете запустить проект в докер-контейнере (docker должен быть установлен на Вашей машине):

Не забудьте перед запуском указать ваш токен бота как указано в разделе Настройка параметров

Вариант production

Сначала соберите образ контейнера командой:

docker build -t dvmn_bot:prod .

Затем запустите собранный образ командой:

docker run --name dvmn_bot --env-file .env -d --restart  always dvmn_bot:prod

Вариант development

Сначала соберите образ контейнера командой:

docker build -f Dockerfile.devel -t dvmn_bot:devel .

Затем запустите собранный образ командой:

docker run --rm --name dvmn_bot_test -v ${PWD}:/usr/src/app -d dvmn_bot:devel

Существующий экземпляр бота

Вы можете воспользоваться (как для ознакомления, так и для использования) полностью работающим экземпляром бота Devman review checker

Цели проекта

Код написан в учебных целях — это урок в рамках курса по Python и веб-разработке на сайте Devman.

devman-api's People

Contributors

alexwoif avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.