# Clio SDK
Python SDK for Clio - Playwright automation monitoring service.
## Installation
```bash
pip install clio_monitoring
```
## Quick Start
```python
from playwright.async_api import async_playwright
from clio import ClioMonitor
# Initialize Clio
monitor = ClioMonitor(api_key="your-api-key")
async def test_example():
async with async_playwright() as p:
browser = await p.chromium.launch()
# Create context with video recording enabled
context = await browser.new_context(
record_video_dir="./videos",
record_video_size={"width": 1280, "height": 720}
)
# Start monitoring this test
await monitor.start_run(
context=context,
automation_name="User Login Test",
success_criteria="User successfully logs in and sees dashboard",
playwright_instructions="Navigate to login page, enter credentials, verify dashboard loads"
)
# Your test code here
page = await context.new_page()
await page.goto("https://example.com/login")
# ... rest of your test
# Videos and traces are automatically uploaded when context closes
await context.close()
await browser.close()
```
## Configuration
```python
monitor = ClioMonitor(
api_key="your-api-key",
base_url="https://api.cliomonitoring.com", # Optional: for self-hosted instances
retry_attempts=3, # Optional: number of upload retry attempts
raise_on_error=False # Optional: raise exceptions on errors
)
```
## Features
- **Automatic Upload**: Videos and traces are automatically uploaded when the browser context closes
- **Retry Logic**: Failed uploads are automatically retried
- **Rate Limiting**: Respects your organization's monthly rate limits
- **Error Handling**: Configurable error handling (log or raise exceptions)
## Requirements
- Python 3.8+
- Playwright 1.40+
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "clio-monitoring",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "automation, monitoring, playwright, testing",
"author": null,
"author_email": "Clio Team <info@treebeardhq.com>",
"download_url": "https://files.pythonhosted.org/packages/73/bf/ef2b5efae38e8f3ca262312a44c2eea7137ef891081f8bf4df61c0592207/clio_monitoring-0.1.10.tar.gz",
"platform": null,
"description": "# Clio SDK\n\nPython SDK for Clio - Playwright automation monitoring service.\n\n## Installation\n\n```bash\npip install clio_monitoring\n```\n\n## Quick Start\n\n```python\nfrom playwright.async_api import async_playwright\nfrom clio import ClioMonitor\n\n# Initialize Clio\nmonitor = ClioMonitor(api_key=\"your-api-key\")\n\nasync def test_example():\n async with async_playwright() as p:\n browser = await p.chromium.launch()\n\n # Create context with video recording enabled\n context = await browser.new_context(\n record_video_dir=\"./videos\",\n record_video_size={\"width\": 1280, \"height\": 720}\n )\n\n # Start monitoring this test\n await monitor.start_run(\n context=context,\n automation_name=\"User Login Test\",\n success_criteria=\"User successfully logs in and sees dashboard\",\n playwright_instructions=\"Navigate to login page, enter credentials, verify dashboard loads\"\n )\n\n # Your test code here\n page = await context.new_page()\n await page.goto(\"https://example.com/login\")\n # ... rest of your test\n\n # Videos and traces are automatically uploaded when context closes\n await context.close()\n await browser.close()\n```\n\n## Configuration\n\n```python\nmonitor = ClioMonitor(\n api_key=\"your-api-key\",\n base_url=\"https://api.cliomonitoring.com\", # Optional: for self-hosted instances\n retry_attempts=3, # Optional: number of upload retry attempts\n raise_on_error=False # Optional: raise exceptions on errors\n)\n```\n\n## Features\n\n- **Automatic Upload**: Videos and traces are automatically uploaded when the browser context closes\n- **Retry Logic**: Failed uploads are automatically retried\n- **Rate Limiting**: Respects your organization's monthly rate limits\n- **Error Handling**: Configurable error handling (log or raise exceptions)\n\n## Requirements\n\n- Python 3.8+\n- Playwright 1.40+\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": null,
"summary": "Playwright automation monitoring SDK",
"version": "0.1.10",
"project_urls": {
"Documentation": "https://docs.cliomonitoring.com",
"Homepage": "https://docs.cliomonitoring.com",
"Issues": "https://github.com/TreebeardHQ/clio-python-sdk/issues",
"Repository": "https://github.com/TreebeardHQ/clio-python-sdk"
},
"split_keywords": [
"automation",
" monitoring",
" playwright",
" testing"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "89bb62f0000b0284628ea40c3193a04e42e28055873acb5a81d9d7e49c7ff47d",
"md5": "0422847be6e512bd2eed9e531ffbc6ba",
"sha256": "d4e2de47ba9165b1304b000664c83ec119bf0ffdd98c6acd43d1ea19ab618a83"
},
"downloads": -1,
"filename": "clio_monitoring-0.1.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0422847be6e512bd2eed9e531ffbc6ba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12059,
"upload_time": "2025-08-15T20:35:14",
"upload_time_iso_8601": "2025-08-15T20:35:14.284657Z",
"url": "https://files.pythonhosted.org/packages/89/bb/62f0000b0284628ea40c3193a04e42e28055873acb5a81d9d7e49c7ff47d/clio_monitoring-0.1.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "73bfef2b5efae38e8f3ca262312a44c2eea7137ef891081f8bf4df61c0592207",
"md5": "6c797252557c4256ca9b6c43c07e2813",
"sha256": "a50ce6cee6283907a3cc5be91d95f2edd2d53996f2225affc7cf4839f10de9e1"
},
"downloads": -1,
"filename": "clio_monitoring-0.1.10.tar.gz",
"has_sig": false,
"md5_digest": "6c797252557c4256ca9b6c43c07e2813",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 61387,
"upload_time": "2025-08-15T20:35:15",
"upload_time_iso_8601": "2025-08-15T20:35:15.594015Z",
"url": "https://files.pythonhosted.org/packages/73/bf/ef2b5efae38e8f3ca262312a44c2eea7137ef891081f8bf4df61c0592207/clio_monitoring-0.1.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-15 20:35:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TreebeardHQ",
"github_project": "clio-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "clio-monitoring"
}
JSON
