Merge pull request avinashkranjan#408 from vybhav72954/iss_116

Added a COVID-19 Bot for WhatsApp

Author: avinashkranjan

Whatsapp_COVID-19_Bot/.env.example

@@ -0,0 +1,3 @@
+SID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+NUM="+91XXXXXXXXXX"

Whatsapp_COVID-19_Bot/README.md

@@ -0,0 +1,78 @@
+# WhatsApp COVID-19 Bot
+
+A COVID-19 Bot build using `Twilio API`, that tracks the Number of Infected persons, Recovered Persons and Number of
+Total deaths along with the day-to-day increase in the statistics. The information is then updated via WhatsApp.
+
+## Note
+
+The script requires personal info, like `API-Token`, `API-ID`, and `PHONE-NUMBER`
+for that reason, a [`.env`](.env.example) file has been used, for more info, see usage.
+
+## Usage
+
+- Setup a Virtual Environment.
+- Download dependencies using `pip install -r requirements.txt`.
+- Set up an account at [`Twilio`](https://www.twilio.com/). It's Free.
+- Follow 
+  [this guide](https://medium.com/hackernoon/how-to-send-whatsapp-message-using-python-and-twilio-api-fc63f62154ca)
+  for Setting up WhatsApp API.  
+- Make a `.env` file similar to `.env.example` file.
+- Paste the required information:
+
+    ```text
+    SID="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" <ACCOUNT SID goes here>
+    TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" <AUTH TOKEN>
+    NUM="+91XXXXXXXXXX" <TARGET PHONE NUMBER GOES HERE>
+    ```
+
+- The bot script is now ready.
+- For scheduling, [`apscheduler`](https://apscheduler.readthedocs.io/en/stable/)
+  has been used for cron-style scheduling.
+- The script is coded to run the bot once every day.  
+- For making your own cron schedule, use this [website](https://crontab.guru/).
+- After setting up the Cron Job, run the scheduler script using `python3 schedule.py`.
+
+## Output
+
+![](https://i.postimg.cc/GpmVJrJt/Whats-App-Image-2021-02-27-at-20-18-13.jpg)
+
+Sample Message
+
+```text
+Last Updated on: 2021-02-27
+Top 3 Indian States sorted by Newly registered cases of COVID-19.
+    [Maharashtra]
+    |   Total Infected = 68810
+    |   New Infections =  3349
+    |   Total Recovery = 2017303
+    |   New Recovery = 4936
+    |   Total Deaths = 52041
+    |   New Deaths = 48
+    
+    [Punjab]
+    |   Total Infected = 4222
+    |   New Infections =  352
+    |   Total Recovery = 170968
+    |   New Recovery = 255
+    |   Total Deaths = 5814
+    |   New Deaths = 15
+    
+    [Gujarat]
+    |   Total Infected = 2136
+    |   New Infections =  145
+    |   Total Recovery = 262487
+    |   New Recovery = 315
+    |   Total Deaths = 4408
+    |   New Deaths = 0
+```
+
+## Author(s)  
+
+Made by [Vybhav Chaturvedi](https://www.linkedin.com/in/vybhav-chaturvedi-0ba82614a/)
+
+### Disclaimer
+
+Kindly follow all the guidelines of Twilio and respect the request rate.
+
+Despite the recent downfall in cases, COVID-19 is still a major threat for all of us, I strongly request you to follow
+all the necessary guidelines.

Whatsapp_COVID-19_Bot/covid_bot.py

@@ -0,0 +1,65 @@
+# IMPORTS
+
+from twilio.rest import Client
+import pandas as pd
+import requests
+from datetime import datetime
+import decouple
+
+# Twilio Details
+account_sid = decouple.config("SID")  # please change it to your own
+auth_token = decouple.config("TOKEN")  # please change it to your own
+client = Client(account_sid, auth_token)
+
+
+def send_message(receiver, message):
+    """
+    Send message to receivers using the Twilio account.
+    :param receiver: Number of Receivers
+    :param message: Message to be Sent
+    :return: Sends the Message
+    """
+    message = client.messages.create(
+        from_='whatsapp:+14155238886',
+        body=message,
+        to=f'whatsapp:{receiver}'
+    )
+    return message
+
+
+# The list of Receivers, setup the .env file accordingly for maximum safety. See README
+receiver_list = [decouple.config("NUM")]
+
+# Covid Report of India. See README fir Info.
+url = "https://api.apify.com/v2/key-value-stores/toDWvRj1JpTXiM8FF/records/LATEST?disableRedirect=true"
+data_json = requests.get(url).json()
+
+# Reading the Information form JSON data.
+df = []
+for row in range(len(data_json["regionData"])):
+    df.append(data_json["regionData"][row])
+df = pd.DataFrame(df)
+# Sorted top 3 states according to New-Infections
+data = df.sort_values(['newInfected'], ascending=False)[:3]
+
+
+# Final Message to be sent
+region_name = data["region"].tolist()
+current_timestamp = str(datetime.now().date())
+messages = f"Last Updated on: {current_timestamp}\n" \
+           f"Top 3 Indian States sorted by Newly registered cases of COVID-19."
+for regions in region_name:
+    each_row = data[data["region"] == regions]
+
+    # The Information contained in the message.
+    message_partition = f"""
+    [{regions}]
+    |   Total Infected = {str(each_row['totalInfected'].tolist()[0])}
+    |   New Infections =  {str(each_row['newInfected'].tolist()[0])}
+    |   Total Recovery = {str(each_row['recovered'].tolist()[0])}
+    |   New Recovery = {str(each_row['newRecovered'].tolist()[0])}
+    |   Total Deaths = {str(each_row['deceased'].tolist()[0])}
+    |   New Deaths = {str(each_row['newDeceased'].tolist()[0])}
+    """
+
+    messages = messages + message_partition

Whatsapp_COVID-19_Bot/requirements.txt

@@ -0,0 +1,5 @@
+python-decouple==3.4
+twilio==6.41.0
+pandas==0.25.3
+requests==2.22.0
+apscheduler==3.6.3

Whatsapp_COVID-19_Bot/schedule.py

@@ -0,0 +1,21 @@
+# Imports
+
+from apscheduler.schedulers.blocking import BlockingScheduler
+from covid_bot import *
+
+scheduler = BlockingScheduler()
+
+
+def bot_schedule():
+    """
+    A scheduler for the covid_bot script
+    """
+    for numb in receiver_list:
+        print(f"sending message to {numb}")
+        send_message(numb, messages)
+
+
+# The Job is scheduled for once a day.
+# The event is triggered at 5:30AM IST (Midnight UTC)
+scheduler.add_job(bot_schedule, 'cron', days='*/1')
+scheduler.start()