Generate intelligent quizzes from any PDF document using AI Agents

🚀 Try the Live App

A sophisticated quiz generation system that transforms PDF documents into educational assessments, leveraging AI agents to create high-quality multiple-choice and true/false questions with detailed explanations.

Quiz Generator is an AI-powered application built using CrewAI that automatically creates educational quizzes from PDF documents. The system employs specialized AI agents working together to extract content, generate questions, and provide comprehensive answer explanations. Perfect for educators, content creators, and students looking to create assessment materials or test their understanding of technical content.

• 🤖 AI Agent-Powered: Utilizes specialized CrewAI agents for different aspects of quiz generation
• 📄 PDF Processing: Extracts and processes text from PDF documents
• 🧠 Multiple Question Types: Generates both multiple-choice and true/false questions
• 📊 Quiz Analysis: Provides detailed explanations for correct and incorrect answers
• 🔍 Quality Control: Ensures questions are relevant and pedagogically sound
• 🖥️ User-Friendly Interface: Clean Streamlit web interface for easy interaction
• 📱 Responsive Design: Works across different screen sizes and devices

Quiz-Generator/
├── __init__.py
├── app.py                  # Streamlit web application
├── requirements.txt        # Project dependencies
├── .gitignore             # Git ignore file
├── assets/                # Static assets
│   └── live_demo.mkv      # Demo video
├── config/                # Configuration files
│   ├── __init__.py
│   ├── agents.yaml        # Agent definitions
│   ├── config.py          # Global settings
│   └── tasks.yaml         # Task definitions
├── data/                  # Sample PDF documents
├── output/                 # Generated quiz JSON files
│   ├── mcq_quiz.json       # Multiple-choice questions
│   ├── quiz_analysis.json  # Detailed explanations
│   └── tf_quiz.json        # True/false questions
├── src/                   # Core application code
│   ├── __init__.py
│   ├── crew.py            # CrewAI agent setup
│   ├── pydantic_models.py # Data models
│   ├── quiz_pipeline.py   # Main processing pipeline
│   └── utils.py           # Helper functions
├── .devcontainer/         # Development container config
└── .vscode/              # VS Code settings

1. Clone the repository

   git clone https://github.com/Fawzy-AI-Explorer/Quiz-Generator.git
   cd Quiz-Generator

2. Set up a virtual environment

   python -m venv .venv
   # On Windows
   .\venv\Scripts\activate
   # On macOS/Linux
   source venv/Scripts/activate

3. Install dependencies

   pip install -r requirements.txt

4. Set up environment variables

   Create a .env file in the project root with:

   PROVIDER=your_llm_provider
   MODEL=your_model_name
   BASE_URL=your_base_url
   TEMPERATURE=0.7

1. Start the Streamlit application

   streamlit run app.py

2. Using the application

   • Upload a PDF document through the web interface
   • Click the "Generate Quiz" button
   • Review generated multiple-choice and true/false questions
   • Explore detailed explanations for each question

3. Running the pipeline directly

   cd "Quiz generator"
   python -c "from src.quiz_pipeline import run_pipeline; run_pipeline('path/to/your/file.pdf')"

Contributions are welcome and appreciated! Here's how you can contribute:

1. Fork the repository

2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Commit your changes

   git commit -m 'Add some amazing feature'

4. Push to the branch

   git push origin feature/amazing-feature

5. Open a Pull Request

Please ensure your code follows the project's coding style and includes appropriate tests.

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

Thanks to all the amazing people who have contributed to this project!

• CrewAI - Framework for orchestrating role-playing autonomous AI agents
• Streamlit - Framework for building the web interface
• LangChain - Framework for language model applications
• PyPDF - Library for PDF processing