Warner-Me API

Warner-Me is a Rest API that sends a notification via Telegram to programmers who are waiting for the code they ran to finish. Therefore, you can learn your code status and your results.

Requirements

requirements.txt file contains all the necessary packages for the development of Warner-Me API.

You just need to requests package for usage.

Usage

Firstly you need to register in Warner-Me database by using Telegram Bot.

You can find our bot by searching it 'WARNMEE_BOT' or by QR Code

Then you can type /help to get detailed information

/register you can register in Warner-Me database. Your code status is inactive and your results are empty by default.

/id you can learn your id

Once you learnt the id, you can use Warner-Me Api

import requests

BASE = "https://warnerme-bot-api.onrender.com/" #Adress of our API

response = requests.get(BASE + "warnMe/your_id", {}) # You can get current information. your_id is id that was taken by Warner-Me Telegram Bot.
print(response.json()) # You can print the current information

requests.patch(BASE + "warnMe/your_id", {'codeStatus':'active', 'results':''}) #patch updates your code status and results. Before running a code script you can change it as active.
"""
YOUR CODE HERE:

For instance model.fit() or any other script.
"""
requests.post(BASE + "warnMe/your_id", {'codeStatus':'inactive', 'results':'acc:0.9, f1:0.6'}) #post also updates your code states and results. The only difference between patch and post is that post will inform you on Telegram automatically when your process is done.

Warner-Me provides 2 information areas for you: CodeStatus and results. These can be used in any way you like. Both fields should be strings, and they should be used inside a dictionary as shown in the example.

requests.post(BASE + "warnMe/your_id", {'codeStatus':'SOME STRING HERE', 'results':'SOME STRING HERE'}) #You can write what ever you want for your codeStatus and results.

You can use other languages than Python by using same pattern.