lms .cli .courses .groupsets
The lms.cli.courses.groupsets package contains tools for interacting with LMS course group sets.
This package contains the following CLI tools:
Create a group set.
usage: python3 -m lms.cli.courses.groupsets.create [-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]
GROUP_SET_NAME
Delete a group set.
usage: python3 -m lms.cli.courses.groupsets.delete [-h] [--version]
[--server SERVER]
[--server-type {blackboard,canvas,moodle}]
[--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD]
[--auth-token AUTH_TOKEN]
[--course COURSE]
[--groupset GROUPSET]
[--format {json,table,text}]
[--include-extra-fields]
[--pretty-headers]
[--skip-headers]
Get specific group sets of a course.
usage: python3 -m lms.cli.courses.groupsets.get [-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] [--strict]
[GROUP_SET_QUERY ...]
List the group sets of a course.
usage: python3 -m lms.cli.courses.groupsets.list [-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]
The `lms.cli.courses.groupsets.memberships` package contains tools for interacting with LMS course group set memberships.
Add users to a group set.
usage: python3 -m lms.cli.courses.groupsets.memberships.add
[-h] [--version] [--server SERVER]
[--server-type {blackboard,canvas,moodle}] [--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD] [--auth-token AUTH_TOKEN]
[--course COURSE] [--groupset GROUPSET] [--group GROUP]
[--format {json,table,text}] [--include-extra-fields]
[--pretty-headers] [--skip-headers] [--skip-rows SKIP_ROWS] [--strict]
PATH
List the membership of a group set.
usage: python3 -m lms.cli.courses.groupsets.memberships.list
[-h] [--version] [--server SERVER]
[--server-type {blackboard,canvas,moodle}] [--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD] [--auth-token AUTH_TOKEN]
[--course COURSE] [--groupset GROUPSET] [--format {json,table,text}]
[--include-extra-fields] [--pretty-headers] [--skip-headers]
Set membership for a group set.
usage: python3 -m lms.cli.courses.groupsets.memberships.set
[-h] [--version] [--server SERVER]
[--server-type {blackboard,canvas,moodle}] [--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD] [--auth-token AUTH_TOKEN]
[--course COURSE] [--groupset GROUPSET] [--group GROUP]
[--format {json,table,text}] [--include-extra-fields]
[--pretty-headers] [--skip-headers] [--skip-rows SKIP_ROWS] [--strict]
PATH
Subtract users from a group set.
usage: python3 -m lms.cli.courses.groupsets.memberships.subtract
[-h] [--version] [--server SERVER]
[--server-type {blackboard,canvas,moodle}] [--auth-user AUTH_USER]
[--auth-password AUTH_PASSWORD] [--auth-token AUTH_TOKEN]
[--course COURSE] [--groupset GROUPSET] [--group GROUP]
[--format {json,table,text}] [--include-extra-fields]
[--pretty-headers] [--skip-headers] [--skip-rows SKIP_ROWS] [--strict]
PATH