README.md

Alteryx Developer SDK

Downloads

The latest SDK versions can be downloaded from the Alteryx Developer SDK GitHub Repo in the Releases section.

Installation

To install, extract the SDK archive to a directory of your choice, install required dependencies, and finally, proceed to any platform specific post installation steps below.

Windows Installation Example

Via PowerShell

# Download the latest release
# This is an example! Update the URL to the correct archive!
Invoke-Webrequest -URL https://github.com/alteryx/ayx-developer-sdk/releases/download/v2022.12.0/ayx-sdk-cli-v2022.12.0-x86_64-pc-windows-msvc.zip -Outfile latest-sdk.zip

# Extract somewhere
Expand-Archive -Path latest-sdk.zip -DestinationPath C:\SDKs\Alteryx\

Dependencies

Python version 3.8.5 is currently required to use ayx-sdk-cli.exe plugin run. It is recommended to install this in a Miniconda environment.

Creating a Miniconda Python Environment

1. Follow the Miniconda installation instructions.
2. From a terminal, create a new environment with Python 3.8.5:

conda create -n MyEnvName python=3.8.5

ℹ️ Note that if you are using the same Conda environment for use with ayx_plugin_cli, you may wish to also install Node.js v14.x and doit as seen below:

conda create -n MyEnvName python=3.8.5 nodejs=14 doit

Please refer to the AYX Python SDK v2 documentation for more information on ayx_plugin_cli and Python SDK v2 tool development.

Post Installation

Windows

In a terminal change directories to the tools\win32\misc and run ./setup-sdk.ps1.

ℹ️ You will need to close and re-open your terminal after running this script.

Additional Reading

Additional reading can be found within the docs directory found within releases.

License

LICENSE