.. _f-clihelper:

module ``cli.cli_helper``
=========================







Short summary
+++++++++++++

module ``pyquickhelper.cli.cli_helper``

Automate the creation of a parser based on a function.


:githublink:`%|py|5`






Functions
+++++++++

+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| function                                                                                       | truncated documentation                                                                                               |
+================================================================================================+=======================================================================================================================+
| :func:`call_cli_function <pyquickhelper.cli.cli_helper.call_cli_function>`                     | Calls a function *f* given parsed arguments.                                                                          |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`call_gui_function <pyquickhelper.cli.cli_helper.call_gui_function>`                     | Opens a GUI based on :epkg:`tkinter` which allows the user to run a command line through a windows. The function ...  |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`clean_documentation_for_cli <pyquickhelper.cli.cli_helper.clean_documentation_for_cli>` | Cleans the documentation before integrating into a command line documentation.                                        |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`cli_main_helper <pyquickhelper.cli.cli_helper.cli_main_helper>`                         | Implements the main commmand line for a module.                                                                       |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`create_cli_argument <pyquickhelper.cli.cli_helper.create_cli_argument>`                 | Adds an argument for :epkg:`*py:argparse:ArgumentParser`.                                                             |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`create_cli_parser <pyquickhelper.cli.cli_helper.create_cli_parser>`                     | Automatically creates a parser based on a function, its signature with annotation and its documentation (assuming ... |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :func:`guess_module_name <pyquickhelper.cli.cli_helper.guess_module_name>`                     | Guesses the module name based on a function.                                                                          |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.cli.cli_helper
    :members:
    :special-members: __init__
    :show-inheritance: