ayx_python_sdk.cli package¶
Submodules¶
ayx_python_sdk.cli.utilities module¶
Helper methods for managing the virtual environment.
- ayx_python_sdk.cli.utilities.environment_requires_update(workspace: Workspace) bool [source]¶
Determine if the virtual environments for the tools should be updated.
- ayx_python_sdk.cli.utilities.get_alteryx_path() pathlib.Path [source]¶
Get the path to Alteryx Designer.
- ayx_python_sdk.cli.utilities.get_install_dir() pathlib.Path [source]¶
Get the current directory.
- ayx_python_sdk.cli.utilities.get_tool_family_attribute_from_config(config_xml_path: pathlib.Path) str [source]¶
Get the ToolFamily attribute from the Config.xml file.
ayx_python_sdk.cli.workspace module¶
Configurations for managing the workspace.
- class ayx_python_sdk.cli.workspace.Workspace(*, workspace_dir: pathlib.Path, tools: List[str], yxi_name: str, tool_family_name: str)[source]¶
Bases:
pydantic.main.BaseModel
Class that wraps all workspace configurations and handles basic workspace functions.
- add_tool_from_template(tool_name: str, template_tool_name: str) None [source]¶
Add a tool to the workspace.
- classmethod build_workspace(workspace_directory: pathlib.Path, allow_creation: bool = False) ayx_python_sdk.cli.workspace.Workspace [source]¶
Create a workspace instance that wraps the configurations for the given workspace_directory.
- build_yxi(output_yxi_path: pathlib.Path, package_requirements: bool = True) None [source]¶
Build a YXI for the workspace.
- classmethod migrate_raw_workspace_config(data: Dict) Dict [source]¶
Migrate raw JSON from old format to new format.
- workspace_dir: pathlib.Path¶
ayx_python_sdk.cli.yxi_builder module¶
Class for building YXIs.
- class ayx_python_sdk.cli.yxi_builder.YxiBuilder(workspace_dir: pathlib.Path, output_yxi_path: pathlib.Path, requirements_tool: str, package_requirements: bool = True)[source]¶
Bases:
object
YXI Builder class.
ayx_python_sdk.cli.yxi_installer module¶
Wrappers to handle interactions with YXI Installer.
- class ayx_python_sdk.cli.yxi_installer.YxiInstaller(yxi_paths: List[pathlib.Path], alteryx_path: pathlib.Path, clean: bool = False, update_venv: bool = False)[source]¶
Bases:
object
Class that wraps install commands from the YXI Installer executable.
Module contents¶
Command line interface definitions.