plato-sdk-v2 2.2.3__tar.gz → 2.3.0__tar.gz

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plato-sdk-v2
-Version: 2.2.3
+Version: 2.3.0
 Summary: Python SDK for the Plato API
 Author-email: Plato <support@plato.so>
 License-Expression: MIT

plato_sdk_v2-2.3.0/VERSION

@@ -0,0 +1 @@
+2.3.0

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/plato/v2/async_/environment.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING
 
 from plato._generated.api.v2 import jobs
 from plato._generated.models import (
+    AppApiV2SchemasSessionCreateSnapshotRequest,
     ConnectRoutingInfoResult,
     CreateCheckpointRequest,
     CreateSnapshotResult,
@@ -136,6 +137,36 @@ class Environment:
             x_api_key=self._api_key,
         )
 
+    async def snapshot_store(
+        self,
+        override_service: str | None = None,
+        override_version: str | None = None,
+        override_dataset: str | None = None,
+    ) -> CreateSnapshotResult:
+        """Create a snapshot-store snapshot of this environment.
+
+        Uses the snapshot-store pipeline for chunk-based deduplication and
+        efficient storage. This is the preferred method for new base snapshots.
+
+        Args:
+            override_service: Override simulator/service name in artifact metadata.
+            override_version: Override version/git_hash in artifact metadata.
+            override_dataset: Override dataset name in artifact metadata.
+
+        Returns:
+            CreateSnapshotResult with artifact_id.
+        """
+        return await jobs.snapshot_store.asyncio(
+            client=self._http,
+            job_id=self.job_id,
+            body=AppApiV2SchemasSessionCreateSnapshotRequest(
+                override_service=override_service,
+                override_version=override_version,
+                override_dataset=override_dataset,
+            ),
+            x_api_key=self._api_key,
+        )
+
     async def close(self) -> None:
         """Close this environment."""
         await jobs.close.asyncio(

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/plato/v2/async_/session.py

@@ -34,6 +34,7 @@ from plato._generated.api.v2.sessions import reset as sessions_reset
 from plato._generated.api.v2.sessions import set_date as sessions_set_date
 from plato._generated.api.v2.sessions import setup_sandbox as sessions_setup_sandbox
 from plato._generated.api.v2.sessions import snapshot as sessions_snapshot
+from plato._generated.api.v2.sessions import snapshot_store as sessions_snapshot_store
 from plato._generated.api.v2.sessions import state as sessions_state
 from plato._generated.api.v2.sessions import wait_for_ready as sessions_wait_for_ready
 from plato._generated.models import (
@@ -622,6 +623,38 @@ class Session:
             x_api_key=self._api_key,
         )
 
+    async def snapshot_store(
+        self,
+        override_service: str | None = None,
+        override_version: str | None = None,
+        override_dataset: str | None = None,
+    ) -> AppApiV2SchemasSessionCreateSnapshotResponse:
+        """Create a snapshot-store snapshot of all environments in the session.
+
+        Uses the snapshot-store pipeline for chunk-based deduplication and
+        efficient storage. This is the preferred method for new base snapshots.
+
+        Args:
+            override_service: Override simulator/service name in artifact metadata.
+            override_version: Override version/git_hash in artifact metadata.
+            override_dataset: Override dataset name in artifact metadata.
+
+        Returns:
+            Snapshot response with info per job_id.
+        """
+        self._check_closed()
+
+        return await sessions_snapshot_store.asyncio(
+            client=self._http,
+            session_id=self.session_id,
+            body=AppApiV2SchemasSessionCreateSnapshotRequest(
+                override_service=override_service,
+                override_version=override_version,
+                override_dataset=override_dataset,
+            ),
+            x_api_key=self._api_key,
+        )
+
     async def disk_snapshot(
         self,
         override_service: str | None = None,

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/plato/v2/sync/environment.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING
 
 from plato._generated.api.v2 import jobs
 from plato._generated.models import (
+    AppApiV2SchemasSessionCreateSnapshotRequest,
     CreateCheckpointRequest,
     CreateSnapshotResult,
     ExecuteCommandRequest,
@@ -135,6 +136,36 @@ class Environment:
             x_api_key=self._api_key,
         )
 
+    def snapshot_store(
+        self,
+        override_service: str | None = None,
+        override_version: str | None = None,
+        override_dataset: str | None = None,
+    ) -> CreateSnapshotResult:
+        """Create a snapshot-store snapshot of this environment.
+
+        Uses the snapshot-store pipeline for chunk-based deduplication and
+        efficient storage. This is the preferred method for new base snapshots.
+
+        Args:
+            override_service: Override simulator/service name in artifact metadata.
+            override_version: Override version/git_hash in artifact metadata.
+            override_dataset: Override dataset name in artifact metadata.
+
+        Returns:
+            CreateSnapshotResult with artifact_id.
+        """
+        return jobs.snapshot_store.sync(
+            client=self._http,
+            job_id=self.job_id,
+            body=AppApiV2SchemasSessionCreateSnapshotRequest(
+                override_service=override_service,
+                override_version=override_version,
+                override_dataset=override_dataset,
+            ),
+            x_api_key=self._api_key,
+        )
+
     def close(self) -> None:
         """Close this environment."""
         jobs.close.sync(

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/plato/v2/sync/session.py

@@ -32,6 +32,7 @@ from plato._generated.api.v2.sessions import reset as sessions_reset
 from plato._generated.api.v2.sessions import set_date as sessions_set_date
 from plato._generated.api.v2.sessions import setup_sandbox as sessions_setup_sandbox
 from plato._generated.api.v2.sessions import snapshot as sessions_snapshot
+from plato._generated.api.v2.sessions import snapshot_store as sessions_snapshot_store
 from plato._generated.api.v2.sessions import state as sessions_state
 from plato._generated.api.v2.sessions import wait_for_ready as sessions_wait_for_ready
 from plato._generated.models import (
@@ -595,6 +596,38 @@ class Session:
             x_api_key=self._api_key,
         )
 
+    def snapshot_store(
+        self,
+        override_service: str | None = None,
+        override_version: str | None = None,
+        override_dataset: str | None = None,
+    ) -> AppApiV2SchemasSessionCreateSnapshotResponse:
+        """Create a snapshot-store snapshot of all environments in the session.
+
+        Uses the snapshot-store pipeline for chunk-based deduplication and
+        efficient storage. This is the preferred method for new base snapshots.
+
+        Args:
+            override_service: Override simulator/service name in artifact metadata.
+            override_version: Override version/git_hash in artifact metadata.
+            override_dataset: Override dataset name in artifact metadata.
+
+        Returns:
+            Snapshot response with info per job_id.
+        """
+        self._check_closed()
+
+        return sessions_snapshot_store.sync(
+            client=self._http,
+            session_id=self.session_id,
+            body=AppApiV2SchemasSessionCreateSnapshotRequest(
+                override_service=override_service,
+                override_version=override_version,
+                override_dataset=override_dataset,
+            ),
+            x_api_key=self._api_key,
+        )
+
     def disk_snapshot(
         self,
         override_service: str | None = None,

{plato_sdk_v2-2.2.3 → plato_sdk_v2-2.3.0}/plato/worlds/base.py

@@ -227,6 +227,131 @@ class BaseWorld(ABC, Generic[ConfigT]):
             return []
         return self.plato_session.envs
 
+    def get_sim_env_vars(self) -> dict[str, str]:
+        """Get environment variables from all configured sims.
+
+        Automatically discovers and loads env vars from sims like localstack, gitea, etc.
+        based on the environments configured in the world.
+
+        Returns:
+            Dict of environment variable name -> value
+
+        Example:
+            env_vars = self.get_sim_env_vars()
+            # Returns: {"AWS_ENDPOINT_URL": "https://...", "GITEA_URL": "https://...", ...}
+        """
+        env_vars: dict[str, str] = {}
+
+        # Known sim packages and their env aliases
+        sim_packages = [
+            ("localstack", "localstack"),
+            ("gitea", "gitea"),
+        ]
+
+        for package_name, env_alias in sim_packages:
+            env = self.get_env(env_alias)
+            if not env:
+                continue
+
+            try:
+                # Dynamically import the sim package
+                sim_module = __import__(f"plato.sims.{package_name}", fromlist=[package_name])
+
+                # Get service URLs and env vars
+                service_urls = sim_module.get_service_urls(env.job_id)
+                sim_vars = sim_module.get_env_vars(service_urls)
+                env_vars.update(sim_vars)
+                self.logger.info(f"{package_name} env vars: {list(sim_vars.keys())}")
+            except ImportError:
+                self.logger.debug(f"{package_name} sim package not installed, skipping")
+            except Exception as e:
+                self.logger.warning(f"Failed to get {package_name} env vars: {e}")
+
+        return env_vars
+
+    def get_sim_instructions(self) -> str:
+        """Get usage instructions from all configured sims.
+
+        Returns markdown-formatted instructions for using LocalStack, Gitea, etc.
+        based on the environments configured in the world.
+
+        Returns:
+            Markdown string with instructions, or empty string if no sims configured.
+
+        Example:
+            instructions = self.get_sim_instructions()
+            # Returns markdown with LocalStack/Gitea setup instructions
+        """
+        instructions_parts: list[str] = []
+
+        # Known sim packages and their env aliases
+        sim_packages = [
+            ("localstack", "localstack"),
+            ("gitea", "gitea"),
+        ]
+
+        for package_name, env_alias in sim_packages:
+            env = self.get_env(env_alias)
+            if not env:
+                continue
+
+            try:
+                # Dynamically import the sim package
+                sim_module = __import__(f"plato.sims.{package_name}", fromlist=[package_name])
+
+                # Get instructions using the job_id
+                if hasattr(sim_module, "get_instructions_from_job"):
+                    instructions = sim_module.get_instructions_from_job(env.job_id)
+                    if instructions:
+                        instructions_parts.append(instructions)
+                        self.logger.info(f"Added {package_name} instructions to prompt")
+            except ImportError:
+                self.logger.debug(f"{package_name} sim package not installed, skipping instructions")
+            except Exception as e:
+                self.logger.warning(f"Failed to get {package_name} instructions: {e}")
+
+        if instructions_parts:
+            return "\n\n---\n\n".join(instructions_parts)
+        return ""
+
+    def format_instruction_with_sims(self, instruction: str) -> str:
+        """Format an instruction with sim context prepended.
+
+        Automatically adds available service instructions (LocalStack, Gitea, etc.)
+        before the main instruction.
+
+        Args:
+            instruction: The base instruction/task
+
+        Returns:
+            Formatted instruction with sim context, or original instruction if no sims.
+
+        Example:
+            formatted = self.format_instruction_with_sims("Fix the bug in main.py")
+            # Returns:
+            # ## Available Services
+            # The following services are available...
+            # [LocalStack instructions]
+            # ---
+            # ## Task
+            # Fix the bug in main.py
+        """
+        sim_instructions = self.get_sim_instructions()
+
+        if sim_instructions:
+            return f"""## Available Services
+
+The following services are available for your use:
+
+{sim_instructions}
+
+---
+
+## Task
+
+{instruction}"""
+        return instruction
+
     async def run(self, config: ConfigT) -> None:
         """Run the world: reset -> step until done -> close.
 

plato_sdk_v2-2.2.3/VERSION

@@ -1 +0,0 @@
-2.2.3