lms
The lms.cli.courses.groups package contains tools for interacting with LMS course groups.
This package contains the following CLI tools:
Create a group.
usage: python3 -m lms.cli.courses.groups.create [-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]
GROUP_SET_NAME
Delete a group.
usage: python3 -m lms.cli.courses.groups.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]
[--group GROUP]
[--format {json,table,text}]
[--include-extra-fields]
[--pretty-headers]
[--skip-headers]
Get specific group of a group set.
usage: python3 -m lms.cli.courses.groups.get [-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] [--strict]
[GROUP_QUERY ...]
List the groups of a group set.
usage: python3 -m lms.cli.courses.groups.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]
The `lms.cli.courses.groups.memberships` package contains tools for interacting with LMS course group memberships.
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 ...]
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]
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 ...]
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 ...]