AyxPythonSdk
1.0
ayx_python_sdk
Getting Started Guide
Lifecycle of a Plugin
Plugin Tool Execution Framework
Tool Configurations
File Provider
Differences Between the New and Old Python SDKs
Python 3rd-party Dependencies
Virtual Environments
Python Embeddable Distribution (PED)
Example Tools
AyxPythonSdk
Docs
»
Welcome to ayx_python_sdk’s documentation!
View page source
Welcome to ayx_python_sdk’s documentation!
¶
ayx_python_sdk
ayx_python_sdk package
Getting Started Guide
Prerequisites
Set Up the Development Environment
Glossary
Lifecycle of a Plugin
Prerequisites
Overview
Workflow Run
Update Only Run
Plugin Tool Execution Framework
Plugin Class
Register the Plugin
The init Method
The on_input_connection_opened Method
The on_record_packet Method
The on_complete Method
Proxy Environment Configuration
Tool Configurations
File Provider
Installation
Input File Formats
Running the File Provider
Differences Between the New and Old Python SDKs
Packaging
Getting Started
Development
Deployment
Python 3rd-party Dependencies
Adding 3rd-party Packages
Using 3rd-party Packages in Code
Virtual Environments
Developing in a Virtual Environment
Workspace Setup
3rd-party Packages
Best Practices
Python Embeddable Distribution (PED)
Python Distribution
Packaging Python SDK Plugin and Creating YXI
Example Tools
Example Tool Descriptions