autograder.cli.users

The autograder.cli.users package contains tools to manage autograder users.

This package contains the following CLI tools:


autograder.cli.users.auth

Authenticate as a user.

usage: python3 -m autograder.cli.users.auth [-h] [--version] [--server SERVER]
                                            [--user USER] [--pass PASS]
                                            [--testing-mode]
                                            [--format {json,table,text}]
                                            [--include-extra-fields]
                                            [--pretty-headers]
                                            [--skip-headers]

autograder.cli.users.get

Get information about a server user.

usage: python3 -m autograder.cli.users.get [-h] [--version] [--server SERVER]
                                           [--user USER] [--pass PASS]
                                           [--target-email TARGET_EMAIL]
                                           [--testing-mode]
                                           [--format {json,table,text}]
                                           [--include-extra-fields]
                                           [--pretty-headers] [--skip-headers]

autograder.cli.users.list

List the users on the server.

usage: python3 -m autograder.cli.users.list [-h] [--version] [--server SERVER]
                                            [--user USER] [--pass PASS]
                                            [--target-users TARGET_USERS]
                                            [--testing-mode]
                                            [--format {json,table,text}]
                                            [--include-extra-fields]
                                            [--pretty-headers]
                                            [--skip-headers]

autograder.cli.users.password.*

The `autograder.cli.users.password` package contains tools to manage user passwords.


autograder.cli.users.password.change

Change your password to the one provided.

usage: python3 -m autograder.cli.users.password.change [-h] [--version]
                                                       [--server SERVER]
                                                       [--user USER]
                                                       [--pass PASS]
                                                       --new-pass NEW_PASS
                                                       [--testing-mode]

autograder.cli.users.password.reset

Request a password reset.

usage: python3 -m autograder.cli.users.password.reset [-h] [--version]
                                                      [--server SERVER]
                                                      [--user USER]
                                                      [--testing-mode]

autograder.cli.users.remove

Remove a user from the server.

usage: python3 -m autograder.cli.users.remove [-h] [--version]
                                              [--server SERVER] [--user USER]
                                              [--pass PASS]
                                              [--target-email TARGET_EMAIL]
                                              [--testing-mode]

autograder.cli.users.tokens.*

The `autograder.cli.users.tokens` package contains tools to manage user tokens.


autograder.cli.users.tokens.create

Create a new token.

usage: python3 -m autograder.cli.users.tokens.create [-h] [--version]
                                                     [--server SERVER]
                                                     [--user USER]
                                                     [--pass PASS]
                                                     [--target-user TARGET_USER]
                                                     [--name NAME]
                                                     [--testing-mode]

autograder.cli.users.tokens.delete

Delete a token.

usage: python3 -m autograder.cli.users.tokens.delete [-h] [--version]
                                                     [--server SERVER]
                                                     [--user USER]
                                                     [--pass PASS]
                                                     [--target-user TARGET_USER]
                                                     --token-id TOKEN_ID
                                                     [--testing-mode]

autograder.cli.users.tokens.list

List tokens for a user.

usage: python3 -m autograder.cli.users.tokens.list [-h] [--version]
                                                   [--server SERVER]
                                                   [--user USER] [--pass PASS]
                                                   [--target-user TARGET_USER]
                                                   [--testing-mode]

autograder.cli.users.upsert-file

Upsert server users from a TSV file.

usage: python3 -m autograder.cli.users.upsert-file [-h] [--version]
                                                   [--server SERVER]
                                                   [--user USER] [--pass PASS]
                                                   [--dry-run]
                                                   [--skip-inserts]
                                                   [--skip-updates]
                                                   [--send-emails]
                                                   [--testing-mode]
                                                   PATH

autograder.cli.users.upsert

Upsert a server user.

usage: python3 -m autograder.cli.users.upsert [-h] [--version]
                                              [--server SERVER] [--user USER]
                                              [--pass PASS] [--dry-run]
                                              [--skip-inserts]
                                              [--skip-updates] [--send-emails]
                                              --new-email NEW_EMAIL
                                              [--new-name NEW_NAME]
                                              [--new-pass NEW_PASS]
                                              [--new-role {unknown,user,creator,admin,owner}]
                                              [--new-course NEW_COURSE]
                                              [--new-course-role {unknown,other,student,grader,admin,owner}]
                                              [--new-lms-id NEW_LMS_ID]
                                              [--testing-mode]
1"""
2The `autograder.cli.users` package contains tools to manage autograder users.
3"""