app.py

# Imports
from utils.get_audio_file import get_audio_file
from utils.get_transcription import get_transcription
from utils.get_quiz_array import get_quiz_array
import streamlit as st
from fpdf import FPDF
import os

# This function takes information from the user - the url 
def get_information():
    url_container = st.empty()
    url_content_container = url_container.container()
    url = url_content_container.text_input('Youtube URL of Lecture Video', 'https://www.youtube.com/watch?v=rs9AFEebHsk')
    generate_button = url_content_container.button("Generate Quiz", type="primary")

    if generate_button:
        st.session_state.quiz_started = True

        # Removing the url container after clicking the generate button
        url_container.empty()

        with st.spinner('Converting Video File to Audio...'):
            get_audio_file(url)

        with st.spinner('Converting Audio File to Text...'):
            text = get_transcription()

        with st.spinner('Generating Quiz...'):
            quiz_array = get_quiz_array(text)
            st.session_state.quiz_array = quiz_array

        show_buttons()

# This function converts the quiz_array which is a string returned from gpt-4 to a list and then save it in session state
def get_quiz_list():
    quiz_array = st.session_state.quiz_array

    # Removing any escape sequences as it hinders in conversion of string to list of the quiz_result
    quiz_array = quiz_array.replace("\n", "")
    quiz_array = quiz_array.replace("\t", "")
    quiz_array = quiz_array.replace("\r", "")
    quiz_array = quiz_array.replace("\b", "")
    quiz_array = quiz_array.replace("\f", "")
    quiz_array = quiz_array.replace("\\", "")
    quiz_array = quiz_array.replace("\'", "")

    # Convert the string to a list
    quiz_list = eval(quiz_array)

    if "quiz_list" not in st.session_state:
        st.session_state.quiz_list = []

    st.session_state.quiz_list = quiz_list

    return quiz_list

# Function to generate and download the quiz PDF
def download_quiz():

    quiz_list = get_quiz_list() 

    # Initialize the PDF object
    pdf = FPDF()

    pdf.add_page()
    pdf.set_font("Times", size=24)

    pdf.cell(200, 10, txt="Lumina", ln=1, align='C')

    pdf.line(0, 22, 500, 22)

    pdf.set_font("Times", size=18)

    pdf.cell(200, 10, txt="", ln=1, align='L')
    pdf.cell(200, 10, txt="Quiz : ", ln=1, align='L')

    # Loop through the quiz list and add questions and their choices
    for question_data in quiz_list:
        question_number, question_text, *choices, correct_choice = question_data

        pdf.set_font("Times", size=12)

        # Add the question to the PDF
        pdf.cell(200, 10, txt=f"Question {question_number}: {question_text}", ln=1, align='L')

        pdf.set_font("Times", size=11)

        # Add the choices to the PDF
        for choice_number, choice_text in enumerate(choices, start=1):
            pdf.cell(200, 5, ln=1, txt=f"{choice_number}. {choice_text}", align='L')

    pdf.add_page()
    pdf.set_font("Times", size=12)

    pdf.cell(200, 10, txt="Answers : ", ln=1, align='L')

    answers = [item[6] for item in quiz_list]

    # Add the answers to the PDF at the end in a new page
    for answer_number, answer in enumerate(answers, start=1):
        pdf.cell(200, 5, ln=1, txt=f"{answer_number}. {answer}", align='L')

    # Save the PDF to a file
    pdf_file_path = "quiz.pdf" 
    pdf.output(pdf_file_path)

    return pdf_file_path 

# This function hides the Take Quiz and Download PDF buttons
def hide_buttons():
    if st.session_state.show_buttons:
        st.session_state.show_buttons = False
    

# This function hides the Take Quiz and Download PDF buttons after generating the Quiz
def show_buttons():
    # Create a session state to track buttons visibility
    if "show_buttons" not in st.session_state:
        st.session_state.show_buttons = True

    # Conditionally show/hide the buttons
    if st.session_state.show_buttons:
        st.write("Do you wanna ")
        st.button("Take the Quiz", type="primary", on_click=hide_buttons)
        st.write("or")
        pdf_file_path = download_quiz()  # Generate and get the PDF file path
        with open(pdf_file_path, "rb") as pdf_file:
            st.download_button(
                label="Download Quiz PDF",
                data=pdf_file.read(),   
                key="pdf-download",
                file_name="quiz.pdf", 
                type="primary",
            )


