Adding Documentation

Author: RusherRG

automate.py

@@ -4,19 +4,25 @@
 from mail import sendmail
 import json
 
+# Scraping the webpage and storing the data in a csv
 data = scraper('http://automatescrape.surge.sh/')
 write_csv(data)
 
+# Reading the scraped data from the csv and preprocessing the data
 participants = read_csv()
 participants = preprocess(participants)
 
+# Getting the list of mails to whom mails have already been sent 
 sent_mails = read_file()
-mails = []
 
+# Looping over all participants
 for participant in participants:
+    # Checking if the participant was sent a mail previously
     if participant['email'] not in sent_mails:
+        # Generating a message from the template 
         msg = _render_template(participant['name'], participant['payment'])
+        # Sending the message to the participant via mail
         response = sendmail(to_email=participant['email'], msg=msg)
         if response['email_status'] == "Success":
-            mails.append(participant['email'])
+            # if mail was sent successfully append the email to sentmails.txt
             write_file(participant['email'])

file_utils.py

@@ -2,7 +2,9 @@
 
 
 def read_csv():
+    # opening the file in read mode
     with open("studentdetails.csv", 'r') as csv_file:
+        # reading the csv
         csv_reader = csv.reader(csv_file, delimiter=',')
         data = []
         for row in csv_reader:
@@ -11,18 +13,22 @@ def read_csv():
 
 
 def write_csv(data):
+    # opening the file in write mode
     with open("studentdetails.csv", 'w') as csv_file:
+        # writing to the csv
         csv_writer = csv.writer(csv_file, delimiter=',')
         for row in data:
             csv_writer.writerow(row)
 
 
 def read_file():
+    # opening the file in read mode and reading lines
     with open("sentmails.txt", 'r') as f:
         sent_mails = f.readlines()
     return sent_mails
 
 
 def write_file(mail):
+    # opening the file in append mode and appending the mail at the end
     with open("sentmails.txt", 'a') as f:
         f.write(mail + "\n")

generate.py

@@ -3,18 +3,22 @@
 
 
 def _render_template(name, payment_status):
+    # loading the templates folder
     file_loader = FileSystemLoader('templates')
     env = Environment(
         loader=file_loader,
         trim_blocks=True,
         lstrip_blocks=True,
         keep_trailing_newline=True,
     )
+    # fetching the template from the FileSystemLoader
     template = env.get_template('message.txt')
+    # rendering the template
     return template.render(name=name, payment_status=payment_status)
 
 
 def preprocess(participants):
+    # converting the list of lists to list of dict
     data = []
     for participant in participants:
         data.append({

scrape.py

@@ -3,14 +3,19 @@
 
 
 def scraper(url):
+    # sending a get http request to the url
     response = requests.get(url)
+    # response: html page
     html = response.text
     data = []
 
+    # converting the html string to soup object
     soup = bs4.BeautifulSoup(html)
     li_tags = soup.select('li')
 
     for i in range(len(li_tags)):
+        # selecting all the necessary classes from the li tags
+        # Note: .select returns a list of elements
         name = li_tags[i].select('.name')[0].text
         dob = li_tags[i].select('.dob')[0].text
         email = li_tags[i].select('.email')[0].text