Quick Start Guide: Installing Vue.ai SDK

The Vue.ai SDK provides a powerful suite of services designed to streamline the integration, management, and automation of data workflows. With support for Role-Based Access Control (RBAC), seamless connectors to various data sources, advanced dataset management, and workflow automation, the SDK enables developers to build scalable, secure, and highly efficient applications.

This SDK is ideal for teams seeking to integrate AI and machine learning capabilities into their workflows, enabling data-driven decisions and automated processes. Whether you’re managing data securely, orchestrating complex workflows, or integrating multiple data sources, the Vue.ai SDK offers a comprehensive toolset to accelerate development.

Prerequisites

Before installing the Vue.ai SDK, ensure your environment meets the following requirements:

Python: Version 3.6 or higher. To verify your Python version, run:
```
python --version
```
pip: Version 20.0 or higher. To verify your pip version, run:
```
pip --version
```

If any of these tools are missing or outdated, follow the steps below to install or update them:

Install Python 3.6+ from the official Python website.
Update pip with this command:
```
python -m pip install --upgrade pip
```

Installation

To install the Vue.ai SDK, you need to configure the environment variables and run the pip install command.

Set Up Environment Variables

You can acquire the required credentials (PYPI_IP, PYPI_USERNAME, PYPI_PASSWORD) from the Vue.ai support team.

:::caution Before proceeding with the setup, ensure that you obtain the necessary credentials, including the account_id and the API Gateway URL (base_url), from the support team. These credentials are required for proper configuration and authentication. :::

Install the SDK

Once the environment variables are set, run the following command to install the Vue.ai SDK.

macOS/Linux

Run the following commands in your terminal:

export PYPI_IP="<pypi_ip>"
export PYPI_USERNAME="<pypi_username>"
export PYPI_PASSWORD="<pypi_password>"

Then install the Vue.ai SDK with the following command:

pip install --index-url "https://${PYPI_USERNAME}:${PYPI_PASSWORD}@${PYPI_IP}/simple/" \
    --trusted-host "${PYPI_IP}" \
    --extra-index-url "https://pypi.org/simple/" \
    vue-pre-sdk==2.3.8

Windows (PowerShell)

Run the following commands in your PowerShell terminal:

$env:PYPI_IP="<pypi_ip>"
$env:PYPI_USERNAME="<pypi_username>"
$env:PYPI_PASSWORD="<pypi_password>"

Then install the Vue.ai SDK with the following command:

pip install --index-url "https://${env:PYPI_USERNAME}:${env:PYPI_PASSWORD}@${env:PYPI_IP}/simple/" `
    --trusted-host "${env:PYPI_IP}" `
    --extra-index-url "https://pypi.org/simple/" `
    vue-pre-sdk==2.3.8

Step 2: Verify Installation

After the installation completes, verify that the Vue.ai SDK was correctly installed by running the following command:

python -m vue_pre_sdk --version

If the SDK is installed correctly, this command will output the version number (e.g., 0.2.8).

Troubleshooting

Issue: Command not found or pip install fails
Solution: Ensure that your Python environment is set up correctly and that you’re using the correct version of pip. Confirm that the Vue.ai private package index URL is accessible from your network.

Next Steps

Once the Vue.ai SDK is installed, you’re ready to start building with the SDK’s tools and services. Consult the official SDK documentation for detailed instructions on integrating the Vue.ai SDK into your workflows and projects.