ayx_plugin_sdk.cli package

Submodules

ayx_plugin_sdk.cli.environment_helpers module

Helper methods for managing virtual environment.

ayx_plugin_sdk.cli.environment_helpers.download_pip_packages(dest_dir: pathlib.Path, requirements_path: pathlib.Path)None[source]

Download the pip wheels and store in dest_dir.

ayx_plugin_sdk.cli.environment_helpers.environment_requires_update(workspace: Workspace)bool[source]

Determine if the virtual environments for the tools should be updated.

ayx_plugin_sdk.cli.environment_helpers.get_alteryx_path()pathlib.Path[source]

Get the path to Alteryx Designer.

ayx_plugin_sdk.cli.environment_helpers.get_tool_family_attribute_from_config(config_xml_path: pathlib.Path)str[source]

Get the ToolFamily attribute from the Config.xml file.

ayx_plugin_sdk.cli.workspace module

Configurations for managing workspace.

class ayx_plugin_sdk.cli.workspace.Workspace[source]

Bases: pydantic.main.BaseModel

Class wrapping all workspace configurations and handling basic workspace functions.

add_tool(tool_name: str, example_tool_name: str)None[source]

Add a tool the workspace.

build_yxi(destination_dir: pathlib.Path = PosixPath('.'), name_override: Optional[str] = None, include_dependencies: bool = True)pathlib.Path[source]

Build a YXI for the workspace.

delete_tool(tool_name: str)None[source]

Remove a tool from the workspace.

designer_path: Optional[Path] = None
classmethod initialize_workspace(workspace_directory: pathlib.Path)ayx_plugin_sdk.cli.workspace.Workspace[source]

Create a Workspace instance wrapping the configurations for the given workspace_directory.

requirements_tool: Optional[str] = None
classmethod setup_workspace_directory(workspace_directory: pathlib.Path)None[source]

Copy the base configs to the tool directory.

tool_family_name: Optional[str] = None
tools: List[WorkspaceTool] = None
workspace_dir: Path = None
yxi_name: Optional[str] = None

Copy and overwrite requirements.txt file from the source_directory to the destination_directory.

ayx_plugin_sdk.cli.workspace.create_workspace_yxi_folder(workspace_directory: pathlib.Path, temp_folder: pathlib.Path, tools_to_exclude: Optional[List[str]] = None)pathlib.Path[source]

Create a temporary yxi folder.

ayx_plugin_sdk.cli.workspace.delete_pycache_directories(root_dir: pathlib.Path)None[source]

Delete all the pycache subdirectories of a given root.

ayx_plugin_sdk.cli.workspace.get_install_dir()pathlib.Path[source]

Get the current directory.

ayx_plugin_sdk.cli.workspace_tool module

Workspace tool class definition.

class ayx_plugin_sdk.cli.workspace_tool.WorkspaceTool[source]

Bases: pydantic.main.BaseModel

Class wrapping Ayx Plugin Tools belonging to this workspace.

name: str = None
tool_directory: Path = None

ayx_plugin_sdk.cli.yxi_launcher module

Wrappers to handle interactions with yxi installer.

class ayx_plugin_sdk.cli.yxi_launcher.YxiCommands[source]

Bases: str, enum.Enum

YXI Executable commands.

Install = 'install-yxis'
Uninstall = 'uninstall-yxis'
class ayx_plugin_sdk.cli.yxi_launcher.YxiInstallTypes[source]

Bases: str, enum.Enum

YXI Executable Install Types.

Admin = 'Admin'
Alteryx = 'Alteryx'
User = 'User'
class ayx_plugin_sdk.cli.yxi_launcher.YxiLauncher(yxi_paths: List[pathlib.Path], alteryx_path: Optional[pathlib.Path] = None, clean: bool = False, update_conda: bool = False, install_type: Optional[ayx_plugin_sdk.cli.yxi_launcher.YxiInstallTypes] = None)[source]

Bases: object

Class wrapping install/uninstall commands from the yxi installer executable.

execute_install_command()None[source]

Execute the install yxi command from the yxi installer executable.

execute_uninstall_command()None[source]

Run the uninstall command from the yxi installer.

static get_executable_path()pathlib.Path[source]

Get the path to the yxi installer excutable.

static get_static_install_type()ayx_plugin_sdk.cli.yxi_launcher.YxiInstallTypes[source]

Get the install type for the yxi.

Module contents

Command line interface definitions.