Merge remote-tracking branch 'louistw/fix-linting' into fix-linting

app/__init__.py

+"""
+Initialize the main flask app
+"""
 # app/__init__.py
 
 # standard imports
@@ -15,11 +18,21 @@ from flask_cors import CORS
 # local imports
 import messages
 import vars
+
 sys.path.append(vars.rabbitmq_agents_loc)
 import rc_util  # noqa: E402
 
 
 def create_app(config_name):
+    """
+    Create main flask app
+
+    input:
+        config_name: environment of the app running
+    output:
+        Flask instance
+    """
+
     app = Flask(
         __name__, static_folder="static"
     )  # initialization of the flask app
@@ -87,10 +100,10 @@ def create_app(config_name):
                 pre_certification_msg=messages.pre_certification_message,
                 certification_msg=messages.certification_message,
             )
-        elif rc_util.check_state(session['user'].get('username')) == "ok":
+        elif rc_util.check_state(session["user"].get("username")) == "ok":
             return render_template(
                 "account/good_standing.html",
-                good_standing_msg=messages.good_standing_message
+                good_standing_msg=messages.good_standing_message,
             )
         else:
             return render_template(

config.py

+"""
+Define different environment running the app
+"""
+
 # config.py
 
 

messages.py

+"""
+Messages used in account management app
+"""
+
 welcome_message = (
     "The information below will be used to create your account. Please fill in"
     " the reason for requesting your account as this helps us understand our"

run.py

+"""
+This python script conatins functions that talk with Flask frontend over socketio. 
+It has functions to join a unique room, creating an account and certifying an account.    
+"""
 # run.py
 
 # standard imports
@@ -28,6 +32,13 @@ socketio = SocketIO(
 
 @socketio.on("join_room")
 def on_room(json):
+    """
+    This function creates a unique room/flask session id, and joins it
+    Input:
+        json: conatins config information for the flask session
+    Output:
+        Join the unique room.
+    """
     room = str(session["uid"])
     referrer = json["referrer"]
     join_room(room)
@@ -37,6 +48,14 @@ def on_room(json):
 
 @socketio.on("request account")
 def request_account(json, methods=["GET", "POST"]):
+    """
+    This function is called by the Flask frontend on an account request.
+    Input:
+        json: This contains information needed for the user that needs to be created from the frontend.
+        methods: Defaults to ["GET", "POST"].
+    Output:
+        Send the json to Celery tasks file for account creation.
+    """
     print(
         time.strftime("%m-%d-%Y_%H:%M:%S")
         + "\tQueue request received: "
@@ -57,6 +76,14 @@ def request_account(json, methods=["GET", "POST"]):
 
 @socketio.on("request certification")
 def certify_account(json, methods=["GET", "POST"]):
+    """
+    This function is called by the Flask frontend from self certification page.
+    Inputs:
+        json: Conatins information about the user that needs to be certified from the frontend.
+        methods: Defaults to ["GET", "POST"].
+    Outputs:
+        Send the json to Celery tasks file for user certification.
+    """
     print(
         time.strftime("%m-%d-%Y_%H:%M:%S")
         + "\tQueue request received: "