plato-sdk-v2 2.0.1__tar.gz

plato_sdk_v2-2.0.1/.gitignore

@@ -0,0 +1,23 @@
+__pycache__/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# JetBrains
+.idea/
+
+/coverage.xml
+/.coverage

plato_sdk_v2-2.0.1/PKG-INFO

@@ -0,0 +1,283 @@
+Metadata-Version: 2.4
+Name: plato-sdk-v2
+Version: 2.0.1
+Summary: Python SDK for the Plato API
+Author-email: Plato <support@plato.so>
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.2.1
+Provides-Extra: db-cleanup
+Requires-Dist: aiomysql>=0.2; extra == 'db-cleanup'
+Requires-Dist: aiosqlite>=0.20; extra == 'db-cleanup'
+Requires-Dist: asyncpg>=0.29; extra == 'db-cleanup'
+Requires-Dist: sqlalchemy[asyncio]>=2.0; extra == 'db-cleanup'
+Provides-Extra: dev
+Requires-Dist: basedpyright>=1.18; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Plato Python SDK
+
+Python SDK for the Plato API v2.
+
+## Installation
+
+```bash
+pip install plato-sdk
+```
+
+## Quick Start
+
+```python
+from plato.v2 import Client, Env
+
+# Synchronous usage
+with Client() as client:
+    # Create a session with an environment
+    with client.session(envs=[Env.artifact("espocrm")]) as session:
+        # Batch operations on all environments
+        session.reset()
+        state = session.get_state()
+
+        # Per-environment operations
+        for env in session.envs:
+            result = env.execute("ls -la")
+            print(result)
+```
+
+## Environment Configuration
+
+The SDK provides three modes for creating environments using the `Env` helper, which returns `EnvConfig` objects:
+
+### Mode 1: Simulator with Tag (Default)
+
+Start from a snapshotted artifact using "simulator:tag" format:
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    # Use default :prod-latest tag
+    session = client.session(envs=[Env.artifact("espocrm")])
+    # Equivalent to: Env.artifact("espocrm:prod-latest")
+
+    # Use custom tag
+    session = client.session(envs=[Env.artifact("espocrm:staging")])
+
+    # With custom alias
+    session = client.session(envs=[Env.artifact("espocrm", alias="crm")])
+```
+
+### Mode 2: Explicit Artifact ID
+
+Start
+from
+a
+specific
+artifact
+snapshot
+using
+its
+ID:
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    # Use explicit artifact ID
+    session = client.session(envs=[
+        Env.artifact(artifact_id="artifact-123", alias="my-env")
+    ])
+```
+
+### Mode 3: Custom VM Resources
+
+Create
+a
+blank
+VM
+with
+custom
+CPU,
+memory,
+and
+disk
+configuration:
+
+```python
+from plato.v2 import Client, Env, SimConfigCompute
+
+with Client() as client:
+    # Create blank VM with custom resources
+    session = client.session(envs=[
+        Env.resource(
+            "redis",
+            SimConfigCompute(cpus=4, memory=8192, disk=20000),
+            alias="cache"
+        )
+    ])
+```
+
+### Multiple Environments
+
+```python
+from plato.v2 import Client, Env, SimConfigCompute
+
+with Client() as client:
+    # Mix artifact and resource-based environments
+    envs = [
+        Env.artifact("espocrm", alias="crm"),
+        Env.artifact("wordpress:staging", alias="blog"),
+        Env.resource("redis", SimConfigCompute(cpus=2, memory=4096), alias="cache"),
+    ]
+
+    with client.session.from_envs(envs) as session:
+        # Access environments by alias
+        crm = session.get_env("crm")
+        blog = session.get_env("blog")
+        cache = session.get_env("cache")
+
+        if crm:
+            crm.execute("echo 'Hello CRM'")
+        if blog:
+            blog.execute("echo 'Hello Blog'")
+```
+
+### Create Session from Task
+
+```python
+from plato.v2 import Client
+
+with Client() as client:
+    # Create session from a task ID
+    session = client.from_task(task_id=123)
+```
+
+## Async Usage
+
+```python
+import asyncio
+from plato.v2 import AsyncClient, Env
+
+async def main():
+    async with AsyncClient() as client:
+        async with await client.session(envs=[Env.artifact("espocrm")]) as session:
+            await session.reset()
+            state = await session.get_state()
+
+            for env in session.envs:
+                result = await env.execute("ls -la")
+                print(result)
+
+asyncio.run(main())
+```
+
+## Session Operations
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    with client.session(envs=[Env.artifact("espocrm")]) as session:
+        # Reset all environments
+        session.reset()
+
+        # Get state from all environments
+        state = session.get_state()
+
+        # Execute command on all environments
+        results = session.execute("ls -la", timeout=30)
+
+        # Create snapshot of all environments
+        snapshots = session.snapshot()
+
+        # Evaluate session
+        evaluation = session.evaluate()
+
+        # Send heartbeat (automatically done when using context manager)
+        session.heartbeat()
+```
+
+## Per-Environment Operations
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    with client.session(envs=[Env.artifact("espocrm", alias="crm")]) as session:
+        # Get specific environment
+        env = session.get_env("crm")
+
+        if env:
+            # Execute command
+            result = env.execute("pwd")
+            print(result.stdout)
+
+            # Reset environment
+            env.reset()
+
+            # Create snapshot
+            snapshot = env.snapshot()
+
+            # Get state
+            state = env.get_state()
+
+            # Close environment
+            env.close()
+```
+
+## Configuration
+
+Set
+your
+API
+key
+via
+environment
+variable:
+
+```bash
+export PLATO_API_KEY=your-api-key
+```
+
+Or
+pass
+it
+directly:
+
+```python
+from plato.v2 import Client
+
+client = Client(api_key="your-api-key")
+```
+
+Configure
+custom
+base
+URL:
+
+```bash
+export PLATO_BASE_URL=https://custom.plato.so
+```
+
+Or:
+
+```python
+client = Client(base_url="https://custom.plato.so")
+```
+
+## License
+
+MIT

