Installation

Requirements

• Python 3.8 or higher
• Playwright 1.40.0 or higher
• An active Clio account

Install the SDK

Install the Clio SDK from PyPI using pip:

pip install clio_monitoring

Or if you’re using Poetry:

poetry add clio_monitoring

For development installations, you can install from source:

git clone https://github.com/TreebeardHQ/clio-python-sdk
cd clio-python-sdk
pip install -e .

Get Your API Key

1. Sign up for Clio: If you don’t have an account, create one at app.cliomonitoring.com

2. Access Your Dashboard: Log in and navigate to your organization’s dashboard

3. Generate an API Key:

   • Go to Settings → API Keys
   • Click Generate New Key
   • Give your key a descriptive name (e.g., “Local Development”)
   • Copy the generated key (it starts with clio_)

4. Store Securely: Save your API key in a secure location. You’ll need it to configure the SDK.

Keep Your API Key Secret

Your API key provides access to your Clio organization. Never commit it to version control or share it publicly.

Verify Installation

Create a simple test script to verify everything is working:

test_clio.py

from clio import ClioMonitor

# This should not raise any import errors
print("✅ Clio SDK imported successfully")

# Test configuration (replace with your actual API key)
try:
    monitor = ClioMonitor(api_key="clio_test_key_validation_only")
    print("✅ ClioMonitor created successfully")
except ValueError as e:
    if "Invalid API key format" in str(e):
        print("✅ API key validation working")
    else:
        print(f"❌ Unexpected error: {e}")

Run the test:

python test_clio.py

You should see:

✅ Clio SDK imported successfully
✅ API key validation working

Environment Setup

For security, store your API key as an environment variable:

Linux/macOS

export CLIO_API_KEY="your_actual_api_key_here"

Windows (Command Prompt)

set CLIO_API_KEY=your_actual_api_key_here

Windows (PowerShell)

$env:CLIO_API_KEY="your_actual_api_key_here"

Using a .env file

Create a .env file in your project root:

.env

CLIO_API_KEY=your_actual_api_key_here

Then load it in your Python code:

from dotenv import load_dotenv
import os

load_dotenv()
api_key = os.getenv("CLIO_API_KEY")

Playwright Setup

The Clio SDK works with Playwright’s video recording feature. Make sure you have Playwright installed and browsers downloaded:

# Install Playwright
pip install playwright

# Download browser binaries
playwright install

Next Steps

Now that you have the SDK installed and your API key ready, you can start monitoring your first automation:

• Quick Start Guide - Your first monitored automation
• Configuration Options - Customize SDK behavior
• Basic Example - Complete working example

Troubleshooting

Import Errors

If you get import errors, make sure:

• You’re using Python 3.8 or higher: python --version
• The SDK is installed in the correct environment: pip list | grep clio_monitoring
• You’re activating the right virtual environment

API Key Issues

If you have trouble with API keys:

• Ensure the key starts with clio_
• Check for extra spaces or newlines when copying
• Verify the key is active in your Clio dashboard
• Make sure you’re using the API key, not your login password

Permission Errors

If you get permission errors during installation:

pip install --user clio_monitoring

Or use a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install clio_monitoring