scalebox-sdk 0.1.21__py3-none-any.whl → 0.1.22__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- scalebox/__init__.py +1 -1
- scalebox/sandbox_async/main.py +9 -9
- scalebox/sandbox_async/sandbox_api.py +365 -365
- scalebox/sandbox_sync/main.py +10 -10
- scalebox/sandbox_sync/sandbox_api.py +356 -356
- scalebox/version.py +2 -2
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/METADATA +1 -1
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/RECORD +12 -12
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/WHEEL +0 -0
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/entry_points.txt +0 -0
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/licenses/LICENSE +0 -0
- {scalebox_sdk-0.1.21.dist-info → scalebox_sdk-0.1.22.dist-info}/top_level.txt +0 -0
scalebox/sandbox_sync/main.py
CHANGED
|
@@ -45,7 +45,7 @@ class SandboxOpts(TypedDict):
|
|
|
45
45
|
|
|
46
46
|
class Sandbox(SandboxSetup, SandboxApi):
|
|
47
47
|
"""
|
|
48
|
-
|
|
48
|
+
SBX cloud sandbox is a secure and isolated cloud environment.
|
|
49
49
|
|
|
50
50
|
The sandbox allows you to:
|
|
51
51
|
- Access Linux OS
|
|
@@ -60,7 +60,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
60
60
|
|
|
61
61
|
Example:
|
|
62
62
|
```python
|
|
63
|
-
from
|
|
63
|
+
from SBX import Sandbox
|
|
64
64
|
|
|
65
65
|
sandbox = Sandbox()
|
|
66
66
|
```
|
|
@@ -144,7 +144,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
144
144
|
:param timeout: Timeout for the sandbox in **seconds**, default to 300 seconds. Maximum time a sandbox can be kept alive is 24 hours (86_400 seconds) for Pro users and 1 hour (3_600 seconds) for Hobby users
|
|
145
145
|
:param metadata: Custom metadata for the sandbox
|
|
146
146
|
:param envs: Custom environment variables for the sandbox
|
|
147
|
-
:param api_key:
|
|
147
|
+
:param api_key: SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
148
148
|
:param request_timeout: Timeout for the request in **seconds**
|
|
149
149
|
:param proxy: Proxy to use for the request and for the **requests made to the returned sandbox**
|
|
150
150
|
:param allow_internet_access: Allow sandbox to access the internet, defaults to `True`
|
|
@@ -482,7 +482,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
482
482
|
With sandbox ID you can connect to the same sandbox from different places or environments (serverless functions, etc).
|
|
483
483
|
|
|
484
484
|
:param sandbox_id: Sandbox ID
|
|
485
|
-
:param api_key:
|
|
485
|
+
:param api_key: Scalebox API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
486
486
|
:param proxy: Proxy to use for the request and for the **requests made to the returned sandbox**
|
|
487
487
|
|
|
488
488
|
:return: sandbox instance for the existing sandbox
|
|
@@ -557,7 +557,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
557
557
|
Kill the sandbox specified by sandbox ID.
|
|
558
558
|
|
|
559
559
|
:param sandbox_id: Sandbox ID
|
|
560
|
-
:param api_key:
|
|
560
|
+
:param api_key: SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
561
561
|
:param request_timeout: Timeout for the request in **seconds**
|
|
562
562
|
:param proxy: Proxy to use for the request
|
|
563
563
|
|
|
@@ -623,7 +623,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
623
623
|
|
|
624
624
|
:param sandbox_id: Sandbox ID
|
|
625
625
|
:param timeout: Timeout for the sandbox in **seconds**
|
|
626
|
-
:param api_key:
|
|
626
|
+
:param api_key: SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
627
627
|
:param request_timeout: Timeout for the request in **seconds**
|
|
628
628
|
:param proxy: Proxy to use for the request
|
|
629
629
|
"""
|
|
@@ -674,9 +674,9 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
674
674
|
"""
|
|
675
675
|
Get sandbox information like sandbox ID, template, metadata, started at/end at date.
|
|
676
676
|
:param sandbox_id: Sandbox ID
|
|
677
|
-
:param api_key:
|
|
678
|
-
:param domain:
|
|
679
|
-
:param debug: Whether to use debug mode, defaults to `
|
|
677
|
+
:param api_key: SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
678
|
+
:param domain: SBX domain to use for authentication, defaults to `SBX_DOMAIN` environment variable
|
|
679
|
+
:param debug: Whether to use debug mode, defaults to `SBX_DEBUG` environment variable
|
|
680
680
|
:param request_timeout: Timeout for the request in **seconds**
|
|
681
681
|
:param headers: Custom headers to use for the request
|
|
682
682
|
:param proxy: Proxy to use for the request
|
|
@@ -741,7 +741,7 @@ class Sandbox(SandboxSetup, SandboxApi):
|
|
|
741
741
|
:param sandbox_id: Sandbox ID
|
|
742
742
|
:param start: Start time for the metrics, defaults to the start of the sandbox
|
|
743
743
|
:param end: End time for the metrics, defaults to current time
|
|
744
|
-
:param api_key:
|
|
744
|
+
:param api_key: SBX API Key to use for authentication, defaults to `SBX_API_KEY` environment variable
|
|
745
745
|
:param request_timeout: Timeout for the request in **seconds**
|
|
746
746
|
|
|
747
747
|
:return: List of sandbox metrics containing CPU, memory and disk usage information
|