plato_sdk_v2-2.0.1/README.md

@@ -0,0 +1,253 @@
+# Plato Python SDK
+
+Python SDK for the Plato API v2.
+
+## Installation
+
+```bash
+pip install plato-sdk
+```
+
+## Quick Start
+
+```python
+from plato.v2 import Client, Env
+
+# Synchronous usage
+with Client() as client:
+    # Create a session with an environment
+    with client.session(envs=[Env.artifact("espocrm")]) as session:
+        # Batch operations on all environments
+        session.reset()
+        state = session.get_state()
+
+        # Per-environment operations
+        for env in session.envs:
+            result = env.execute("ls -la")
+            print(result)
+```
+
+## Environment Configuration
+
+The SDK provides three modes for creating environments using the `Env` helper, which returns `EnvConfig` objects:
+
+### Mode 1: Simulator with Tag (Default)
+
+Start from a snapshotted artifact using "simulator:tag" format:
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    # Use default :prod-latest tag
+    session = client.session(envs=[Env.artifact("espocrm")])
+    # Equivalent to: Env.artifact("espocrm:prod-latest")
+
+    # Use custom tag
+    session = client.session(envs=[Env.artifact("espocrm:staging")])
+
+    # With custom alias
+    session = client.session(envs=[Env.artifact("espocrm", alias="crm")])
+```
+
+### Mode 2: Explicit Artifact ID
+
+Start
+from
+a
+specific
+artifact
+snapshot
+using
+its
+ID:
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    # Use explicit artifact ID
+    session = client.session(envs=[
+        Env.artifact(artifact_id="artifact-123", alias="my-env")
+    ])
+```
+
+### Mode 3: Custom VM Resources
+
+Create
+a
+blank
+VM
+with
+custom
+CPU,
+memory,
+and
+disk
+configuration:
+
+```python
+from plato.v2 import Client, Env, SimConfigCompute
+
+with Client() as client:
+    # Create blank VM with custom resources
+    session = client.session(envs=[
+        Env.resource(
+            "redis",
+            SimConfigCompute(cpus=4, memory=8192, disk=20000),
+            alias="cache"
+        )
+    ])
+```
+
+### Multiple Environments
+
+```python
+from plato.v2 import Client, Env, SimConfigCompute
+
+with Client() as client:
+    # Mix artifact and resource-based environments
+    envs = [
+        Env.artifact("espocrm", alias="crm"),
+        Env.artifact("wordpress:staging", alias="blog"),
+        Env.resource("redis", SimConfigCompute(cpus=2, memory=4096), alias="cache"),
+    ]
+
+    with client.session.from_envs(envs) as session:
+        # Access environments by alias
+        crm = session.get_env("crm")
+        blog = session.get_env("blog")
+        cache = session.get_env("cache")
+
+        if crm:
+            crm.execute("echo 'Hello CRM'")
+        if blog:
+            blog.execute("echo 'Hello Blog'")
+```
+
+### Create Session from Task
+
+```python
+from plato.v2 import Client
+
+with Client() as client:
+    # Create session from a task ID
+    session = client.from_task(task_id=123)
+```
+
+## Async Usage
+
+```python
+import asyncio
+from plato.v2 import AsyncClient, Env
+
+async def main():
+    async with AsyncClient() as client:
+        async with await client.session(envs=[Env.artifact("espocrm")]) as session:
+            await session.reset()
+            state = await session.get_state()
+
+            for env in session.envs:
+                result = await env.execute("ls -la")
+                print(result)
+
+asyncio.run(main())
+```
+
+## Session Operations
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    with client.session(envs=[Env.artifact("espocrm")]) as session:
+        # Reset all environments
+        session.reset()
+
+        # Get state from all environments
+        state = session.get_state()
+
+        # Execute command on all environments
+        results = session.execute("ls -la", timeout=30)
+
+        # Create snapshot of all environments
+        snapshots = session.snapshot()
+
+        # Evaluate session
+        evaluation = session.evaluate()
+
+        # Send heartbeat (automatically done when using context manager)
+        session.heartbeat()
+```
+
+## Per-Environment Operations
+
+```python
+from plato.v2 import Client, Env
+
+with Client() as client:
+    with client.session(envs=[Env.artifact("espocrm", alias="crm")]) as session:
+        # Get specific environment
+        env = session.get_env("crm")
+
+        if env:
+            # Execute command
+            result = env.execute("pwd")
+            print(result.stdout)
+
+            # Reset environment
+            env.reset()
+
+            # Create snapshot
+            snapshot = env.snapshot()
+
+            # Get state
+            state = env.get_state()
+
+            # Close environment
+            env.close()
+```
+
+## Configuration
+
+Set
+your
+API
+key
+via
+environment
+variable:
+
+```bash
+export PLATO_API_KEY=your-api-key
+```
+
+Or
+pass
+it
+directly:
+
+```python
+from plato.v2 import Client
+
+client = Client(api_key="your-api-key")
+```
+
+Configure
+custom
+base
+URL:
+
+```bash
+export PLATO_BASE_URL=https://custom.plato.so
+```
+
+Or:
+
+```python
+client = Client(base_url="https://custom.plato.so")
+```
+
+## License
+
+MIT

plato_sdk_v2-2.0.1/plato/__init__.py

@@ -0,0 +1,37 @@
+# Plato SDK
+#
+# v1: Legacy SDK (deprecated)
+# v2: New SDK with separate sync/async modules
+#
+# Usage (v2 - recommended):
+#   from plato.v2.sync import Client
+#   from plato.v2.async_ import Client
+#   from plato import EnvOption
+#
+# Usage (v1 - deprecated):
+#   from plato import Plato, SyncPlato
+
+# Defer imports to avoid circular issues with _generated
+__all__ = ["EnvOption", "v2"]
+
+
+def __getattr__(name):
+    """Lazy import to avoid loading all modules at once."""
+    if name == "v2":
+        from plato import v2
+
+        return v2
+    if name == "EnvOption":
+        from plato._generated.models.env_option import EnvOption
+
+        return EnvOption
+    if name in ("Plato", "SyncPlato", "PlatoTask", "v1"):
+        try:
+            from plato import v1
+
+            if name == "v1":
+                return v1
+            return getattr(v1, name)
+        except ImportError:
+            raise AttributeError(f"module 'plato' has no attribute '{name}' (v1 unavailable)")
+    raise AttributeError(f"module 'plato' has no attribute '{name}'")

plato_sdk_v2-2.0.1/plato/_generated/__init__.py

@@ -0,0 +1,37 @@
+"""Plato API SDK - v0.13.10"""
+
+from . import api, errors, models
+from .client import AsyncClient, Client
+from .errors import (
+    APIError,
+    BadRequestError,
+    ConflictError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    RateLimitError,
+    ServiceUnavailableError,
+    UnauthorizedError,
+    UnprocessableEntityError,
+)
+
+__all__ = [
+    # Clients
+    "Client",
+    "AsyncClient",
+    # Modules
+    "api",
+    "models",
+    "errors",
+    # Error types for convenience
+    "APIError",
+    "BadRequestError",
+    "UnauthorizedError",
+    "ForbiddenError",
+    "NotFoundError",
+    "ConflictError",
+    "UnprocessableEntityError",
+    "RateLimitError",
+    "InternalServerError",
+    "ServiceUnavailableError",
+]

plato_sdk_v2-2.0.1/plato/_generated/api/__init__.py

@@ -0,0 +1,8 @@
+"""Generated API modules."""
+
+from . import v1, v2
+
+__all__ = [
+    "v1",
+    "v2",
+]

plato_sdk_v2-2.0.1/plato/_generated/api/v1/__init__.py

@@ -0,0 +1,31 @@
+"""API version module."""
+
+from . import (
+    agent_artifacts,
+    cluster,
+    env,
+    evals,
+    gitea,
+    jobs,
+    organization,
+    queue,
+    sandbox,
+    session,
+    simulator,
+    testcases,
+)
+
+__all__ = [
+    "agent_artifacts",
+    "cluster",
+    "env",
+    "evals",
+    "gitea",
+    "jobs",
+    "organization",
+    "queue",
+    "sandbox",
+    "session",
+    "simulator",
+    "testcases",
+]

plato_sdk_v2-2.0.1/plato/_generated/api/v1/agent_artifacts/__init__.py

@@ -0,0 +1,10 @@
+"""API endpoints."""
+
+from . import archive_agent_artifact, create_agent_artifact, get_agent_artifact_by_public_id, get_agent_artifacts
+
+__all__ = [
+    "get_agent_artifacts",
+    "create_agent_artifact",
+    "get_agent_artifact_by_public_id",
+    "archive_agent_artifact",
+]