Skip to main content

Markdown support for canvas quiz

Project description

Canvas-markdown-quiz

Add markdown support for Canvas LMS quizzes.

Features

  • Markdown parsing
  • Latex Rendering (using Upmath as backend)
  • One markdown file per quiz

Quick Start

Markdown Writing

Following test_quiz.md, create your own quiz markdown file, like quiz1.md.

The structure of this md file should be like this:

---
(Some quiz configs)
---

# Your Title

(Your description)

---

(Block 1)

---

(Block 2)

---

...

---

(Block n)

Quiz config should be formatted as YAML, and the options are available at this page. You don't have to set title and description parameter in this config.


Each block is a question, and it should be like this:

---

```yaml
question_type: multiple_choice_question
points_possible: 1
answers:
    -
        answer_text: "Option 1"
        answer_weight: 100
    -
        answer_text: "Option 2"
        answer_weight: 0
```

Question description goes here.

```cpp
#include <stdio.h>

int main(){
    printf("Hello World!");
}
```
---

Quiz question config should be formatted as YAML, and the options are available at this page. You don't have to set the text parameter in this config.

Installation

  1. Install canvas-markdown-quiz
# using pip for python
pip install canvas-markdown-quiz

# using pip3 for python3
pip3 install canvas-markdown-quiz

Note: If you cannot install canvasapi, please check your network connection. We recommend you to use Tsinghua mirror in the mainland of China.

  1. Run command

Open your project directory, and type the following command to run.

For the first time, it will ask you some questions to save the configuration file.

cvs-makequiz <md filename>

Snapshot

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canvas-markdown-quiz-0.3.0.tar.gz (6.8 kB view details)

Uploaded Source

Built Distribution

canvas_markdown_quiz-0.3.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file canvas-markdown-quiz-0.3.0.tar.gz.

File metadata

  • Download URL: canvas-markdown-quiz-0.3.0.tar.gz
  • Upload date:
  • Size: 6.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for canvas-markdown-quiz-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3f6e3e7fc2241be3698ea695959a5bd2211d338bef15be74b51a2045a506c424
MD5 e7b839d2c3d9d5f5389ee8ed26247651
BLAKE2b-256 52b1c9f2e5bdd0265a649452bf11bce76c7d3e964ac1a5b37e5e7723447368c6

See more details on using hashes here.

File details

Details for the file canvas_markdown_quiz-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for canvas_markdown_quiz-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3fda64d972461cfa680e21ff43d9121298ad2d8a2f23e6b41ce177cb4038737
MD5 4a174a5aae1bff47c5f66ad2ff01f060
BLAKE2b-256 740aecc1228702bad1c212ee03c1a62f3c935e65e791ad2e6a5855df08a61a20

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page