Text Utils

zenml.cli.text_utils

Utilities for CLI output.

zenml_go_notebook_tutorial_message(ipynb_files)

Outputs a message to the user about the zenml go tutorial.

Parameters:

Name	Type	Description	Default
ipynb_files	List[str]	A list of IPython Notebook files.	required

Returns:

Type	Description
Markdown	A Markdown object.

Source code in zenml/cli/text_utils.py

def zenml_go_notebook_tutorial_message(ipynb_files: List[str]) -> Markdown:
    """Outputs a message to the user about the `zenml go` tutorial.

    Args:
        ipynb_files: A list of IPython Notebook files.

    Returns:
        A Markdown object.
    """
    ipynb_files = [f"- {fi} \n" for fi in ipynb_files]
    return Markdown(
        f"""
## 🧑‍🏫 Get started with ZenML

The ZenML tutorial repository was cloned to your current working directory.
Within the repository you can get started on one of these notebooks:
{''.join(ipynb_files)}
Next we will start a Jupyter notebook server. Feel free to try your hand at our
tutorial notebooks. If your browser does not open automatically click one of the
links below.\n

"""
    )