Skip to content

Latest commit

 

History

History
101 lines (63 loc) · 2.47 KB

README.md

File metadata and controls

101 lines (63 loc) · 2.47 KB
Raw

Quiz Generator

Overview

Quiz Generator is a Streamlit application that generates multiple-choice quizzes based on provided text content. Users can select the difficulty level of the quiz and get a set of multiple-choice questions that conform to the provided text. The application leverages the OpenAI API to generate questions dynamically.

Features

  • Generate multiple-choice questions from provided text.
  • Choose quiz difficulty level (EASY, MEDIUM, HARD).
  • View and submit answers to the generated quiz.
  • Display quiz results with correct answers.

Screenshots

Home Page

Home Page

Requirements

  • Python 3.x
  • Streamlit
  • OpenAI API

Setup

  1. Clone the Repository:

    git clone https://github.com/amiteshsrinivas/Quiz-Generator.git

  2. Navigate to the Project Directory:

    cd Quiz-Generator

  3. Set Up a Virtual Environment: a. Create a virtual environment (if not already created): ```bash python -m venv quiz_env

    b. Activate the virtual environment:

    • For Windows PowerShell: 
      .\quiz_env\Scripts\Activate.ps1
    • For Windows Command Prompt: 
      .\quiz_env\Scripts\activate
    • For macOS/Linux: 
      source quiz_env/bin/activate

  4. Install Dependencies:

      pip install -r requirements.txt

  5. Set Up Environment Variables:

    • Create a .env file in the root directory of the project.
    • Add your OpenAI API key to the .env file:
    OPENAI_API_KEY=your_openai_api_key

  6. Run the Application:

    streamlit run quizapp.py

Usage

  1. Open the Application:

Navigate to http://localhost:8501 in your web browser.

  1. Enter Text Content:

Paste the text content for which you want to generate a quiz in the text area.

  1. Select Quiz Level:

Choose the difficulty level from the dropdown menu.

  1. Generate Quiz:

Click the "Generate Quiz" button to create the quiz.

  1. Answer Questions:

Select your answers for each multiple-choice question and click "Submit" to see your results.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • This project uses the OpenAI API for generating quiz questions.
  • Thanks to the Streamlit community for providing an excellent framework for building web applications.