Skip to content

API & CLI Reference

This section provides auto-generated reference documentation for mograder's Python API and CLI.

Runtime API

The Runtime API covers the public symbols used inside notebooks:

  • check() — run boolean checks and display coloured feedback
  • Grader — per-question marks with reactive score tracking
  • hint() — progressive hints in collapsed accordions

CLI Reference

The CLI Reference documents all mograder commands and their options, auto-generated from the Click decorators.

Python Modules

Module Description
Configuration MograderConfig, load_config()
Models CheckResult, NotebookResult, data classes
Transport Transport protocol, build_transport()
Gradebook Gradebook class (SQLite)
Markers process_file(), strip_solutions()
Moodle API MoodleAPIClient