lms.cli.courses.groups.memberships

The lms.cli.courses.groups.memberships package contains tools for interacting with LMS course group memberships.

This package contains the following CLI tools:


lms.cli.courses.groups.memberships.add

Add users to a group.

usage: python3 -m lms.cli.courses.groups.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]
                                                         [--strict]
                                                         USER_QUERY
                                                         [USER_QUERY ...]

lms.cli.courses.groups.memberships.list

List the membership of a group.

usage: python3 -m lms.cli.courses.groups.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]
                                                          [--group GROUP]
                                                          [--format {json,table,text}]
                                                          [--include-extra-fields]
                                                          [--pretty-headers]
                                                          [--skip-headers]

lms.cli.courses.groups.memberships.set

Set users in a group to exactly match the listed users.

usage: python3 -m lms.cli.courses.groups.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]
                                                         [--strict]
                                                         [USER_QUERY ...]

lms.cli.courses.groups.memberships.subtract

Subtract users from a group.

usage: python3 -m lms.cli.courses.groups.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] [--strict]
       USER_QUERY [USER_QUERY ...]
1"""
2The `lms.cli.courses.groups.memberships` package contains tools for interacting with LMS course group memberships.
3"""