perun.api.cli
=============

.. py:module:: perun.api.cli

.. autoapi-nested-parse::

   Command line API.



Attributes
----------

.. autoapisummary::

   perun.api.cli.log


Functions
---------

.. autoapisummary::

   perun.api.cli._get_arg_parser
   perun.api.cli.cli
   perun.api.cli.showconf
   perun.api.cli.sensors
   perun.api.cli.metadata
   perun.api.cli.export
   perun.api.cli.monitor


Module Contents
---------------

.. py:data:: log

.. py:function:: _get_arg_parser() -> argparse.ArgumentParser

.. py:function:: cli()

   Command line entrypoint.


.. py:function:: showconf(args: argparse.Namespace)

   Print current perun configuration in INI format.


.. py:function:: sensors(args: argparse.Namespace)

   Print available sensors.


.. py:function:: metadata(args: argparse.Namespace)

   Print global metadata dictionaries in json format.


.. py:function:: export(args: argparse.Namespace)

   Export existing perun output file to another format.


.. py:function:: 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.