Module

class canvasapi.module.Module(requester, attributes)

Parameters:

requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.
attributes (dict) – The JSON object to build this object with.

create_module_item(module_item, **kwargs)

Create a module item.

Calls:: POST /api/v1/courses/:course_id/modules/:module_id/items
Parameters:: module_item (dict) – The attributes to create the module item with.
Returns:: The created module item.
Return type:: canvasapi.module.ModuleItem

delete(**kwargs)

Delete this module.

edit(**kwargs)

Update this module.

get_module_item(module_item, **kwargs)

Retrieve a module item by ID.

Calls:: GET /api/v1/courses/:course_id/modules/:module_id/items/:id
Parameters:: module_item (canvasapi.module.ModuleItem or dict) – The object or ID of the module item.
Return type:: canvasapi.module.ModuleItem

get_module_items(**kwargs)

List all of the items in this module.

Calls:: GET /api/v1/courses/:course_id/modules/:module_id/items
Return type:: canvasapi.paginated_list.PaginatedList of canvasapi.module.ModuleItem

relock(**kwargs)

Reset module progressions to their default locked state and recalculates them based on the current requirements.

Adding progression requirements to an active course will not lock students out of modules they have already unlocked unless this action is called.

ModuleItem

class canvasapi.module.ModuleItem(requester, attributes)

Parameters:

requester (canvasapi.requester.Requester) – The requester to pass HTTP requests through.
attributes (dict) – The JSON object to build this object with.

complete(**kwargs)

Mark this module item as done.

delete(**kwargs)

Delete this module item.

edit(**kwargs)

Update this module item.

uncomplete(**kwargs)

Mark this module item as not done.