Metadata-Version: 2.4
Name: quizml
Version: 0.9.2
Summary:   Tool for converting a list of questions in yaml/markdown to aBlackBoard test or to a Latex exam source file
Author-email: Francois Pitie <francois.pitie@gmail.com>
License: GPLv3
Project-URL: Repository, https://github.com/frcs/quizml.git
Project-URL: Homepage, https://github.com/frcs/quizml
Keywords: BlackBoard,exam,test,quiz,MCQ,YAML,Markdown,Latex
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pillow
Requires-Dist: ruamel.yaml>=0.17
Requires-Dist: jsonschema>=4.0
Requires-Dist: bs4
Requires-Dist: rich>=12.0.0
Requires-Dist: rich-argparse
Requires-Dist: jinja2
Requires-Dist: colorama
Requires-Dist: watchdog
Requires-Dist: mistletoe==1.3.0
Requires-Dist: css_inline
Requires-Dist: latex2mathml
Requires-Dist: appdirs
Dynamic: license-file

# QuizML

Tool for converting a list of questions in yaml/markdown to a BlackBoard test or
to a Latex exam source file

Here is a minimal example of a `quiz.yaml` file. You write the questions in a YAML
file, using a Markdown syntax:

```yaml
- type: mc
  marks: 5           
  question: |
    If vector ${\bf w}$ is of dimension $3 \times 1$ and matrix ${\bf A}$ of
    dimension $5 \times 3$, then what is the dimension of $\left({\bf w}^{\top}{\bf
    A}^{\top}{\bf A}{\bf w}\right)^{\top}$?
  choices:
    - o:  $5\times 5$
    - o:  $3\times 3$
    - o:  $3\times 1$
    - x:  $1\times 1$

- type: tf
  marks: 5         
  question: |
    Is this the image of a tree?
    
    ![](figures/bee.jpg){ width=30em }
    
  answer: false
```

Then you can generate the BlackBoard exam, LaTeX, and HTML preview using the
following command in the terminal:

```
quizml quiz.yaml
```

and this is what the provided default HTML preview looks like:

<img src="docs/figures/html-screenshot.jpg" width="260" />

and this is what the BlackBoard output would look like:

<img src="docs/figures/bb-screenshot.jpg" width="500" />

and this is what the provided LaTeX template pdf output would look like:

<img src="docs/figures/pdf-screenshot.jpg" width="500" />


# Getting Started

This is a command line application. Assuming that you have python and pip
installed, you can simply install it with:

```bash
pip install quizml
```

You will also need a LaTeX installation with `gs` and `pdflatex`.


