AI-powered quiz generator for regulatory, certification, and educational documentation
Project description
quiz-gen
AI-powered quiz generator for regulatory documentation. Extract structured content from complex legal and technical documents to create comprehensive teaching and certification materials.
Features
- Multi-Agent Quiz Generation: Generate, validate, refine, and judge questions using configurable providers/models.
- EUR-Lex Document Parser: Parse and structure EU legal documents with full table of contents extraction
- Human-in-the-Loop: Integrate human input throughout the workflow.
Installation
pip install quiz-gen
Quick Start
Parsing EUR-Lex Documents
from quiz_gen import EURLexParser
# Parse a regulation document
url = "https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=OJ:L_202401689"
parser = EURLexParser(url=url)
chunks, toc = parser.parse()
# Access structured content
print(f"Extracted {len(chunks)} content chunks")
print(f"Document has {len(toc['sections'])} major sections")
# Save results
parser.save_chunks('output_chunks.json')
parser.save_toc('output_toc.json')
Working with Chunks
# Iterate through extracted chunks
for chunk in chunks:
print(f"{chunk.title}")
print(f"Type: {chunk.section_type.value}")
print(f"Number: {chunk.number}")
print(f"Content: {chunk.content[:200]}...")
print(f"Hierarchy: {' > '.join(chunk.hierarchy_path)}")
print()
Displaying Table of Contents
# Print formatted TOC
parser.print_toc()
# Output:
# PREAMBLE
# Citation
# Recital 1
# Recital 2
# ...
#
# ENACTING TERMS
# CHAPTER I - PRINCIPLES
# Article 1 - Subject matter and objectives
# Article 2 - Scope
Multi-Agent Quiz Generation
Quiz generation uses four specialized agents (conceptual, practical, validator, refiner, and judge). Providers are configurable per agent, with supported providers: Anthropic, Cohere, Google, Mistral, and OpenAI. Any text-generation model name from these providers can be passed directly. The package relies on provider defaults for generation parameters.
Multi-Agent Architecture and Configuration
from quiz_gen.agents.workflow import QuizGenerationWorkflow
from quiz_gen.agents.config import AgentConfig
config = AgentConfig(
conceptual_provider="cohere",
conceptual_model="command-a-03-2025",
practical_provider="google",
practical_model="gemini-3-pro-preview",
validator_provider="openai",
validator_model="gpt-5.2-2025-12-11",
refiner_provider="anthropic",
refiner_model="claude-sonnet-4-5-20250929",
judge_provider="mistral",
judge_model="mistral-large-latest",
)
workflow = QuizGenerationWorkflow(config)
result = workflow.run(chunk)
Development
Setting up Development Environment
# Clone the repository
git clone https://github.com/yauheniya-ai/quiz-gen.git
cd quiz-gen
# Install with development dependencies
pip install -e ".[dev]"
# Run tests
pytest --cov=src --cov-report=term-missing
# Run linting
ruff check .
black .
Project Structure
quiz-gen/
├── data/
│ ├── raw/
│ ├── processed/
│ └── quizzes/
├── src/
│ └── quiz_gen/ # Module code here
│ ├── agents/
│ ├── parsers/
│ └── ...
├── examples/ # Example scripts
│ ├── eur_lex_html_url.py
│ └── quiz_gen_multi_model.py
├── pyproject.toml
├── README.md
├── CHANGELOG.md
└── .env
API Reference
EURLexParser
Main parser class for EUR-Lex documents.
Methods:
parse()->tuple[List[RegulationChunk], Dict]: Parse document and return chunks and TOCfetch()->str: Fetch HTML content from URLsave_chunks(filepath: str): Save chunks to JSON filesave_toc(filepath: str): Save table of contents to JSON fileprint_toc(): Display formatted table of contents
RegulationChunk
Represents a parsed content chunk (article or recital).
Attributes:
section_type: Type of section (ARTICLE, RECITAL, etc.)number: Section number (e.g., "1", "42")title: Full title including subtitlecontent: Text contenthierarchy_path: List of parent sectionsmetadata: Additional structured data
SectionType
Enumeration of document section types.
Values:
PREAMBLE: Preamble sectionENACTING_TERMS: Main regulatory contentCITATION: Citation in preambleRECITAL: Recital in preambleCHAPTER: Chapter divisionSECTION: Section within chapterARTICLE: Article (main content unit)ANNEX: Annex section
Use Cases
Compliance and Legal
- Analyze regulatory requirements systematically
- Support automated document analysis workflows
- Build searchable knowledge bases from legal texts
Education and Training
- Generate study materials from regulatory documents
- Create structured learning paths for certification programs
- Extract key concepts for examination preparation
Supported Document Types
Currently supports:
- EUR-Lex HTML Documents: European Union regulations, directives, decisions
Document Format Requirements
- Documents must use EUR-Lex HTML format
- Must contain
eli-subdivisionelements for proper structure identification - Supports multi-level hierarchies with chapters, sections, and articles
Roadmap
Future enhancements planned:
- Support for additional document formats (PDF, DOCX, PPTX)
- Multi-language support
- Integration with learning management systems
License
This project is licensed under the MIT License. See the LICENSE file for details.
Citation
If you use this software in academic work, please cite:
Varabyova, Y. (2026). Quiz Gen AI: AI-powered quiz generator for professional certification.
GitHub repository: https://github.com/yauheniya-ai/quiz-gen
Support
- Documentation: https://quiz-gen.readthedocs.io
- Issue Tracker: https://github.com/yauheniya-ai/quiz-gen/issues
Contributing
Contributions are welcome! Please ensure:
- Code follows PEP 8 style guidelines
- All tests pass
- New features include appropriate tests
- Documentation is updated
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quiz_gen-0.4.3.tar.gz.
File metadata
- Download URL: quiz_gen-0.4.3.tar.gz
- Upload date:
- Size: 35.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a04565e263af2cfef096ff8a3e10a0e12e431779c0cb994b8da576e792cae04
|
|
| MD5 |
ea64302f29a7fd6dcfc6375e89fb0db8
|
|
| BLAKE2b-256 |
753f55612a7b78ef0b168efd34f13f346d43c358140326188a56b824bbec5727
|
File details
Details for the file quiz_gen-0.4.3-py3-none-any.whl.
File metadata
- Download URL: quiz_gen-0.4.3-py3-none-any.whl
- Upload date:
- Size: 39.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
db284d371d10bf737e36f667c700590540bc4a3c1157bb6405c84da54b290f44
|
|
| MD5 |
161b85cc651efb9c59c7d217dd2ae32a
|
|
| BLAKE2b-256 |
1055d30876176666647eddf2a3bbb4cb377d230e1ec83dcfcd8fb845fd8260bd
|