BlackboardQuizMaker

KO | EN

gitlite — search

#python #claude-code #ai #ai-agents #rust #typescript #developer-tools #react #claude #tauri #android #mcp

BlackboardQuizMaker

★ 24 Open GitHub ↗

A python script which lets you create multiple choice question pools with LaTeX math expressions and embed images, and upload them to Blackboard!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BlackboardQuizMaker

A python module which lets you conveniently create multiple choice and
numeric question pools on your own PC, containing LaTeX math and
embeded images, as a zip package which you can then import into
Blackboard.

Hopefully his will help you work around the limitations (and slow
performance) of the blackboard equation editor. It also allows you to
generate permutations of questions programmatically.

BH: multiple answer, short response true/false, ordering and matching questions now supported.

# Dependencies

This package requires a working installation of python, python-lxml,
and python-image, imagemagick, sympy, and LaTeX. You can install these on
ubuntu like so:

```
sudo apt-get install python-lxml python-image imagemagick  python-sympy
```

It also works on Windows!  If you use conda, this command will create
a new conda environment called 'blackboard' and download and
install all the necessary prerequisite packages.
Then the activate command will select that environment so that
you can run your scripts.
```
conda create -n blackboard lxml imagemagick pillow scipy sympy
conda activate blackboard
```

# How to use it (python)
Create an instance of the Package class using the "with" pattern, add one or more Pools, then add questions to each pool!
```python
#This code snippet is taken from python_example.py
import BlackboardQuiz

#You need a package, which is what you'll eventually upload to
#Blackboard/MyAberdeen
with BlackboardQuiz.Package("MyQuestionPools") as package:

#You may have multiple question pools in a single package, just
    #repeat this block with different pool names. This pool is just 
    with package.createPool('Unique questions', description="Questions which are not generated/calculated", instructions="") as pool:
        #We can do numerical questions
        pool.addNumQ('Douglas Adams Question', 'What is the answer to life, the universe, and everything?', 42, erramt=0.1, positive_feedback="Good, you have read well.", negative_feedback="Where have you been?")

#Or multiple choice questions
        pool.addMCQ('Shakespeare','To be, or not to be', answers=["To be.", "Not to be.", "That is the question.", "Both."],  correct=2, positive_feedback="Again, you have read well.", negative_feedback="Try reading Hamlet.")

#Maths can be included using latex
        pool.addMCQ('Math question', 'Please solve this "display" equation: $$\\int x\,dx=?$$',
                    answers=['$x$', '$\\frac{x^2}{2}$', '$gh$'],
                    correct=1,
                    positive_feedback="Well done!",
                    negative_feedback="Sorry, but the general rule for polynomial integration is $\\int x^n\\,dx=\\frac{x^{n+1}}{n+1}$ for $n\\neq -1$"
        )
        
        #Embedding external images is easy too and will automatically
        #be included into the package. Other HTML can also be used for
        #formatting, I don't check it.
        pool.addMCQ('HTML question', 'I cant believe that you can embed images! <img src="example_image.png"> Cool huh?',
                    ['Really cool.', 'Well, its not that impressive, its basic functionality.', 'Blackboard sucks.'],
                    correct=0)

#Create a pool with 10 variations of the same simple linear equation to solve.
    with package.createPool('Linear function solving', description="Solve the $y=m*x+c$", instructions="") as pool:
        import random
        for i in range(10):
            m = round(random.uniform(-10, 10), 2) #2 d.p. random m in [-10,10]
            y = round(random.uniform(-42, 42), 2) #2 d.p. random m in [-42,42]
            c = round(random.uniform(-100, 100), 2) #2 d.p. random m in [-100,100]
            x = round((y-c)/m, 2) #The answer
            # Add this as a numerical question, with a 1% margin for error
            pool.addNumQ('Linear function solving', 'Determine $x$ for $'+repr(y)+'='+repr(m)+'x+'+repr(c)+'$', answer=x, errfrac=0.05)
```

Running this will generate a package file called MyQuestionPools.zip.
To load the pools into Blackboard/MyAberdeen, just open up "Tests,
Surveys and Pools" on the "Course Tools" menu item, click "Pools",
then click "Import Pool" and provide the package zip file. You'll see
numerical questions appear like this:

![](https://raw.githubusercontent.com/toastedcrumpets/BlackboardQuizMaker/master/img/numq.png)

And multiple choice questions like this:

![](https://raw.githubusercontent.com/toastedcrumpets/BlackboardQuizMaker/master/img/mcq.png)

If you want to preview the questions, just unzip the package file and
take a look at the preview HTML pages the code generates for your
convenience, like below:

![](https://raw.githubusercontent.com/toastedcrumpets/BlackboardQuizMaker/master/img/preview.png)

There's much more advanced usage, including fill in the blanks (to
give multi-part questions) and computed functions just see the
[python_example.py](python_example.py) file.

# How the program works

Blackboard has an XML file format which it uses to upload/download
question sets or "pools" (or anything really). This file format lets
you also embed images and this is how the LaTeX support is
implemented. All strings are searched for `$` which are used to
indicate a LaTeX string. Each of these are rendered into a png using
the tex2im script included (matplotlib is an alternative technique but
I found it couldn't calculate correct bounding boxes). The resulting
png images are then directly embedded into the zip file and the
formulas are replaced by html img tags which link to these images.

The main difficulties I've faced is to reverse engineer how blackboard
attaches unique identifiers to files. This was figured out by "reverse
engineering" their file format (downloading a question set with an
embedded image in it and looking at the tags). There is a slight issue
with the current implementation in that it stores the images in a
ugly-named subdirectory of the course. I think this can be fixed by
adding additional xml tags but I'm not sure its worth the effort.

BlackboardQuizMaker

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README