scalebox-sdk 0.1.24__py3-none-any.whl → 1.0.1__py3-none-any.whl

scalebox/connection_config.py

@@ -1,5 +1,5 @@
 import os
-from typing import Dict, Literal, Optional
+from typing import Dict, Literal, Optional, TypedDict
 
 from httpx._types import ProxyTypes
 
@@ -10,6 +10,33 @@ REQUEST_TIMEOUT: float = 30.0  # 30 seconds
 KEEPALIVE_PING_INTERVAL_SEC = 50  # 50 seconds
 KEEPALIVE_PING_HEADER = "Keepalive-Ping-Interval"
 
+class ApiParams(TypedDict, total=False):
+    """
+    Parameters for a request.
+
+    In the case of a sandbox, it applies to all **requests made to the returned sandbox**.
+    """
+
+    request_timeout: Optional[float]
+    """Timeout for the request in **seconds**, defaults to 60 seconds."""
+
+    headers: Optional[Dict[str, str]]
+    """Additional headers to send with the request."""
+
+    api_key: Optional[str]
+    """SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable."""
+
+    domain: Optional[str]
+    """SBX domain to use for authentication, defaults to `SBX_DOMAIN` environment variable."""
+
+    api_url: Optional[str]
+    """URL to use for the API, defaults to `https://api.<domain>`. For internal use only."""
+
+    debug: Optional[bool]
+    """Whether to use debug mode, defaults to `SBX_DEBUG` environment variable."""
+
+    proxy: Optional[ProxyTypes]
+    """Proxy to use for the request. In case of a sandbox it applies to all **requests made to the returned sandbox**."""
 
 class ConnectionConfig:
     """
@@ -32,6 +59,10 @@ class ConnectionConfig:
     def _access_token():
         return os.getenv("SBX_ACCESS_TOKEN")
 
+    @staticmethod
+    def _debug_host():
+        return os.getenv("SBX_DEBUG_HOST") or "localhost"
+
     def __init__(
         self,
         domain: Optional[str] = None,
@@ -41,11 +72,13 @@ class ConnectionConfig:
         request_timeout: Optional[float] = None,
         headers: Optional[Dict[str, str]] = None,
         proxy: Optional[ProxyTypes] = None,
+        debug_host: Optional[str] = None,
     ):
         self.domain = domain or ConnectionConfig._domain()
         self.debug = debug or ConnectionConfig._debug()
         self.api_key = api_key or ConnectionConfig._api_key()
         self.access_token = access_token or ConnectionConfig._access_token()
+        self.debug_host = debug_host or ConnectionConfig._debug_host()
         self.headers = headers or {}
         # self.headers["User-Agent"] = f"csx-python-sdk/{package_version}"
 

scalebox/csx_connect/__init__.py

@@ -1 +1 @@
-from .client import Client, Code, ConnectException, GzipCompressor  # noqa: F401
+from .client import Client, Code, ConnectException, GzipCompressor  # noqa: F401