Skip to main content

PPIO Sandbox SDK - Python library for PPIO Agent Sandbox

Project description

PPIO Sandbox SDK for Python

Python SDK for PPIO Sandbox environments, providing code execution, desktop automation, and cloud computing capabilities, which is compatible with e2b.

Please read the documentation for more information.

Installation

pip install ppio-sandbox

Features

  • 🚀 Code Interpreter: Execute Python, JavaScript, and other languages in isolated environments
  • 🖥️ Desktop Automation: Control desktop applications and GUI interactions
  • ☁️ Cloud Computing: Scalable sandbox environments for various computing tasks
  • 📊 Data Visualization: Built-in charting and visualization capabilities
  • 🔧 File System Operations: Complete file system management and monitoring

Quick Start

Authentication

You can get the PPIO API key by refer to this documentation.

Core

The basic package provides a way to interact with the sandbox environment.

from ppio_sandbox.core import Sandbox
import os

# Using the official template `base` by default
sandbox = Sandbox.create(
    template="base",
    api_key=os.getenv("PPIO_API_KEY", "")
)

# File operations
sandbox.files.write('/tmp/test.txt', 'Hello, World!')
content = sandbox.files.read('/tmp/test.txt')

# Command execution
result = sandbox.commands.run('ls -la /tmp')
print(result.stdout)

sandbox.kill()

Code Interpreter

The Code Interpreter sandbox provides a Jupyter-like environment for executing code using the official code-interpreter-v1 template.

from ppio_sandbox.code_interpreter import Sandbox
import os

sandbox = Sandbox.create(
    api_key=os.getenv("PPIO_API_KEY", "")
)

# Execute Python code
result = sandbox.run_code('print("Hello, World!")')
print(result.logs)

sandbox.kill()

Desktop

The Desktop sandbox allows you to control desktop environments programmatically using the official desktop template.

from ppio_sandbox.desktop import Sandbox
import os

desktop = Sandbox.create(
    api_key=os.getenv("PPIO_API_KEY", "")
)

# Take a screenshot
screenshot = desktop.screenshot()

# Automate mouse and keyboard
desktop.left_click(100, 200)
desktop.press('Return')
desktop.write('Hello, World!')

desktop.kill()

Development

Install

poetry install --with dev --extras "all" 

Test

make test
make test-core
make test-code-interpreter
make test-desktop

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ppio_sandbox-1.1.0a19.tar.gz (323.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ppio_sandbox-1.1.0a19-py3-none-any.whl (361.7 kB view details)

Uploaded Python 3

File details

Details for the file ppio_sandbox-1.1.0a19.tar.gz.

File metadata

  • Download URL: ppio_sandbox-1.1.0a19.tar.gz
  • Upload date:
  • Size: 323.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.11 Linux/6.11.0-1018-azure

File hashes

Hashes for ppio_sandbox-1.1.0a19.tar.gz
Algorithm Hash digest
SHA256 99d79907b1d53b71a0b645d8e7db3b9e0f3331b1162e5e49ea1132fe16b3dce7
MD5 5c6ed20e7fe55f0c407a9df40d46091e
BLAKE2b-256 3af1e71530dd615e6e728237326aa2c9cb43262901114b42f7189e67455637a0

See more details on using hashes here.

File details

Details for the file ppio_sandbox-1.1.0a19-py3-none-any.whl.

File metadata

  • Download URL: ppio_sandbox-1.1.0a19-py3-none-any.whl
  • Upload date:
  • Size: 361.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.11 Linux/6.11.0-1018-azure

File hashes

Hashes for ppio_sandbox-1.1.0a19-py3-none-any.whl
Algorithm Hash digest
SHA256 caedaa7a047b59b285abf4ab40690fdbcf8c3e18a22e945481d5e8d6d02c18bd
MD5 638dae85dcf1f1bdea49ba79a1dd9cf8
BLAKE2b-256 43ff33c70db3f1fe94dcb5cac0facce4ce26d718c0fa0d357826f26816b3d03f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page