Overview

Installation

$ pip install codepost-powertools

Usage

You should have a dedicated folder for the usage of these tools, since it requires an input config file and outputs files for certain commands / functions. It is recommended to use a virtual environment for this:

$ python -m venv env
$ source env/bin/activate
(env) $ python -m pip install codepost-powertools
(env) $ cptools --help
(env) $ python my_script.py

By default, the package will look for a configuration file called config.yaml that contains a field "api_key" for your codePost API key. See here for instructions on how to access your codePost API key, as well as more information on the config YAML file. You must have admin access to all the courses you wish to access with this package.

Note

This package does not use the default codepost-config.yaml file that the codepost package uses. However, you can pass a custom path to your config file to log_in_codepost() if you wish.

Command Line Usage

You can access the command-line interface with the cptools command:

$ cptools --help

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

  The `codepost_powertools` package on the command line.

Please see Command-Line Interface for more information.

Script Usage

You can import the package in a script:

import codepost_powertools as cptools

# Log in to codePost
cptools.log_in_codepost()

# Call methods

Please see Writing Scripts for more information.