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:


lms.cli.courses.groupsets.create

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

lms.cli.courses.groupsets.delete

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]

lms.cli.courses.groupsets.get

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 ...]

lms.cli.courses.groupsets.list

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]

lms.cli.courses.groupsets.memberships.*

The `lms.cli.courses.groupsets.memberships` package contains tools for interacting with LMS course group set memberships.


lms.cli.courses.groupsets.memberships.add

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

lms.cli.courses.groupsets.memberships.list

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]

lms.cli.courses.groupsets.memberships.set

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

lms.cli.courses.groupsets.memberships.subtract

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
1"""
2The `lms.cli.courses.groupsets` package contains tools for interacting with LMS course group sets.
3"""