Installation¶

Requirements¶

Python 3.9+
An API key from app.canard.cloud

Install the SDK¶

pip install canard-sdk

Save Your API Key¶

You can authenticate three ways. The SDK checks them in this order:

Option 1: Environment Variable (recommended for CI)¶

export CANARD_API_KEY="your_api_key"

Option 2: Credentials File (recommended for local dev)¶

from canard import save_api_key
save_api_key("your_api_key")

This saves to ~/.canard/credentials with 0600 permissions.

Option 3: Pass Directly¶

from canard import Client
client = Client(api_url="https://api.canard.cloud", api_key="your_api_key")

Verify¶

from canard import Client

client = Client(api_url="https://api.canard.cloud")
status = client.get_queue_status()
print(f"Platform: {status.active_workers} workers online")

If this prints without error, you're ready to go.