client.cli
==========

.. py:module:: client.cli

.. autoapi-nested-parse::

   Client command line interface for workflow/task status and concurrency limiting.



Classes
-------

.. autoapisummary::

   client.cli._HelpAction
   client.cli.ClientCLI


Functions
---------

.. autoapisummary::

   client.cli.main


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

.. py:class:: _HelpAction(option_strings, dest=SUPPRESS, default=SUPPRESS, help=None)

   Bases: :py:obj:`argparse._HelpAction`


   To show help for all subparsers in one place.


   .. py:method:: __call__(parser: Any, namespace: argparse.Namespace, values: Any, option_string: Optional[str] = None) -> None

      Add subparsers' help info when jobmon --help is called.



.. py:class:: ClientCLI

   Bases: :py:obj:`jobmon.core.cli.CLI`


   Client command line interface for workflow/task status and concurrency limiting.


   .. py:attribute:: parser


   .. py:attribute:: _subparsers


   .. py:method:: limit_checker(limit: Any) -> int
      :staticmethod:


      Coerce to int and check that the limit is greater than 0.



   .. py:method:: workflow_status(args: argparse.Namespace) -> None
      :staticmethod:


      Workflow status checking options.



   .. py:method:: workflow_tasks(args: argparse.Namespace) -> None
      :staticmethod:


      Check the tasks for a given workflow.



   .. py:method:: task_template_resources(args: argparse.Namespace) -> None
      :staticmethod:


      Aggregates the resource usage for a given TaskTemplateVersion.



   .. py:method:: task_status(args: argparse.Namespace) -> None
      :staticmethod:


      Check task status.



   .. py:method:: update_task_status(args: argparse.Namespace) -> None
      :staticmethod:


      Manually update task status for resumes, reruns, etc.



   .. py:method:: concurrency_limit(args: argparse.Namespace) -> None
      :staticmethod:


      Set a limit for the number of tasks that can run concurrently.



   .. py:method:: task_dependencies(args: argparse.Namespace) -> None
      :staticmethod:


      Get task's upstream and downstream tasks and their status.



   .. py:method:: workflow_reset(args: argparse.Namespace) -> None
      :staticmethod:


      Manually reset a workflow.



   .. py:method:: jobmon_version(args: argparse.Namespace) -> None
      :staticmethod:


      Return the jobmon version.



   .. py:method:: resource_yaml(args: argparse.Namespace) -> None
      :staticmethod:


      Create resource yaml.



   .. py:method:: resume_workflow(args: argparse.Namespace) -> None
      :staticmethod:


      Resume a workflow from a workflow ID.



   .. py:method:: get_filepaths(args: argparse.Namespace) -> None
      :staticmethod:



   .. py:method:: update_config(args: argparse.Namespace) -> None
      :staticmethod:


      Update a configuration value in the defaults.yaml file.



   .. py:method:: _add_version_subparser() -> None


   .. py:method:: _add_workflow_status_subparser() -> None


   .. py:method:: _add_workflow_tasks_subparser() -> None


   .. py:method:: _add_task_template_resources_subparser() -> None


   .. py:method:: _add_task_status_subparser() -> None


   .. py:method:: _add_update_task_status_subparser() -> None


   .. py:method:: _add_concurrency_limit_subparser() -> None


   .. py:method:: _add_task_dependencies_subparser() -> None


   .. py:method:: _add_workflow_reset_subparser() -> None


   .. py:method:: _add_create_resource_yaml_subparser() -> None


   .. py:method:: _add_get_filepaths_subparser() -> None


   .. py:method:: _add_resume_workflow_parser() -> None


   .. py:method:: _add_update_config_subparser() -> None


.. py:function:: main(argstr: Optional[str] = None) -> None

   Create CLI.