📋 Installation

This guide provides detailed instructions for installing the WyseOS Python SDK and setting up your development environment.

✨ System Requirements

Before you begin, ensure your system meets the following prerequisites:

• Python: Version 3.9 or higher
• Operating System: Compatible with Windows, macOS, or Linux
• Dependencies: All necessary dependencies are automatically handled during the SDK installation process.

📦 Installation Methods

Choose your preferred method to install the SDK:

1. Install via PyPI (Recommended) ✅

The simplest way to install the SDK is using pip, Python's package installer. Open your terminal or command prompt and execute:

pip install wyseos-sdk

2. Install from Source 🛠️

If you need the latest development version or plan to contribute to the SDK, you can install it directly from the source code:

# First, clone the repository:
git clone https://github.com/WyseOS/wyseos-sdk-python.git
cd wyseos-sdk-python

# Then, install in editable (development) mode:
pip install -e .

3. Install with Poetry ✒️

For projects using Poetry for dependency management:

poetry add wyseos-sdk

4. Install with Conda 🐍

If you prefer Conda, you can install the SDK as follows after creating an environment:

pip install wyseos-sdk

🔎 Verify Your Installation

After installation, it's good practice to verify that the SDK is correctly installed and accessible. Run the following Python snippet:

import wyseos.mate

print(f"WyseOS SDK Python version: {wyseos.mate.__version__}")

# Test basic imports to ensure core components are available
from wyseos.mate import Client, ClientOptions
from wyseos.mate.models import TeamInfo
from wyseos.mate.errors import APIError

# ✨ Verify new TaskRunner interface (v0.2.1+)
from wyseos.mate.websocket import TaskExecutionOptions, WebSocketClient
print("✅ TaskRunner interface available!")

print("✅ WyseOS Python SDK installed successfully!")

🌳 Managing Dependencies with Virtual Environments (Recommended)

To prevent dependency conflicts and maintain a clean project environment, we strongly recommend using a Python virtual environment.

Using venv

venv is Python's built-in module for creating lightweight virtual environments.

# Create a new virtual environment (e.g., named 'mate-sdk-env')
python -m venv mate-sdk-env

# Activate the virtual environment:
# On Linux/macOS:
source mate-sdk-env/bin/activate

# On Windows (Command Prompt):
mate-sdk-env\Scripts\activate.bat

# On Windows (PowerShell):
mate-sdk-env\Scripts\Activate.ps1

# Once activated, install the SDK:
pip install wyseos-sdk

Using conda Environments

If you use Conda, you can create and activate a dedicated environment:

# Create a new conda environment (e.g., named 'mate-sdk') with Python 3.9
conda create -n mate-sdk python=3.9

# Activate the environment:
conda activate mate-sdk

# Install the SDK within the activated environment:
pip install wyseos-sdk

🚀 Next Steps

Now that you have successfully installed the SDK, proceed to the Getting Started guide to learn about configuration and basic usage.