Added documentation

Author: shreyasvedpathak

certificate_generator/README.md

@@ -0,0 +1,45 @@
+# Certificate Generator
+
+## Table of Contents
+
+- [Folder Structure](#folder-structure)
+- [Requirements](#requirements)
+- [Approach](#approach)
+
+## Folder Structure
+
+```plain
+│   README.md
+│   requirements.txt
+│   run.py                                             # To run the web app
+│
+└───app
+    │   routes.py                                      # Contains routes
+    │   utils.py                                       # Contains generate_certifcate() function
+    │   __init__.py
+    │
+    ├───static                                         # Contains necessary static files
+    │   └───certificates
+    │       ├───generated                              # Stores generated certificates
+    │       │       Shreyas Vedpathak.png              # sample certificate
+    │       │
+    │       └───template                               # Contains neccesary required files
+    │               Sanchez-Regular.ttf                # Font
+    │               template.png                       # Template for certificate
+    │
+    └───templates                                      # HTML files for frontend
+            certificate.html
+            download.html
+            home.html
+```
+
+## Requirements
+
+- Flask==1.1.2
+- Pillow==8.3.1
+
+## Approach
+
+1. We get the user name and pr number from the form in `certificate.html`.
+2. We use the received information to generate and save the certificate using `generate_certificate()` function in `app/utils.py`.
+3. Finally, we render that certificate using `download.html` and we provide the option of downloading, and generate again.

certificate_generator/app/routes.py

@@ -1,35 +1,52 @@
+# External Imports
+import os
+from flask import render_template, request, send_file
+
+# Internal Imports
 from app import app
 from app.utils import generate_certificate
-from flask import render_template, request, send_file
-import os
 
 
 @app.after_request
 def add_header(r):
     """
-    Add headers to both force latest IE rendering engine or Chrome Frame,
-    and also to cache the rendered page for 10 minutes.
+    Prevents caching, which will make sure old files are not sent.
     """
     r.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
     r.headers["Pragma"] = "no-cache"
     r.headers["Expires"] = "0"
     r.headers['Cache-Control'] = 'public, max-age=0'
     return r
 
+
 @app.route('/', methods=['GET', 'POST'])
 def home():
-   return render_template("certificate.html")
+    '''home
+    Renders home page
+    '''
+    return render_template("certificate.html")
 
 
 @app.route('/render', methods=['POST'])
 def render_certificate():
+    """
+    Get's information from user and generates
+    the certificate using generate_certificate function
+    """
     if request.method == "POST":
-        file_name = generate_certificate(request.form['name'], request.form['pr_num'])
+        file_name = generate_certificate(
+            request.form['name'],
+            request.form['pr_num'])
         return render_template('download.html', file_name=file_name)
 
+
 @app.route('/download_certificate', methods=['GET'])
 def download():
+    """
+    Download the generated certificate
+    """
     if request.method == "GET":
         filename = request.args.get("filename")
         filepath = os.path.join("static/certificates/generated", filename)
-        return send_file(filepath, as_attachment=True, cache_timeout=0, attachment_filename=filename)
+        return send_file(filepath, as_attachment=True, cache_timeout=0,
+                         attachment_filename=filename)

certificate_generator/app/utils.py

@@ -1,37 +1,61 @@
+# External Imports
 from PIL import Image, ImageFont, ImageDraw
-from app import app
 import os
 
+# Internal Imports
+from app import app
+
+
 def generate_certificate(name, pr_num):
+    '''generate_certificate Generates certificate using base template
+
+    Args:
+        name (string): Name to be displayed on certificate
+        pr_num (integer): PR number to be displayed on certificate
+    '''
+    # Path to template certificate
     template_dir = os.path.join(app.root_path, "static/certificates/template")
     template_filename = "template.png"
-    
+
+    # Path to save the certificate
     output_dir = os.path.join(app.root_path, "static",
                               "certificates/generated/")
     output_filename = f"{name}.png"
-    
+
+    # Load the template file
     img = Image.open(os.path.join(template_dir, template_filename))
     draw = ImageDraw.Draw(img)
-    
+
+    # Text to put on the certificate
     event_name = "Hacktoberfest"
     contributed_at = "Automation scripts"
     msg = f"""for taking part in {event_name} and
 contribution in #{pr_num} at {contributed_at}.
 """
-    
-    name_font = ImageFont.truetype(os.path.join(template_dir, "Sanchez-Regular.ttf"), 150)
-    msg_font = ImageFont.truetype(os.path.join(template_dir, "Sanchez-Regular.ttf"), 70)
-    
+    # Load fonts
+    name_font = ImageFont.truetype(os.path.join(
+        template_dir, "Sanchez-Regular.ttf"), 150)
+    msg_font = ImageFont.truetype(os.path.join(
+        template_dir, "Sanchez-Regular.ttf"), 70)
+
+    # Insert text (Name)
     draw.text((1000, 1390), name, (51, 213, 172), font=name_font)
+    # Insert text (Message)
     draw.text((1000, 1650), msg, (14, 69, 115), font=msg_font)
-    
+
+    # Calculate the width of the texts. We will need it to
+    # draw the underline. As the pr number width can vary we cannot
+    # hardcode the coordinates of the text to be underlined.
+    # So we find the width of the pr_num and then calculate
+    # the starting position of the underlined text.
     twidth, theight = draw.textsize(contributed_at, font=msg_font)
     prwidth, prheight = draw.textsize(pr_num, font=msg_font)
-    
+
     lx = 1560 + prwidth + 120
     ly = 1810
     draw.line((lx, ly, lx + twidth, ly), fill=(14, 69, 115), width=5)
-    
+
+    # Save certificate
     img.save(os.path.join(output_dir, output_filename))
-    
+    # Return filename, required for rendering the certificate
     return output_filename

certificate_generator/requirements.txt

@@ -0,0 +1,2 @@
+Flask==1.1.2
+Pillow==8.3.1