cli_utils
================================

.. py:module:: evalml.utils.cli_utils

.. autoapi-nested-parse::

   CLI functions.



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



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   evalml.utils.cli_utils.get_evalml_black_config
   evalml.utils.cli_utils.get_evalml_pip_requirements
   evalml.utils.cli_utils.get_evalml_requirements_file
   evalml.utils.cli_utils.get_evalml_root
   evalml.utils.cli_utils.get_installed_packages
   evalml.utils.cli_utils.get_sys_info
   evalml.utils.cli_utils.print_deps
   evalml.utils.cli_utils.print_info
   evalml.utils.cli_utils.print_sys_info
   evalml.utils.cli_utils.standardize_format



Attributes Summary
~~~~~~~~~~~~~~~~~~~

.. autoapisummary::

   evalml.utils.cli_utils.CONDA_TO_PIP_NAME


Contents
~~~~~~~~~~~~~~~~~~~
.. py:data:: CONDA_TO_PIP_NAME
   

   

.. py:function:: get_evalml_black_config(evalml_path)

   Gets configuration for black.

   :param evalml_path: Path to evalml root.

   :returns: Dictionary of black configuration.


.. py:function:: get_evalml_pip_requirements(evalml_path, ignore_packages=None, convert_to_conda=True)

   Gets pip requirements for evalml (with pip packages converted to conda names)

   :param evalml_path: Path to evalml root.
   :param ignore_packages: List of packages to ignore. Defaults to None.

   :returns: List of pip requirements for evalml.


.. py:function:: get_evalml_requirements_file(evalml_path, requirements_file_path)

   Gets pip requirements for evalml as a requirements file

   :param evalml_path: Path to evalml root.
   :param requirements_file_path: Path to requirements file.

   :returns: Pip requirements for evalml in a singular string.


.. py:function:: get_evalml_root()

   Gets location where evalml is installed.

   :returns: Location where evalml is installed.


.. py:function:: get_installed_packages()

   Get dictionary mapping installed package names to their versions.

   :returns: Dictionary mapping installed package names to their versions.


.. py:function:: get_sys_info()

   Returns system information.

   :returns: List of tuples about system stats.


.. py:function:: print_deps()

   Prints the version number of each dependency.


.. py:function:: print_info()

   Prints information about the system, evalml, and dependencies of evalml.


.. py:function:: print_sys_info()

   Prints system information.


.. py:function:: standardize_format(packages, ignore_packages=None, convert_to_conda=True)

   Standardizes the format of the given packages.

   :param packages: Requirements package generator object.
   :param ignore_packages: List of packages to ignore. Defaults to None.

   :returns: List of packages with standardized format.