lms.cli.courses.users.list

List the users of a course.

usage: python3 -m lms.cli.courses.users.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]

List the users of a course.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --course COURSE       The course to target for this operation.

server options:
  --server SERVER       The address of the LMS server to connect to.
  --server-type {blackboard,canvas,moodle}
                        The type of LMS being connected to (this can normally
                        be guessed from the server address).

authentication options:
  --auth-user AUTH_USER
                        The user to authenticate with.
  --auth-password AUTH_PASSWORD
                        The password to authenticate with.
  --auth-token AUTH_TOKEN
                        The token to authenticate with.

output formatting options:
  --format {json,table,text}
                        The format to display the output as (default: text).
  --include-extra-fields
                        Include non-common (usually LMS-specific) fields in
                        results (default: False).
  --pretty-headers      When displaying headers, try to make them look
                        "pretty" (default: False).
  --skip-headers        Skip headers when outputting results, will not apply
                        to all formats (default: False).

 1"""
 2List the users of a course.
 3"""
 4
 5import argparse
 6import sys
 7
 8import lms.backend.instance
 9import lms.cli.common
10import lms.cli.parser
11import lms.model.base
12
13def run_cli(args: argparse.Namespace) -> int:
14    """ Run the CLI. """
15
16    config = args._config
17
18    backend = lms.backend.instance.get_backend(**config)
19
20    course_query = lms.cli.common.check_required_course(backend, config)
21    if (course_query is None):
22        return 1
23
24    users = backend.courses_users_resolve_and_list(course_query)
25
26    output = lms.model.base.base_list_to_output_format(users, args.output_format,
27            skip_headers = args.skip_headers,
28            pretty_headers = args.pretty_headers,
29            include_extra_fields = args.include_extra_fields,
30    )
31
32    print(output)
33
34    return 0
35
36def main() -> int:
37    """ Get a parser, parse the args, and call run. """
38    return run_cli(_get_parser().parse_args())
39
40def _get_parser() -> argparse.ArgumentParser:
41    """ Get the parser. """
42
43    return lms.cli.parser.get_parser(__doc__.strip(),
44            include_output_format = True,
45            include_course = True,
46    )
47
48if (__name__ == '__main__'):
49    sys.exit(main())
def run_cli(args: argparse.Namespace) -> int: 
14def run_cli(args: argparse.Namespace) -> int:
15    """ Run the CLI. """
16
17    config = args._config
18
19    backend = lms.backend.instance.get_backend(**config)
20
21    course_query = lms.cli.common.check_required_course(backend, config)
22    if (course_query is None):
23        return 1
24
25    users = backend.courses_users_resolve_and_list(course_query)
26
27    output = lms.model.base.base_list_to_output_format(users, args.output_format,
28            skip_headers = args.skip_headers,
29            pretty_headers = args.pretty_headers,
30            include_extra_fields = args.include_extra_fields,
31    )
32
33    print(output)
34
35    return 0

Run the CLI.

def main() -> int: 
37def main() -> int:
38    """ Get a parser, parse the args, and call run. """
39    return run_cli(_get_parser().parse_args())

Get a parser, parse the args, and call run.