Skip to content

Commit e37c444

Browse files
committed
brief description of sanboxes
1 parent dd817c8 commit e37c444

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,26 @@ This is the official Python SDK for Koyeb, a platform that allows you to deploy
66

77
- `koyeb.api`: Contains the API client and methods to interact with Koyeb's REST API. [Documentation](./docs/api.md)
88
- `koyeb.sandbox`: Contains the Sandbox module. [Documentation](./docs/sandbox.md)
9+
10+
## Koyeb Sanboxes
11+
12+
A **code sandbox** is an isolated, ephemeral environment designed to safely run, test, and experiment with code without affecting other systems or requiring complex setup. It provides developers with a virtualized or containerized execution space where dependencies, environment variables, and runtime contexts can be fully controlled and discarded after use.
13+
14+
You should use a code sandbox to:
15+
16+
- Execute untrusted or user-generated code securely
17+
- Prototype applications quickly
18+
- Test APIs or libraries in clean environments
19+
- Demonstrate functionality without configuring local infrastructure
20+
21+
Sandboxes are especially valuable in platforms for AI model evaluation, online coding environments, CI/CD pipelines, and educational tools that require safe, reproducible, and on-demand compute environments.
22+
23+
With **Koyeb Sandboxes**, you can manage fully flexible sandbox environments at scale using the Koyeb Python SDK.
24+
25+
### The Koyeb Sandbox Python module
26+
27+
The Koyeb Sandbox Python module contains functionality to take any actions needed on your sanboxes, including creating and deleting sanboxes, file manipulation, running commands, managing port exposure, and more.
28+
29+
[View the reference for the Sandbox module](./docs/sandbox.md)
30+
31+
[View Sandboxes documentation on the Koyeb website](https://www.koyeb.com/docs/sandboxes)

0 commit comments

Comments
 (0)