blaxel 0.1.9rc37__tar.gz → 0.1.10rc39__tar.gz

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/.gitignore

@@ -23,4 +23,5 @@ dmypy.json
 /.coverage
 uv.lock
 
-telemetry.sh
+telemetry.sh
+definition.yml

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/Makefile

@@ -1,6 +1,19 @@
 ARGS:= $(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS))
 
-sdk:
+sdk-sandbox:
+	cp ../sandbox/sandbox-api/docs/openapi.yml ./definition.yml
+	rm -rf src/blaxel/sandbox/client/api src/blaxel/sandbox/client/models
+	openapi-python-client generate \
+		--path=definition.yml \
+		--output-path=./tmp-sdk-sandbox \
+		--overwrite \
+		--custom-template-path=./templates \
+		--config=./openapi-python-client.yml
+	cp -r ./tmp-sdk-sandbox/blaxel/* ./src/blaxel/sandbox/client
+	rm -rf ./tmp-sdk-sandbox
+	uv run ruff check --fix
+
+sdk-controlplane:
 	cp ../controlplane/api/api/definitions/controlplane.yml ./definition.yml
 	rm -rf src/blaxel/client/api src/blaxel/client/models
 	openapi-python-client generate \
@@ -13,6 +26,8 @@ sdk:
 	rm -rf ./tmp-sdk-python
 	uv run ruff check --fix
 
+sdk: sdk-sandbox sdk-controlplane
+
 doc:
 	rm -rf docs
 	uv run pdoc blaxel-docs src/blaxel -o docs --force --skip-errors

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: blaxel
-Version: 0.1.9rc37
+Version: 0.1.10rc39
 Summary: Add your description here
 Author-email: cploujoux <cploujoux@blaxel.ai>
 License-File: LICENSE

blaxel-0.1.10rc39/integrationtest/sandbox.py

@@ -0,0 +1,80 @@
+import asyncio
+import logging
+import os
+
+from blaxel.client.models import Metadata, Port, Runtime, Sandbox, SandboxSpec
+from blaxel.sandbox.base import ResponseError
+from blaxel.sandbox.client.models import ProcessRequest
+from blaxel.sandbox.sandbox import SandboxInstance
+
+logger = logging.getLogger(__name__)
+
+
+async def create_sandbox(sandbox_name: str):
+    # Create sandbox
+    image = "blaxel/prod-base:14769328323"
+    logger.info(f"Creating sandbox {sandbox_name} with image {image}")
+    sandbox = await SandboxInstance.create(Sandbox(
+        metadata=Metadata(name=sandbox_name),
+        spec=SandboxSpec(
+            runtime=Runtime(
+                image=image,
+                memory=2048,
+                cpu=2,
+                ports=[
+                    Port(name="sandbox-api", target=8080, protocol="HTTP")
+                ]
+            )
+        )
+    ))
+    logger.info("Waiting for sandbox to be deployed")
+    await sandbox.wait(max_wait=120000, interval=1000)
+    logger.info("Sandbox deployed")
+    return sandbox
+
+async def main():
+    user = os.environ.get("USER")
+    sandbox_name = "sandbox-test-3"
+    sandbox = None
+    try:
+        sandbox = await create_sandbox(sandbox_name)
+        sandbox = await SandboxInstance.get(sandbox_name)
+
+        # Filesystem tests
+        await sandbox.fs.write(f"/Users/{user}/Downloads/test", "Hello world")
+        content = await sandbox.fs.read(f"/Users/{user}/Downloads/test")
+        assert content == "Hello world", "File content is not correct"
+        dir = await sandbox.fs.ls(f"/Users/{user}/Downloads")
+        assert dir.files and len(dir.files) >= 1, "Directory is empty"
+        assert any(f.path == f"/Users/{user}/Downloads/test" for f in dir.files), "File not found in directory"
+        await sandbox.fs.mkdir(f"/Users/{user}/Downloads/test2")
+        after_mkdir = await sandbox.fs.ls(f"/Users/{user}/Downloads/test2")
+        assert not after_mkdir.files or len(after_mkdir.files) == 0, "Directory is not empty after mkdir"
+        await sandbox.fs.cp(f"/Users/{user}/Downloads/test", f"/Users/{user}/Downloads/test2/test")
+        after_cp_ls = await sandbox.fs.ls(f"/Users/{user}/Downloads/test2")
+        assert after_cp_ls.files and any(f.path == f"/Users/{user}/Downloads/test2/test" for f in after_cp_ls.files), "File not found in directory after cp"
+        await sandbox.fs.rm(f"/Users/{user}/Downloads/test")
+        try:
+            await sandbox.fs.rm(f"/Users/{user}/Downloads/test2")
+        except ResponseError as e:
+            logger.info(f"That is expected => {e.error}")
+        await sandbox.fs.rm(f"/Users/{user}/Downloads/test2", True)
+
+        # Process tests
+        process = await sandbox.process.exec(ProcessRequest(name="test", command="echo 'Hello world'"))
+        assert getattr(process, "status", None) != "completed", "Process did complete without waiting"
+        await asyncio.sleep(0.01)
+        completed_process = await sandbox.process.get("test")
+        assert getattr(completed_process, "status", None) == "completed", "Process did not complete"
+        logs = await sandbox.process.logs("test")
+        assert logs == 'Hello world\n', "Logs are not correct"
+        try:
+            await sandbox.process.kill("test")
+        except ResponseError as e:
+            logger.info(f"That is expected => {e.error}")
+    finally:
+        logger.info("Deleting sandbox")
+        await SandboxInstance.delete(sandbox_name)
+
+if __name__ == "__main__":
+    asyncio.run(main())

blaxel-0.1.10rc39/integrationtest/sandbox_small.py

@@ -0,0 +1,16 @@
+import asyncio
+import logging
+
+from blaxel.sandbox.sandbox import SandboxInstance
+
+logger = logging.getLogger(__name__)
+
+
+async def main():
+    sandbox_name = "base-3"
+    sandbox = await SandboxInstance.get(sandbox_name)
+    print(await sandbox.fs.ls("/"))
+    # Filesystem tests
+
+if __name__ == "__main__":
+    asyncio.run(main())

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "blaxel"
-version = "0.1.9.pre-37"
+version = "0.1.10.pre-39"
 description = "Add your description here"
 readme = "README.md"
 authors = [{ name = "cploujoux", email = "cploujoux@blaxel.ai" }]

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/src/blaxel/authentication/__init__.py

@@ -19,16 +19,25 @@ def get_credentials() -> Optional[CredentialsType]:
     Returns:
         Optional[CredentialsType]: The credentials or None if not found
     """
+    def get_workspace():
+        if os.environ.get("BL_WORKSPACE"):
+            return os.environ.get("BL_WORKSPACE")
+        home_dir = Path.home()
+        config_path = home_dir / '.blaxel' / 'config.yaml'
+        with open(config_path, encoding='utf-8') as f:
+            config_json = yaml.safe_load(f)
+        return config_json.get("context", {}).get("workspace")
+
     if os.environ.get("BL_API_KEY"):
         return CredentialsType(
             api_key=os.environ.get("BL_API_KEY"),
-            workspace=os.environ.get("BL_WORKSPACE")
+            workspace=get_workspace()
         )
 
     if os.environ.get("BL_CLIENT_CREDENTIALS"):
         return CredentialsType(
             client_credentials=os.environ.get("BL_CLIENT_CREDENTIALS"),
-            workspace=os.environ.get("BL_WORKSPACE")
+            workspace=get_workspace()
         )
 
     try:

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/src/blaxel/common/autoload.py

@@ -2,6 +2,7 @@ from ..client import client
 from ..instrumentation.manager import telemetry_manager
 from .settings import settings
 
+
 def autoload() -> None:
     client.with_base_url(settings.base_url)
     client.with_auth(settings.auth)

{blaxel-0.1.9rc37 → blaxel-0.1.10rc39}/src/blaxel/common/internal.py

@@ -2,24 +2,24 @@ import base64
 import hashlib
 import os
 import re
-from typing import Optional
 from logging import getLogger
+from typing import Optional
 
 logger = getLogger(__name__)
 
 def get_alphanumeric_limited_hash(input_str, max_size):
     # Create SHA-256 hash of the input string
     hash_obj = hashlib.sha256(input_str.encode('utf-8'))
-    
+
     # Get the hash digest in base64 format
     hash_base64 = base64.b64encode(hash_obj.digest()).decode('utf-8')
-    
+
     # Remove non-alphanumeric characters and convert to lowercase
     alphanumeric = re.sub(r'[^a-zA-Z0-9]', '', hash_base64).lower()
-    
+
     # Skip the first character to match the Node.js crypto output
     alphanumeric = alphanumeric[1:]
-    
+
     # Limit to max_size characters
     return alphanumeric[:max_size] if len(alphanumeric) > max_size else alphanumeric
 

blaxel-0.1.10rc39/src/blaxel/sandbox/base.py

@@ -0,0 +1,68 @@
+import os
+
+from httpx import Response
+
+from ..client.models import Sandbox
+from ..common.internal import get_global_unique_hash
+from ..common.settings import settings
+from .client.client import client
+from .client.models import ErrorResponse
+
+
+class ResponseError(Exception):
+    def __init__(self, response: Response):
+        self.status_code = response.status_code
+        self.status_text = response.content
+        self.error = None
+        data_error = {
+            "status": response.status_code,
+            "statusText": response.content,
+        }
+        if hasattr(response, "parsed") and isinstance(response.parsed, ErrorResponse):
+            data_error["error"] = response.parsed.error
+            self.error = response.parsed.error
+        super().__init__(str(data_error))
+
+
+class SandboxHandleBase:
+    def __init__(self, sandbox: Sandbox):
+        self.sandbox = sandbox
+        self.client = client.with_base_url(self.url).with_headers(settings.headers)
+
+    @property
+    def name(self):
+        return self.sandbox.metadata and self.sandbox.metadata.name
+
+    @property
+    def fallback_url(self):
+        if self.external_url != self.url:
+            return self.external_url
+        return None
+
+    @property
+    def external_url(self):
+        return f"{settings.run_url}/{settings.workspace}/sandboxes/{self.name}"
+
+    @property
+    def internal_url(self):
+        hash_ = get_global_unique_hash(settings.workspace, "sandbox", self.name)
+        return f"{settings.run_internal_protocol}://bl-{settings.env}-{hash_}.{settings.run_internal_hostname}"
+
+    @property
+    def forced_url(self):
+        env_var = self.name.replace("-", "_").upper()
+        env_name = f"BL_SANDBOX_{env_var}_URL"
+        return os.environ.get(env_name)
+
+    @property
+    def url(self):
+        if self.forced_url:
+            return self.forced_url
+        if settings.run_internal_hostname:
+            return self.internal_url
+        return self.external_url
+
+    def handle_response(self, response: Response):
+        if response.status_code >= 400:
+            raise ResponseError(response)
+

blaxel-0.1.10rc39/src/blaxel/sandbox/client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Sandbox API"""
+
+from .client import Client, client
+
+__all__ = (
+    "Client",
+    "client",
+)

blaxel-0.1.10rc39/src/blaxel/sandbox/client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

blaxel-0.1.10rc39/src/blaxel/sandbox/client/api/filesystem/delete_filesystem_path.py

@@ -0,0 +1,184 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.error_response import ErrorResponse
+from ...models.success_response import SuccessResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    path: str,
+    *,
+    recursive: Union[Unset, bool] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    params["recursive"] = recursive
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": f"/filesystem/{path}",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[ErrorResponse, SuccessResponse]]:
+    if response.status_code == 200:
+        response_200 = SuccessResponse.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[ErrorResponse, SuccessResponse]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    path: str,
+    *,
+    client: Union[Client],
+    recursive: Union[Unset, bool] = UNSET,
+) -> Response[Union[ErrorResponse, SuccessResponse]]:
+    """Delete file or directory
+
+     Delete a file or directory
+
+    Args:
+        path (str):
+        recursive (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, SuccessResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        path=path,
+        recursive=recursive,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    path: str,
+    *,
+    client: Union[Client],
+    recursive: Union[Unset, bool] = UNSET,
+) -> Optional[Union[ErrorResponse, SuccessResponse]]:
+    """Delete file or directory
+
+     Delete a file or directory
+
+    Args:
+        path (str):
+        recursive (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, SuccessResponse]
+    """
+
+    return sync_detailed(
+        path=path,
+        client=client,
+        recursive=recursive,
+    ).parsed
+
+
+async def asyncio_detailed(
+    path: str,
+    *,
+    client: Union[Client],
+    recursive: Union[Unset, bool] = UNSET,
+) -> Response[Union[ErrorResponse, SuccessResponse]]:
+    """Delete file or directory
+
+     Delete a file or directory
+
+    Args:
+        path (str):
+        recursive (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, SuccessResponse]]
+    """
+
+    kwargs = _get_kwargs(
+        path=path,
+        recursive=recursive,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    path: str,
+    *,
+    client: Union[Client],
+    recursive: Union[Unset, bool] = UNSET,
+) -> Optional[Union[ErrorResponse, SuccessResponse]]:
+    """Delete file or directory
+
+     Delete a file or directory
+
+    Args:
+        path (str):
+        recursive (Union[Unset, bool]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, SuccessResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            path=path,
+            client=client,
+            recursive=recursive,
+        )
+    ).parsed

blaxel-0.1.10rc39/src/blaxel/sandbox/client/api/filesystem/get_filesystem_path.py

@@ -0,0 +1,184 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.directory import Directory
+from ...models.error_response import ErrorResponse
+from ...models.file_with_content import FileWithContent
+from ...types import Response
+
+
+def _get_kwargs(
+    path: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/filesystem/{path}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Client, response: httpx.Response
+) -> Optional[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    if response.status_code == 200:
+
+        def _parse_response_200(data: object) -> Union["Directory", "FileWithContent"]:
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                response_200_type_0 = Directory.from_dict(data)
+
+                return response_200_type_0
+            except:  # noqa: E722
+                pass
+            if not isinstance(data, dict):
+                raise TypeError()
+            response_200_type_1 = FileWithContent.from_dict(data)
+
+            return response_200_type_1
+
+        response_200 = _parse_response_200(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = ErrorResponse.from_dict(response.json())
+
+        return response_404
+    if response.status_code == 500:
+        response_500 = ErrorResponse.from_dict(response.json())
+
+        return response_500
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Client, response: httpx.Response
+) -> Response[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    path: str,
+    *,
+    client: Union[Client],
+) -> Response[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    """Get file or directory information
+
+     Get content of a file or listing of a directory
+
+    Args:
+        path (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, Union['Directory', 'FileWithContent']]]
+    """
+
+    kwargs = _get_kwargs(
+        path=path,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    path: str,
+    *,
+    client: Union[Client],
+) -> Optional[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    """Get file or directory information
+
+     Get content of a file or listing of a directory
+
+    Args:
+        path (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, Union['Directory', 'FileWithContent']]
+    """
+
+    return sync_detailed(
+        path=path,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    path: str,
+    *,
+    client: Union[Client],
+) -> Response[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    """Get file or directory information
+
+     Get content of a file or listing of a directory
+
+    Args:
+        path (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[ErrorResponse, Union['Directory', 'FileWithContent']]]
+    """
+
+    kwargs = _get_kwargs(
+        path=path,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    path: str,
+    *,
+    client: Union[Client],
+) -> Optional[Union[ErrorResponse, Union["Directory", "FileWithContent"]]]:
+    """Get file or directory information
+
+     Get content of a file or listing of a directory
+
+    Args:
+        path (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[ErrorResponse, Union['Directory', 'FileWithContent']]
+    """
+
+    return (
+        await asyncio_detailed(
+            path=path,
+            client=client,
+        )
+    ).parsed