# This function displays the quiz to the user which you can take and then on submit view the results.
def show_quiz():
    quiz_list = st.session_state.quiz_list

    # Initializing session states
    if "index" not in st.session_state:
        st.session_state.index = 0    
        st.session_state.questions = [item[1] for item in quiz_list]
        st.session_state.options = [[item[2], item[3], item[4], item[5]] for item in quiz_list]
        st.session_state.answers = [item[6] for item in quiz_list]
        st.session_state.latest_answer = ""
        st.session_state.user_answers = []
        st.session_state.no_of_correct_answers = 0
        st.session_state.no_of_incorrect_answers = 0
        st.session_state.quiz_submitted = False

    index = st.session_state.index
    length = len(quiz_list)
    question = st.session_state.questions[index]
    options = st.session_state.options[index]
    answer = st.session_state.answers[index]

    st.markdown("## Quiz")

    # If the quiz is submitted, display the results
    if st.session_state.quiz_submitted == True:
        st.markdown(f"### You scored: {st.session_state.no_of_correct_answers}/{len(st.session_state.questions)}")
        user_answer = st.session_state.user_answers[index]
        if answer == user_answer:
            st.success(f"The correct answer is {answer}.", icon="✔️")
        else:
            st.error(f"{user_answer} is incorrect! The correct answer is {answer}.", icon="❌")


    temp_string = f"#### Question {index+1} out of {length}:"
    st.markdown(temp_string)
    st.markdown(question)

    if st.session_state.quiz_submitted == True:
        user_answer = st.session_state.user_answers[index]
        # Display the answer that user selected upon quiz submission
        st.radio(
            question,
            options,
            label_visibility = "collapsed",
            key = index,
            index = options.index(user_answer)
        )
    else:
        user_answer = st.radio(
            question,
            options,
            label_visibility = "collapsed",
            key = index,
        )

    # The answer that user selectes the latest (before clicking the Next button)
    st.session_state.latest_answer = user_answer

    button = st.empty()

    if st.session_state.quiz_submitted == False:
        # Display Submit if it is the last question other display Next button
        if index < length - 1:
            next_button = st.button("Next Question", type="primary", on_click=next)
        elif index == length - 1:
            button.button("Submit", type="primary", on_click=next)
    else:
        # Display Return to Home button if it is the last question in the view results after quiz submission, otherwise display Next button
        if index < length - 1:
            next_button = st.button("Next Question", type="primary", on_click=next)
        elif index == length - 1:
            button.button("Return to Home", type="primary", on_click=return_to_home)

def next():
    index = st.session_state.index
    length = len(st.session_state.quiz_list)

    if index < length - 1:
        st.session_state.index += 1
        # Appending answers that the user inputs
        st.session_state.user_answers.append(st.session_state.latest_answer)
    elif index == length - 1:
        # Appending the last answer too that the user inputs
        st.session_state.user_answers.append(st.session_state.latest_answer)
        compare()
        
def compare():
    answers = st.session_state.answers
    user_answers = st.session_state.user_answers

    # Check if the lists have the same length
    if len(answers) != len(user_answers):
        print("The lists have different lengths, so they are not equal.")
    else:
        # Use a loop to compare the values at each index and count the correct and incorrect answers
        for i in range(len(answers)):
            if answers[i] == user_answers[i]:
                st.session_state.no_of_correct_answers += 1
            else:
                st.session_state.no_of_incorrect_answers += 1
    
    st.session_state.quiz_submitted = True
    st.session_state.index = 0

def return_to_home():
    # Delete all the items in session state
    for key in st.session_state.keys():
        del st.session_state[key]

def main():

    st.set_page_config(page_title="Lumina", page_icon="🎓")

    st.header("Lumina 🎓")
    st.markdown("Lumina project is an AI powered Educational Quiz Generator developed by team **fruitydibs** for the **Streamlit LLM Hackathon**.  Lumina turns your educational video lectures into engaging MCQ based quizzes and provides automatic assessment. Learning has never been this fun!")
    st.write("Lumina utilizes the transcription feature of **AssemblyAI** and transcribes a video such as a video lecture from youtube and then gives the transcribed text to GPT-4 Model from **Clarifai** which generates a quiz for the user to take and assess their knowledge in an easy and user-friendly manner.")
    st.write("")
    st.write("⚠️ Please expect 20 - 30 seconds for the quiz to be generated.")
    st.divider()

    # Initializing session states
    if "quiz_started" not in st.session_state:
        st.session_state.quiz_started = False
        st.session_state.quiz_array = ""

    if st.session_state.quiz_started == False:
        get_information()
    else: 
        if st.session_state.show_buttons:
            show_buttons()
        else: 
            show_quiz()


if __name__ == '__main__':
    main()