The watcherclient.shell Module¶

Command-line interface to the Watcher API.

class watcherclient.shell.WatcherShell(**kwargs)[source]¶

Bases: cliff.app.App

Watcher command line interface.

build_option_parser(description, version, argparse_kwargs=None)[source]¶

Introduces global arguments for the application.

This is inherited from the framework.

configure_logging()[source]¶

Configure logging for the app.

create_client(args)[source]¶

prepare_to_run_command(cmd)[source]¶

Prepares to run the command

Checks if the minimal parameters are provided and creates the client interface. This is inherited from the framework.

run(argv)[source]¶

Equivalent to the main program for the application.

Parameters:	argv (list of str) – input arguments and options

watcherclient.shell.main(argv=['build_sphinx'])[source]¶