ayx_python_sdk.cli package¶
Submodules¶
ayx_python_sdk.cli.utilities module¶
Helper methods for managing the virtual environment.
ayx_python_sdk.cli.workspace module¶
Configurations for managing the workspace.
- class ayx_python_sdk.cli.workspace.Workspace(*, workspace_dir: Path, tools: List[str], yxi_name: str, tool_family_name: str)[source]¶
Bases:
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: Path, allow_creation: bool = False) Workspace [source]¶
Create a workspace instance that wraps the configurations for the given workspace_directory.
- build_yxi(output_yxi_path: 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.
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'tool_family_name': FieldInfo(annotation=str, required=True), 'tools': FieldInfo(annotation=List[str], required=True), 'workspace_dir': FieldInfo(annotation=Path, required=True), 'yxi_name': FieldInfo(annotation=str, required=True)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
ayx_python_sdk.cli.yxi_builder module¶
Class for building YXIs.
ayx_python_sdk.cli.yxi_installer module¶
Wrappers to handle interactions with YXI Installer.
Module contents¶
Command line interface definitions.