plato-sdk-v2 2.0.50__py3-none-any.whl → 2.2.4__py3-none-any.whl

plato/_generated/api/v2/sessions/snapshot_store.py

@@ -0,0 +1,94 @@
+"""Snapshot Store"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import (
+    AppApiV2SchemasSessionCreateSnapshotRequest,
+    AppApiV2SchemasSessionCreateSnapshotResponse,
+)
+
+
+def _build_request_args(
+    session_id: str,
+    body: AppApiV2SchemasSessionCreateSnapshotRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = f"/api/v2/sessions/{session_id}/snapshot_store"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "POST",
+        "url": url,
+        "json": body.model_dump(mode="json", exclude_none=True),
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    session_id: str,
+    body: AppApiV2SchemasSessionCreateSnapshotRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> AppApiV2SchemasSessionCreateSnapshotResponse:
+    """Create a snapshot-store snapshot of all jobs in the session (disk + memory).
+
+    Uses the snapshot-store pipeline for chunk-based deduplication and
+    efficient storage. This is the preferred method for new base snapshots.
+
+    Optional request body allows overriding artifact metadata:
+    - override_service: Override simulator/service name
+    - override_version: Override version/git_hash
+    - override_dataset: Override dataset name"""
+
+    request_args = _build_request_args(
+        session_id=session_id,
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return AppApiV2SchemasSessionCreateSnapshotResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    session_id: str,
+    body: AppApiV2SchemasSessionCreateSnapshotRequest,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> AppApiV2SchemasSessionCreateSnapshotResponse:
+    """Create a snapshot-store snapshot of all jobs in the session (disk + memory).
+
+    Uses the snapshot-store pipeline for chunk-based deduplication and
+    efficient storage. This is the preferred method for new base snapshots.
+
+    Optional request body allows overriding artifact metadata:
+    - override_service: Override simulator/service name
+    - override_version: Override version/git_hash
+    - override_dataset: Override dataset name"""
+
+    request_args = _build_request_args(
+        session_id=session_id,
+        body=body,
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return AppApiV2SchemasSessionCreateSnapshotResponse.model_validate(response.json())

plato/_generated/api/v2/user/__init__.py

@@ -0,0 +1,7 @@
+"""API endpoints."""
+
+from . import get_current_user
+
+__all__ = [
+    "get_current_user",
+]

plato/_generated/api/v2/user/get_current_user.py

@@ -0,0 +1,76 @@
+"""Get Current User"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from plato._generated.errors import raise_for_status
+from plato._generated.models import UserResponse
+
+
+def _build_request_args(
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> dict[str, Any]:
+    """Build request arguments."""
+    url = "/api/v2/user/me"
+
+    headers: dict[str, str] = {}
+    if authorization is not None:
+        headers["authorization"] = authorization
+    if x_api_key is not None:
+        headers["X-API-Key"] = x_api_key
+
+    return {
+        "method": "GET",
+        "url": url,
+        "headers": headers,
+    }
+
+
+def sync(
+    client: httpx.Client,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> UserResponse:
+    """Get current user info.
+
+    Accepts authentication via:
+    - Authorization: Bearer <jwt_token>
+    - X-API-Key: <api_key>
+
+    Returns user info for the authenticated principal."""
+
+    request_args = _build_request_args(
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = client.request(**request_args)
+    raise_for_status(response)
+    return UserResponse.model_validate(response.json())
+
+
+async def asyncio(
+    client: httpx.AsyncClient,
+    authorization: str | None = None,
+    x_api_key: str | None = None,
+) -> UserResponse:
+    """Get current user info.
+
+    Accepts authentication via:
+    - Authorization: Bearer <jwt_token>
+    - X-API-Key: <api_key>
+
+    Returns user info for the authenticated principal."""
+
+    request_args = _build_request_args(
+        authorization=authorization,
+        x_api_key=x_api_key,
+    )
+
+    response = await client.request(**request_args)
+    raise_for_status(response)
+    return UserResponse.model_validate(response.json())

plato/_generated/models/__init__.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
-#   filename:  tmpofnvi9ej.json
-#   timestamp: 2026-01-15T20:55:44+00:00
+#   filename:  tmp28thllk8.json
+#   timestamp: 2026-01-17T04:45:09+00:00
 
 from __future__ import annotations
 
@@ -178,6 +178,9 @@ class ArtifactFullDetails(BaseModel):
     flows: Annotated[str | None, Field(title="Flows")] = None
     target: Annotated[str | None, Field(title="Target")] = None
     expires_at: Annotated[AwareDatetime | None, Field(title="Expires At")] = None
+    memory_manifest_id: Annotated[str | None, Field(title="Memory Manifest Id")] = None
+    disk_manifest_id: Annotated[str | None, Field(title="Disk Manifest Id")] = None
+    snapshotted_at: Annotated[AwareDatetime | None, Field(title="Snapshotted At")] = None
     created_at: Annotated[AwareDatetime, Field(title="Created At")]
 
 
@@ -704,6 +707,30 @@ class CreateCheckpointRequest(BaseModel):
     """
     Optional expiration time for the artifact (ISO 8601)
     """
+    flows: Annotated[str | None, Field(title="Flows")] = None
+    """
+    YAML definition of application flows/workflows
+    """
+    plato_config: Annotated[str | None, Field(title="Plato Config")] = None
+    """
+    YAML configuration for Plato-specific settings
+    """
+    internal_app_port: Annotated[int | None, Field(title="Internal App Port")] = None
+    """
+    Internal port the application listens on
+    """
+    messaging_port: Annotated[int | None, Field(title="Messaging Port")] = None
+    """
+    Port for messaging/communication
+    """
+    target: Annotated[str | None, Field(title="Target")] = None
+    """
+    Target domain for routing (e.g., sims.plato.so)
+    """
+    snapshotted_at: Annotated[AwareDatetime | None, Field(title="Snapshotted At")] = None
+    """
+    Override the snapshot timestamp. If not provided, calculates as parent's snapshotted_at + 30min or current time
+    """
 
 
 class CreateCheckpointResult(BaseModel):
@@ -1590,6 +1617,7 @@ class LogStatusResponse(BaseModel):
     )
     status: Annotated[Status, Field(title="Status")]
     message: Annotated[str | None, Field(title="Message")] = None
+    logs_count: Annotated[int | None, Field(title="Logs Count")] = None
 
 
 class MakeEnvBatchRequest(BaseModel):
@@ -1694,9 +1722,9 @@ class NodePolicyConfig(BaseModel):
     """
     Number of VMs per CPU core (e.g., 0.5 means 2 cores per VM)
     """
-    vms_per_dispatcher: Annotated[int | None, Field(title="Vms Per Dispatcher")] = 5
+    max_vms_per_dispatcher: Annotated[int | None, Field(title="Max Vms Per Dispatcher")] = 100
     """
-    Number of VMs each dispatcher manages
+    Maximum VMs per dispatcher (used to calculate dispatcher count)
     """
     vm_heartbeat_timeout: Annotated[int | None, Field(title="Vm Heartbeat Timeout")] = 300
     """
@@ -1744,6 +1772,52 @@ class NodeS3Config(BaseModel):
     """
 
 
+class NodeSnapshotStoreConfig(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    bucket: Annotated[str | None, Field(title="Bucket")] = "plato-firecracker-snapshots"
+    """
+    S3 bucket for snapshot-store packs/manifests.
+    """
+    prefix: Annotated[str | None, Field(title="Prefix")] = "snapshot-packs"
+    """
+    S3 prefix for snapshot-store packs/manifests.
+    """
+    region: Annotated[str | None, Field(title="Region")] = "us-west-1"
+    """
+    AWS region for snapshot-store S3 operations.
+    """
+    endpoint_url: Annotated[str | None, Field(title="Endpoint Url")] = None
+    """
+    S3 endpoint URL for snapshot-store (MinIO/LocalStack).
+    """
+    metadata_store: Annotated[Literal["postgres"], Field(title="Metadata Store")] = "postgres"
+    """
+    Snapshot-store metadata backend.
+    """
+    postgres_dsn: Annotated[str | None, Field(title="Postgres Dsn")] = None
+    """
+    Postgres DSN for snapshot-store metadata.
+    """
+    cache_mb: Annotated[int | None, Field(title="Cache Mb")] = 0
+    """
+    Snapshot-store userspace decompressed page cache size in MB (0 to disable). This cache deduplicates pages by content hash across all manifests. For memory mounts (mount-mem): direct_io is disabled by default, so the kernel page cache already handles caching and deduplication for mmap'd files. Multiple VMs restoring from the same snapshot share kernel-cached pages automatically. The userspace cache is redundant here. For disk mounts (mount-tree): direct_io is enabled by default for overlay write coherency, bypassing the kernel cache. However, the userspace cache only helps for unmodified base image pages read by multiple VMs. Since disk workloads involve frequent writes (logs, temp files, databases), written pages are served from the overlay and bypass this cache entirely. The benefit is marginal for typical workloads. Recommendation: Leave at 0 for most deployments.
+    """
+    compression_workers: Annotated[int | None, Field(title="Compression Workers")] = 1
+    """
+    Worker threads for snapshot-store compression.
+    """
+    upload_max_attempts: Annotated[int | None, Field(title="Upload Max Attempts")] = 3
+    """
+    Max upload attempts for snapshot-store uploads.
+    """
+    storage_root: Annotated[str | None, Field(title="Storage Root")] = None
+    """
+    Local storage root for snapshot-store data.
+    """
+
+
 class NodeStatusResponse(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -2061,6 +2135,7 @@ class RegisterRequest(BaseModel):
     plato_config: Annotated[str | None, Field(title="Plato Config")] = None
     flows: Annotated[str | None, Field(title="Flows")] = None
     target: Annotated[str | None, Field(title="Target")] = None
+    snapshotted_at: Annotated[AwareDatetime | None, Field(title="Snapshotted At")] = None
 
 
 class RegisterResponse(BaseModel):
@@ -2279,6 +2354,27 @@ class SdkConfig(BaseModel):
     """
 
 
+class SessionArchivalInfo(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    session_id: Annotated[str, Field(title="Session Id")]
+    created_at: Annotated[AwareDatetime, Field(title="Created At")]
+    logs_archived_at: Annotated[AwareDatetime | None, Field(title="Logs Archived At")] = None
+    organization_id: Annotated[int, Field(title="Organization Id")]
+    simulator_id: Annotated[int | None, Field(title="Simulator Id")] = None
+
+
+class SessionArchivalListResponse(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    sessions: Annotated[list[SessionArchivalInfo], Field(title="Sessions")]
+    total_count: Annotated[int, Field(title="Total Count")]
+    page: Annotated[int, Field(title="Page")]
+    page_size: Annotated[int, Field(title="Page Size")]
+
+
 class SessionBackupLogInput(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -2404,25 +2500,25 @@ class SetupRootPasswordRequest(BaseModel):
     """
 
 
-class SetupSandboxResponse(BaseModel):
+class SetupSandboxResult(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
-    status: Annotated[str, Field(title="Status")]
+    success: Annotated[bool, Field(title="Success")]
     """
-    Status
+    Whether setup completed successfully
     """
-    timestamp: Annotated[str | None, Field(title="Timestamp")] = None
+    stdout: Annotated[str | None, Field(title="Stdout")] = ""
     """
-    Timestamp
+    Command stdout
     """
-    correlation_id: Annotated[str, Field(title="Correlation Id")]
+    stderr: Annotated[str | None, Field(title="Stderr")] = ""
     """
-    Correlation ID for tracking
+    Command stderr
     """
-    ssh_url: Annotated[str, Field(title="Ssh Url")]
+    error: Annotated[str | None, Field(title="Error")] = None
     """
-    SSH URL for connecting to sandbox
+    Error message if failed
     """
 
 
@@ -3015,6 +3111,18 @@ class UploadPackageResponse(BaseModel):
     message: Annotated[str, Field(title="Message")]
 
 
+class UserResponse(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    id: Annotated[int, Field(title="Id")]
+    public_id: Annotated[str, Field(title="Public Id")]
+    email: Annotated[str | None, Field(title="Email")] = None
+    name: Annotated[str | None, Field(title="Name")] = None
+    organization_id: Annotated[int | None, Field(title="Organization Id")] = None
+    organization_name: Annotated[str | None, Field(title="Organization Name")] = None
+
+
 class VMManagementResponse(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -3668,6 +3776,45 @@ class AppApiV2SchemasSessionPublicUrlResponse(BaseModel):
     """
 
 
+class AppApiV2SchemasSessionSetupSandboxRequest(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    timeout: Annotated[int | None, Field(title="Timeout")] = 120
+    """
+    Setup timeout in seconds
+    """
+
+
+class AppApiV2SchemasSessionSetupSandboxResponse(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    results: Annotated[dict[str, SetupSandboxResult], Field(title="Results")]
+
+
+class AppSchemasBuildModelsSetupSandboxResponse(BaseModel):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    status: Annotated[str, Field(title="Status")]
+    """
+    Status
+    """
+    timestamp: Annotated[str | None, Field(title="Timestamp")] = None
+    """
+    Timestamp
+    """
+    correlation_id: Annotated[str, Field(title="Correlation Id")]
+    """
+    Correlation ID for tracking
+    """
+    ssh_url: Annotated[str, Field(title="Ssh Url")]
+    """
+    SSH URL for connecting to sandbox
+    """
+
+
 class AppSchemasBuildModelsSimConfigCompute(BaseModel):
     model_config = ConfigDict(
         extra="allow",
@@ -4203,6 +4350,10 @@ class NodeConfig(BaseModel):
     """
     S3/Minio configuration for snapshots and artifacts
     """
+    snapshot_store: NodeSnapshotStoreConfig | None = None
+    """
+    Snapshot-store configuration for manifest/pack pipeline
+    """
     build: NodeBuildConfig | None = None
     """
     Build configuration including SSH keys for VMs
@@ -4545,7 +4696,7 @@ class PlatoConfig(BaseModel):
     """
 
 
-class SetupSandboxRequest(BaseModel):
+class VMManagementRequest(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
@@ -4565,17 +4716,9 @@ class SetupSandboxRequest(BaseModel):
     """
     Request timeout in seconds
     """
-    ssh_password: Annotated[str | None, Field(title="Ssh Password")] = None
-    """
-    SSH password for plato user (optional)
-    """
-    ssh_public_key: Annotated[str | None, Field(title="Ssh Public Key")] = None
-    """
-    SSH public key to add to plato user's authorized_keys (optional)
-    """
 
 
-class VMManagementRequest(BaseModel):
+class AppSchemasBuildModelsSetupSandboxRequest(BaseModel):
     model_config = ConfigDict(
         extra="allow",
     )
@@ -4595,6 +4738,14 @@ class VMManagementRequest(BaseModel):
     """
     Request timeout in seconds
     """
+    ssh_password: Annotated[str | None, Field(title="Ssh Password")] = None
+    """
+    SSH password for plato user (optional)
+    """
+    ssh_public_key: Annotated[str | None, Field(title="Ssh Public Key")] = None
+    """
+    SSH public key to add to plato user's authorized_keys (optional)
+    """
 
 
 DbModelsTestCaseModelJSONSchemaDraft7.model_rebuild()

plato/_sims_generator/__init__.py

@@ -1,9 +1,10 @@
 """OpenAPI SDK Generator for Plato.
 
-This module provides tools to generate Python SDKs from OpenAPI specifications.
+This module provides tools to generate Python SDKs from OpenAPI specifications,
+as well as instruction-based SDKs for sims that don't need API clients.
 
-Usage:
-    from plato.sims.generator import parse_openapi, PythonGenerator, OAuthConfig
+Usage (OpenAPI-based):
+    from plato._sims_generator import parse_openapi, PythonGenerator, OAuthConfig
 
     api = parse_openapi(spec_dict)
     generator = PythonGenerator(
@@ -21,10 +22,22 @@ Usage:
     )
     generator.generate()
 
+Usage (Instruction-based):
+    from plato._sims_generator import InstructionConfig, InstructionGenerator
+
+    config = InstructionConfig.from_yaml(Path("specs/instructions.yaml"))
+    generator = InstructionGenerator(
+        config,
+        output_path,
+        package_name="localstack",
+    )
+    generator.generate()
+
 Or via CLI:
-    uv run python -m plato.sims.generator.cli --path spec.yaml --output ./output --package mypackage
+    plato sims publish --config plato-config.yml
 """
 
+from .instruction import InstructionConfig, InstructionGenerator
 from .parser import API, Endpoint, Schema, Type, parse_openapi
 from .python import AuthConfig, BasicAuthConfig, BearerTokenConfig, OAuthConfig, PythonGenerator, SessionAuthConfig
 
@@ -40,4 +53,6 @@ __all__ = [
     "BearerTokenConfig",
     "BasicAuthConfig",
     "SessionAuthConfig",
+    "InstructionConfig",
+    "InstructionGenerator",
 ]