Using Clore SDK for Rapid Prototyping

The Clore SDK is designed to simplify development and accelerate prototyping by providing streamlined access to Clore’s core functionalities. With a collection of pre-built functions and modules, the SDK allows developers to rapidly create prototypes, test features, and iterate without needing to write extensive boilerplate code. In this guide, we'll walk through setting up the SDK for quick prototyping, accessing essential features, and using sample code to build basic functionalities.

---

Prerequisites

Before proceeding, ensure that:

• The Clore SDK is installed in your development environment.

• You have an active Clore API key.

• You have basic familiarity with Python and API requests.

Step 1: Setting Up the Clore SDK

To get started, install the Clore SDK by running:

pip install clore-sdk

Once installed, configure the SDK with your API key for secure access to the Clore API.

from clore_sdk import CloreAPI

# Initialize the Clore API client
clore_client = CloreAPI(api_key="your_api_key_here")

Step 2: SDK Initialization and Authentication

After initializing the Clore client, test the connection by retrieving basic account information. This simple test ensures that your setup is working and that the SDK is authenticated.

# Retrieve account information
account_info = clore_client.get_account_info()
print("Account Information:", account_info)

If the output displays your account details, you’re ready to move forward.

---

Step 3: Rapidly Prototyping with Clore SDK

With the Clore SDK, you can quickly implement several core functionalities. Let’s start with a few essential prototypes.

Prototype 1: Server Rental Automation

In this prototype, we’ll set up an automated rental system that selects a server based on certain specifications (e.g., GPU model, RAM size) and initiates a rental transaction.

# Define desired server specifications
desired_specs = {
    "gpu_model": "NVIDIA RTX 3080",
    "min_ram": 32
}

# Find a suitable server and rent it
def rent_server():
    servers = clore_client.get_servers()
    for server in servers:
        if server["gpu_model"] == desired_specs["gpu_model"] and server["ram"] >= desired_specs["min_ram"]:
            response = clore_client.rent_server(server_id=server["id"], duration=6)  # Rent for 6 hours
            print("Rental Successful:", response)
            break
    else:
        print("No suitable server found.")

rent_server()

This script automates server selection and rental based on your desired specs, allowing for rapid testing of different configurations.

---

Prototype 2: Real-Time Server Monitoring

Using the Clore SDK, you can set up a real-time monitoring script to track server status, usage metrics, and rental duration, which is crucial for managing resources and optimizing server utilization.

import time

def monitor_server(server_id):
    while True:
        server_status = clore_client.get_server_status(server_id)
        print(f"Server Status: {server_status['status']}, CPU Usage: {server_status['cpu_usage']}%, RAM Usage: {server_status['ram_usage']}%")
        
        # Exit monitoring if server is offline
        if server_status['status'] == "offline":
            print("Server has gone offline.")
            break
        time.sleep(60)  # Check every minute

# Example usage
monitor_server(server_id=123)

This monitoring script provides a continuous status update, useful for managing live server rentals and troubleshooting issues in real time.

---

Prototype 3: Bulk Server Management

For users managing multiple servers, the Clore SDK supports bulk operations. This script demonstrates how to list, rent, or release multiple servers based on custom criteria.

def manage_servers():
    servers = clore_client.get_servers()

    for server in servers:
        # Define bulk operation criteria
        if server["gpu_model"] == "NVIDIA RTX 3090":
            response = clore_client.rent_server(server_id=server["id"], duration=24)
            print(f"Server {server['id']} rented for 24 hours.")
        elif server["status"] == "idle":
            print(f"Server {server['id']} is available but not rented.")

manage_servers()

This example allows for scalable server management by applying different operations to each server based on custom criteria.

---

Step 4: Rapid Testing and Iteration

The SDK is optimized for quick prototyping, allowing you to test, iterate, and deploy new configurations without extensive setup. With built-in error handling and custom exceptions, you can manage issues smoothly.

try:
    # Attempt a server rental
    response = clore_client.rent_server(server_id=456, duration=12)
    print("Rental response:", response)
except clore_sdk.exceptions.ServerError as e:
    print("Server Error:", e)
except clore_sdk.exceptions.AuthenticationError:
    print("Authentication failed. Check your API key.")

This script exemplifies handling common API exceptions, making prototyping with the Clore SDK efficient and reliable.