Update quiz_generation.py

quiz_generation.py

@@ -5,7 +5,6 @@ from oauth2client import client, file, tools
 import bardapi
 import streamlit
 
-
 SCOPES = "https://www.googleapis.com/auth/forms.body"
 DISCOVERY_DOC = "https://forms.googleapis.com/$discovery/rest?version=v1"
 
@@ -15,15 +14,24 @@ NEW_FORM = {
     }
 }
 
-
+# Function to generate quiz questions based on a given prompt
 def generate_quiz_questions(prompt):
-    # Set your Bard API key as an environment variable
+    '''Generates quiz questions based on a given prompt using the Bard API.
+    
+    Args:
+        prompt (str): The prompt for generating quiz questions.
     
+    Returns:
+        str: The generated quiz questions in a formatted text.
+    '''
+    # Visit https://bard.google.com/
+    # F12 for console
+    # Session: Application → Cookies → Copy the value of __Secure-1PSID cookie.
+    # Set your __Secure-1PSID value to key
     os.environ['_BARD_API_KEY'] = st.secrets["bard_api_key"]
     
     prompt_suffix = ". Each generated question has to begin with '🔹', each choice has to begin with '🔸', and each correct answer has to begin with '✔️'."
 
-
     # Send API requests and get responses
     response = bardapi.core.Bard().get_answer(prompt + prompt_suffix)
 
@@ -31,8 +39,17 @@ def generate_quiz_questions(prompt):
 
     return quiz
 
-
+# Function to generate the quiz URL based on the transcribed text
 def generate_quiz_url(prompt_text, form_service):
+    '''Generates the quiz URL based on the transcribed text and form service.
+    
+    Args:
+        prompt_text (str): The transcribed text used for generating quiz questions.
+        form_service (googleapiclient.discovery.Resource): The form service object for creating the form.
+    
+    Returns:
+        str: The URL of the generated quiz form.
+    '''
     # Generate quiz questions based on the transcribed text
     text = generate_quiz_questions(prompt_text)
 
@@ -105,6 +122,4 @@ def generate_quiz_url(prompt_text, form_service):
     # Construct the quiz link using the form ID
     form_url = result["responderUri"]
 
-
     return form_url
-