perun.api.cli

Command line API.

Attributes

log

Functions

_get_arg_parser(→ argparse.ArgumentParser)

cli()

Command line entrypoint.

showconf(args)

Print current perun configuration in INI format.

sensors(args)

Print available sensors.

metadata(args)

Print global metadata dictionaries in json format.

export(args)

Export existing perun output file to another format.

monitor(args)

Gather power consumption from hardware devices while SCRIPT [SCRIPT_ARGS] is running.

Module Contents

perun.api.cli.log
perun.api.cli._get_arg_parser() argparse.ArgumentParser
perun.api.cli.cli()

Command line entrypoint.

perun.api.cli.showconf(args: argparse.Namespace)

Print current perun configuration in INI format.

perun.api.cli.sensors(args: argparse.Namespace)

Print available sensors.

perun.api.cli.metadata(args: argparse.Namespace)

Print global metadata dictionaries in json format.

perun.api.cli.export(args: argparse.Namespace)

Export existing perun output file to another format.

perun.api.cli.monitor(args: argparse.Namespace)

Gather power consumption from hardware devices while SCRIPT [SCRIPT_ARGS] is running.

SCRIPT is a path to the python script to monitor, run with arguments SCRIPT_ARGS.