Browser¶

Public browser and JupyterLab API.

The core models are discriminated unions: Rubric by locked and Workbook by content.

Namespaces¶

Namespace	Description
Assignment	Utilities for preparing and issuing serialized notebook assignments.
Correxit	Tokens and contracts for composing Correxit JupyterLab plugins.
Rubric	Immutable assignment, cell, reference, and scoring data.
Workbook	Notebook state, identity, lifecycle, and grading operations.

Type Aliases¶

Rubric¶

Rubric = Locked | Unlocked

Defined in: src/correxit/rubric.ts:17

A rubric is the specification that describes how to augment a Jupyter notebook with the functionality of a Correxit workbook, including cell correction configuration, assignment metadata, etc.

Rubrics are immutable. locked discriminates their state: a Rubric.Locked rubric has no key; an Rubric.Unlocked rubric holds its key in memory.

Workbook¶

Workbook = Headed | Headless

Defined in: src/correxit/workbook.ts:28

A Correxit workbook, discriminated by content.

A Workbook.Headed workbook has a live notebook widget; a Workbook.Headless workbook has null content but retains its document context. Use Workbook.headed and Workbook.headless to narrow it.

Variables¶

default¶

const default: (JupyterFrontEndPlugin\<Collector> | JupyterFrontEndPlugin\<Distributor> | JupyterFrontEndPlugin\<void> | JupyterFrontEndPlugin\<Monitor> | JupyterFrontEndPlugin\<Registrar> | JupyterFrontEndPlugin\<Submitter> | JupyterFrontEndPlugin\<Unlocker>)[]

Defined in: src/plugins.tsx:482

JupyterLab plugins provided by the Correxit package.