Command-Line Interface

This page was automatically generated when building the docs.

cptools command

Usage: cptools [OPTIONS] COMMAND [ARGS]...

  The `codepost_powertools` package on the command line.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Grading Commands:
  ids     Creates a mapping from student emails to submission ids.

Rubric Commands:
  export  Exports a codePost rubric to a Google Sheet.

Grading Commands

cptools ids command

See the paired function codepost_powertools.grading.get_ids_mapping().

Usage: cptools ids [OPTIONS] COURSE_NAME COURSE_PERIOD ASSIGNMENT

  Creates a mapping from student emails to submission ids.

  The mapping will be saved at "<OUTPUT>/file", where "file" is the value of
  the "--file" option.

Options:
  -f, --file FILE  A filename to save the csv data.  [default: ids.csv]
  --help           Show this message and exit.

Rubric Commands

cptools export command

See the paired function codepost_powertools.rubric.export_rubric().

Usage: cptools export [OPTIONS] COURSE_NAME COURSE_PERIOD SHEET_NAME
                      ASSIGNMENTS...

  Exports a codePost rubric to a Google Sheet.

Options:
  ASSIGNMENTS...          The names of the assignments to export. At least 1 is
                          required.
  -w, --wipe              Wipe all the existing worksheets.
  -r, --replace           Replace the existing assignment worksheets.
  -ci, --count-instances  Count the instances of rubric comments. Warning: May
                          be slow.
  --help                  Show this message and exit.