aiq.cli.commands.workflow.workflow_commands

Attributes

logger

Exceptions

AIQPackageError

Common base class for all non-exit exceptions.

Functions

get_repo_root()
_get_module_name(workflow_name)
_generate_valid_classname(class_name)
find_package_root(→ pathlib.Path | None)	Find the root directory for a python package installed with the "editable" option.
get_workflow_path_from_name(workflow_name)	Look up the location of an installed AIQ Toolkit workflow and retrieve the root directory of the installed workflow.
create_command(workflow_name, install, workflow_dir, ...)	Create a new AIQ Toolkit workflow using templates.
reinstall_command(workflow_name)	Reinstall an AIQ Toolkit workflow to update dependencies and code changes.
delete_command(workflow_name)	Delete an AIQ Toolkit workflow and uninstall its package.

Module Contents

logger

exception AIQPackageError

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

get_repo_root()

_get_module_name(workflow_name: str)

_generate_valid_classname(class_name: str)

find_package_root(package_name: str) → pathlib.Path | None

Find the root directory for a python package installed with the “editable” option.

Args:

package_name: The python package name as it appears when importing it into a python script

Returns:

Posix path pointing to the package root

get_workflow_path_from_name(workflow_name: str)

Look up the location of an installed AIQ Toolkit workflow and retrieve the root directory of the installed workflow.

Args:

workflow_name: The name of the workflow.

Returns:

Path object for the workflow’s root directory.

create_command(

workflow_name: str,

install: bool,

workflow_dir: str,

description: str,

)

Create a new AIQ Toolkit workflow using templates.

Args:

workflow_name (str): The name of the new workflow. install (bool): Whether to install the workflow package immediately. workflow_dir (str): The directory to create the workflow package. description (str): Description to pre-popluate the workflow docstring.

reinstall_command(workflow_name)

Reinstall an AIQ Toolkit workflow to update dependencies and code changes.

Args:

workflow_name (str): The name of the workflow to reinstall.

delete_command(workflow_name: str)

Delete an AIQ Toolkit workflow and uninstall its package.

Args:

workflow_name (str): The name of the workflow to delete.