EduLinq Quiz Composer API Reference: latest (066a96b)
quizcomp
The quizcomp package contains general tools and abstractions for
working with quizzes in the Quiz Composer interface.
This package contains the following CLI tools:
The `quizcomp.cli` package contains tools for running the quizcomp. Each package can be invoked to list the tools (or subpackages) it contains. Each tool includes a help prompt that accessed with the `-h`/`--help` flag.
The `quizcomp.cli.canvas` package contains tools for interacting with the Canvas LMS.
Upload a quiz.
usage: python3 -m quizcomp.cli.canvas.upload [-h] [--version]
[--server SERVER]
[--server-type {blackboard,canvas,moodle}]
[--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD]
[--auth-token AUTH_TOKEN]
[--course COURSE]
[--format {json,table,text}]
[--include-extra-fields]
[--pretty-headers]
[--skip-headers] [--force]
QUIZ_PATH
The `quizcomp.cli.gradescope` package contains tools for interacting with Gradescope.
Create and upload a GradeScope PDF quiz.
usage: python3 -m quizcomp.cli.gradescope.upload [-h] [--version]
[--out-dir OUT_DIR]
[--skip-tex] [--skip-pdf]
[--variants VARIANTS]
[--skip-key] [--seed SEED]
[--rubric] --course COURSE_ID
--user USER --pass PASSWORD
[--force] [--save-http]
PATH
The `quizcomp.cli.parse` package contains tools for parsing various objects/files from disk.
Parse a single file and output the results of the parse.
usage: python3 -m quizcomp.cli.parse.file [-h] [--version]
[--format {canvas,html,json,md,tex,text}]
PATH
Parse a single quiz question (JSON file) and output the result in the specified format.
usage: python3 -m quizcomp.cli.parse.question [-h] [--version]
[--format {canvas,html,json,md,tex,qti}]
[--key]
PATH
Parse a quiz for the purposes of testing. The quiz will be parsed one and content will be generated for (but not output) for each of the specified format (or none if none are specified).
usage: python3 -m quizcomp.cli.parse.quiz-for-testing [-h] [--version] [--key]
[--all-questions]
[--seed SEED]
PATH [FORMAT ...]
Parse a single quiz and output the results of the parse.
usage: python3 -m quizcomp.cli.parse.quiz [-h] [--version]
[--format {canvas,html,json,md,tex,qti}]
[--key] [--all-questions]
[--no-shuffle] [--seed SEED]
PATH
The `quizcomp.cli.pdf` package contains tools for creating PDF files.
Create a PDF quiz.
usage: python3 -m quizcomp.cli.pdf.create [-h] [--version] [--out-dir OUT_DIR]
[--skip-tex] [--skip-pdf]
[--variants VARIANTS] [--skip-key]
[--seed SEED]
PATH
Create a PDF from a single question.
usage: python3 -m quizcomp.cli.pdf.create_question [-h] [--version]
[--out-dir OUT_DIR]
[--skip-tex] [--skip-pdf]
[--variants VARIANTS]
[--skip-key] [--seed SEED]
PATH
The `quizcomp.cli.qti` package contains tools for interacting with QTI files.
Parse a quiz and upload the quiz to Canvas.
usage: python3 -m quizcomp.cli.qti.create [-h] [--version] [--canvas]
[--out OUT]
PATH
Get the version of the EduLinq Quiz Composer package.
usage: python3 -m quizcomp.cli.version [-h] [--version]