pdfxact 0.1.1

PDF Quiz Generator

PDFxact

A powerful PDF Quiz Generator that extracts content from PDFs and automatically generates educational questions with fact checking capabilities.

Installation

pip install pdfxact

Features

• PDF text extraction with OCR support
• AI-powered question generation from PDF content
• Automated fact checking and validation
• Text preprocessing and quality analysis
• Batch processing for efficient question generation
• Customizable number of questions

Usage

Command Line Interface

# Generate 5 questions from a PDF file
qz path/to/your/document.pdf

# Generate a specific number of questions
qz path/to/your/document.pdf --num_questions 10

# Control batch processing size
qz path/to/your/document.pdf --num_questions 20 --batch_size 8

Python API

from qz.text_extractor import TextExtractor
from qz.question_generator import QuestionGenerator

# Extract text from PDF
extractor = TextExtractor()
text = extractor.extract_text_from_pdf("path/to/your/document.pdf")

# Generate quiz questions
generator = QuestionGenerator()
questions = generator.generate_question_from_text(text, num_questions=5)

# Process the questions
for i, question in enumerate(questions, 1):
    print(f"Question {i}: {question['text']}")
    print("Options:", question['options'])
    print("Correct Answer:", question['options'][question['correct_answer']])
    print()

Advanced Features

• OCR Support: Automatically extracts text from scanned PDFs using EasyOCR
• Fact Checking: Validates generated questions against source content
• Quality Analysis: Ensures generated questions meet educational standards
• Batch Processing: Efficiently processes multiple questions in parallel

Requirements

• Python 3.11
• Dependencies (automatically installed):
  • torch: Deep learning support
  • spacy: NLP processing
  • transformers: Question generation
  • pypdf: PDF processing
  • easyocr: OCR support
  • reportlab: PDF generation
  • ollama: LLM integration

See pyproject.toml for full dependency list.

Development

1. Clone the repository
2. Install development dependencies:

   pip install -r requirements-dev.txt
   

3. Install pre-commit hooks:

   pre-commit install
   

4. Run tests:

   pytest
   

License

MIT License - See LICENSE file for details