QuizGenerator 0.1.0__py3-none-any.whl

quizgenerator-0.1.0.dist-info/METADATA

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: QuizGenerator
+Version: 0.1.0
+Summary: Generate randomized quiz questions for Canvas LMS and PDF exams
+Project-URL: Homepage, https://github.com/OtterDen-Lab/QuizGenerator
+Project-URL: Documentation, https://github.com/OtterDen-Lab/QuizGenerator/tree/main/documentation
+Project-URL: Repository, https://github.com/OtterDen-Lab/QuizGenerator
+Project-URL: Bug Tracker, https://github.com/OtterDen-Lab/QuizGenerator/issues
+Author-email: Sam Ogden <samuel.s.ogden@gmail.com>
+License: GPL-3.0-or-later
+License-File: LICENSE
+Keywords: assessment,canvas,education,exam,lms,quiz,teaching,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Education :: Testing
+Requires-Python: >=3.12
+Requires-Dist: canvasapi==3.2.0
+Requires-Dist: cryptography>=41.0.0
+Requires-Dist: graphviz>=0.21
+Requires-Dist: jinja2==3.1.3
+Requires-Dist: markdown>=3.9
+Requires-Dist: matplotlib
+Requires-Dist: pylatex>=1.4.2
+Requires-Dist: pypandoc~=1.6.3
+Requires-Dist: pytablewriter~=1.2.0
+Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: pyyaml==6.0.1
+Requires-Dist: requests==2.32.2
+Requires-Dist: segno>=1.6.0
+Requires-Dist: sympy>=1.14.0
+Provides-Extra: grading
+Requires-Dist: pillow>=10.0.0; extra == 'grading'
+Requires-Dist: pyzbar>=0.1.9; extra == 'grading'
+Description-Content-Type: text/markdown
+
+# QuizGenerator
+
+Generate randomized quiz questions for Canvas LMS and PDF exams with support for multiple question types, automatic variation generation, and QR code-based answer keys.
+
+## Features
+
+- **Multiple Output Formats**: Generate PDFs (LaTeX or Typst) and Canvas LMS quizzes
+- **Automatic Variations**: Create unique versions for each student
+- **Extensible**: Plugin system for custom question types
+- **Built-in Question Library**: Memory management, process scheduling, calculus, linear algebra, and more
+- **QR Code Answer Keys**: Regenerate exact exam versions from QR codes
+- **Canvas Integration**: Direct upload to Canvas with variation support
+
+## Installation
+
+```bash
+pip install QuizGenerator
+```
+
+### System Requirements
+
+- Python 3.12+
+- LaTeX distribution with `latexmk` (for PDF generation)
+- Optional: [Typst](https://typst.app/) (alternative to LaTeX)
+
+### Optional Dependencies
+
+```bash
+# For QR code grading support
+pip install QuizGenerator[grading]
+```
+
+## Quick Start
+
+### 1. Create a quiz configuration (YAML)
+
+```yaml
+# my_quiz.yaml
+name: "Midterm Exam"
+
+questions:
+  10:  # 10-point questions
+    "Process Scheduling":
+      class: FIFOScheduling
+
+  5:   # 5-point questions
+    "Memory Paging":
+      class: PagingQuestion
+
+    "Vector Math":
+      class: VectorAddition
+```
+
+### 2. Generate PDFs
+
+```bash
+python -m generate_quiz --quiz_yaml my_quiz.yaml --num_pdfs 3
+```
+
+PDFs will be created in the `out/` directory.
+
+### 3. Upload to Canvas
+
+```bash
+# Set up Canvas credentials in ~/.env first:
+# CANVAS_API_URL=https://canvas.instructure.com
+# CANVAS_API_KEY=your_api_key_here
+
+python -m generate_quiz \
+  --quiz_yaml my_quiz.yaml \
+  --num_canvas 5 \
+  --course_id 12345
+```
+
+## Creating Custom Questions
+
+QuizGenerator supports two approaches for adding custom question types:
+
+### Option 1: Entry Points (Recommended for Distribution)
+
+Create a pip-installable package:
+
+```toml
+# pyproject.toml
+[project.entry-points."quizgenerator.questions"]
+my_question = "my_package.questions:MyCustomQuestion"
+```
+
+After `pip install`, your questions are automatically available!
+
+### Option 2: Direct Import (Quick & Easy)
+
+Add to your quiz YAML:
+
+```yaml
+custom_modules:
+  - my_questions  # Import my_questions.py
+
+questions:
+  10:
+    "My Question":
+      class: MyCustomQuestion
+```
+
+See [documentation/custom_questions.md](documentation/custom_questions.md) for complete guide.
+
+## Built-in Question Types
+
+### Operating Systems (CST334)
+- `FIFOScheduling`, `SJFScheduling`, `RoundRobinScheduling`
+- `PagingQuestion`, `TLBQuestion`
+- `SemaphoreQuestion`, `MutexQuestion`
+
+### Machine Learning / Math (CST463)
+- `VectorAddition`, `VectorDotProduct`, `VectorMagnitude`
+- `MatrixAddition`, `MatrixMultiplication`, `MatrixTranspose`
+- `DerivativeBasic`, `DerivativeChain`
+- `GradientDescentStep`
+
+### General
+- `FromText` - Custom text questions
+- `FromGenerator` - Programmatically generated questions
+
+## Documentation
+
+- [Getting Started Guide](documentation/getting_started.md) (coming soon)
+- [Custom Questions Guide](documentation/custom_questions.md)
+- [YAML Configuration Reference](documentation/yaml_config_guide.md) (coming soon)
+- [PyPI Release Plan](documentation/pypi_release_plan.md)
+
+## Canvas Setup
+
+1. Create a `~/.env` file with your Canvas credentials:
+
+```bash
+# For testing/development
+CANVAS_API_URL=https://canvas.test.instructure.com
+CANVAS_API_KEY=your_test_api_key
+
+# For production
+CANVAS_API_URL_prod=https://canvas.instructure.com
+CANVAS_API_KEY_prod=your_prod_api_key
+```
+
+2. Use `--prod` flag for production Canvas instance:
+
+```bash
+python -m generate_quiz --prod --num_canvas 5 --course_id 12345
+```
+
+## Advanced Features
+
+### Typst Support
+
+Use Typst instead of LaTeX for faster compilation:
+
+```bash
+python -m generate_quiz --typst --num_pdfs 3
+```
+
+### Deterministic Generation
+
+Use seeds for reproducible quizzes:
+
+```bash
+python -m generate_quiz --seed 42 --num_pdfs 3
+```
+
+### QR Code Regeneration
+
+Each generated exam includes a QR code that stores:
+- Question types and parameters
+- Random seed
+- Version information
+
+Use the grading tools to scan QR codes and regenerate exact exam versions.
+
+## Project Structure
+
+```
+QuizGenerator/
+├── QuizGenerator/           # Main package
+│   ├── question.py         # Question base classes and registry
+│   ├── quiz.py            # Quiz generation logic
+│   ├── contentast.py      # Content AST for cross-format rendering
+│   ├── premade_questions/ # Built-in question library
+│   └── canvas/           # Canvas LMS integration
+├── example_files/        # Example quiz configurations
+├── documentation/        # User guides
+└── generate_quiz.py     # CLI entry point
+```
+
+## Contributing
+
+Contributions welcome! Areas of interest:
+- New question types
+- Additional LMS integrations
+- Documentation improvements
+- Bug fixes
+
+## License
+
+GNU General Public License v3.0 or later (GPLv3+) - see LICENSE file for details
+
+## Citation
+
+If you use QuizGenerator in academic work, please cite:
+
+```
+@software{quizgenerator,
+  author = {Ogden, Sam},
+  title = {QuizGenerator: Automated Quiz Generation for Education},
+  year = {2024},
+  url = {https://github.com/OtterDen-Lab/QuizGenerator}
+}
+```
+
+## Support
+
+- Issues: https://github.com/OtterDen-Lab/QuizGenerator/issues
+- Documentation: https://github.com/OtterDen-Lab/QuizGenerator/tree/main/documentation
+
+---
+
+**Note**: This tool is designed for educational use. Ensure compliance with your institution's academic integrity policies when using automated quiz generation.

quizgenerator-0.1.0.dist-info/RECORD

@@ -0,0 +1,44 @@
+QuizGenerator/README.md,sha256=4n16gKyhIAKRBX4VKlpfcK0pyUYJ6Ht08MUsnwgxrZo,145
+QuizGenerator/__init__.py,sha256=8EV-k90A3PNC8Cm2-ZquwNyVyvnwW1gs6u-nGictyhs,840
+QuizGenerator/__main__.py,sha256=Dd9w4R0Unm3RiXztvR4Y_g9-lkWp6FHg-4VN50JbKxU,151
+QuizGenerator/constants.py,sha256=AO-UWwsWPLb1k2JW6KP8rl9fxTcdT0rW-6XC6zfnDOs,4386
+QuizGenerator/contentast.py,sha256=bHC1D_OBrDCnTuXcTiI37Muk20mBxD1gjDArUBrGv9c,63657
+QuizGenerator/generate.py,sha256=q5higZqQ4Q-OEC39cFWTyY89kWUtM9NMpxdD3_P4n9Q,11990
+QuizGenerator/logging.yaml,sha256=VJCdh26D8e_PNUs4McvvP1ojz9EVjQNifJzfhEk1Mbo,1114
+QuizGenerator/misc.py,sha256=uIc1revyGZK8LL-1sJfhsoJ_MlYn75LPap6FRAiJWRQ,15635
+QuizGenerator/mixins.py,sha256=RjV76C1tkTLSvhSoMys67W7UmR6y6wAAcBM2Msxdpd0,18186
+QuizGenerator/performance.py,sha256=CM3zLarJXN5Hfrl4-6JRBqD03j4BU1B2QW699HAr1Ds,7002
+QuizGenerator/qrcode_generator.py,sha256=S3mzZDk2UiHiw6ipSCpWPMhbKvSRR1P5ordZJUTo6ug,10776
+QuizGenerator/question.py,sha256=ZA-Yl28mtBXV3GgUipqogL9pKEBiLYzHq_io9wLXcKo,25390
+QuizGenerator/quiz.py,sha256=wOuj_mDfdnUNHlAEAcLUZoH-JX57RovLoYW4mA0GgPc,18762
+QuizGenerator/typst_utils.py,sha256=XtMEO1e4_Tg0G1zR9D1fmrYKlUfHenBPdGoCKR0DhZg,3154
+QuizGenerator/canvas/__init__.py,sha256=qsgHE4cz_WBXYZ3DZ_fEqLXUKbm-fH6oLkNUAnX96HY,286
+QuizGenerator/canvas/canvas_interface.py,sha256=vbfLX9BBKIOwkVyiXzrwIsjdRbl6jYTnxznt-ymARrM,24407
+QuizGenerator/canvas/classes.py,sha256=v_tQ8t_JJplU9sv2p4YctX45Fwed1nQ2HC1oC9BnDNw,7594
+QuizGenerator/premade_questions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+QuizGenerator/premade_questions/basic.py,sha256=wAvVZED6a7VToIvSCdAx6SrExmR0xVRo5dL40kycdXI,3402
+QuizGenerator/premade_questions/cst334/__init__.py,sha256=BTz-Os1XbwIRKqAilf2UIva2NlY0DbA_XbSIggO2Tdk,36
+QuizGenerator/premade_questions/cst334/languages.py,sha256=N5vcmZi-AFM_BZypnvNogHD7s--28-j-8tykYg6CBzs,14388
+QuizGenerator/premade_questions/cst334/math_questions.py,sha256=za8lNqhM0RB8qefmPP-Ww0WB_SQn0iRcBKOrZgyHCQQ,9290
+QuizGenerator/premade_questions/cst334/memory_questions.py,sha256=s887hyUyOBcUa53zhPxwdOV2YbJChSywZNpTtAqeljs,51561
+QuizGenerator/premade_questions/cst334/ostep13_vsfs.py,sha256=d9jjrynEw44vupAH_wKl57UoHooCNEJXaC5DoNYualk,16163
+QuizGenerator/premade_questions/cst334/persistence_questions.py,sha256=em-HzFRnaroDmHl5uA771HyFMI7dMvG-gxTgsB3ecaY,14458
+QuizGenerator/premade_questions/cst334/process.py,sha256=C7-FzOGW7EzQHXZNKden7eHo1NoG0UQbci0ZrUtybzs,23732
+QuizGenerator/premade_questions/cst463/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+QuizGenerator/premade_questions/cst463/gradient_descent/__init__.py,sha256=sH2CUV6zK9FT3jWTn453ys6_JTrUKRtZnU8hK6RmImU,240
+QuizGenerator/premade_questions/cst463/gradient_descent/gradient_calculation.py,sha256=ssj6Xkpw6vDiL4qwVOiHUhly3TX50oX4KJtouj7qN6g,12809
+QuizGenerator/premade_questions/cst463/gradient_descent/gradient_descent_questions.py,sha256=VjmNDpV3YgeYKqyYp4wQXZIViZVvC1GcnjVUl7valhU,9724
+QuizGenerator/premade_questions/cst463/gradient_descent/loss_calculations.py,sha256=TnhcD9OBsYgVDdSY5qPrSovnYB6r90wiGcg934czIrY,21500
+QuizGenerator/premade_questions/cst463/gradient_descent/misc.py,sha256=iB3obG6-uXr_yrLVT7L_9j1H54f7oe5Rk9w45yW-lnw,2654
+QuizGenerator/premade_questions/cst463/math_and_data/__init__.py,sha256=EbIaUrx7_aK9j3Gd8Mk08h9GocTq_0OoNu2trfNwaU8,202
+QuizGenerator/premade_questions/cst463/math_and_data/matrix_questions.py,sha256=sq27xv7X9aa0axFxomusZRwM-ICj9grbhD_Bv3n3gJg,28947
+QuizGenerator/premade_questions/cst463/math_and_data/vector_questions.py,sha256=tNxfR6J1cZHsHG9GfwVyl6lxxN_TEnhKDmMq4aVLwow,20793
+QuizGenerator/premade_questions/cst463/neural-network-basics/__init__.py,sha256=pmyCezO-20AFEQC6MR7KnAsaU9TcgZYsGQOMVkRZ-U8,149
+QuizGenerator/premade_questions/cst463/neural-network-basics/neural_network_questions.py,sha256=7ZtCQ2fXhIPSd99TstQfOKCN13GJE_56UfBQKdmzmMI,42398
+QuizGenerator/premade_questions/cst463/tensorflow-intro/__init__.py,sha256=G1gEHtG4KakYgi8ZXSYYhX6bQRtnm2tZVGx36d63Nmo,173
+QuizGenerator/premade_questions/cst463/tensorflow-intro/tensorflow_questions.py,sha256=dPn8Sj0yk4m02np62esMKZ7CvcljhYq3Tq51nY9aJnA,29781
+quizgenerator-0.1.0.dist-info/METADATA,sha256=p4Ahyc6-chI3WWQTlmVKIPA5i5UQ-UVTZDvzDXfsJEA,7149
+quizgenerator-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+quizgenerator-0.1.0.dist-info/entry_points.txt,sha256=iViWMzswXGe88WKoue_Ib-ODUSiT_j_6f1us28w9pkc,56
+quizgenerator-0.1.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+quizgenerator-0.1.0.dist-info/RECORD,,

quizgenerator-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

quizgenerator-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+quizgen = QuizGenerator.generate:main