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.0a32.tar.gz (326.2 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.0a32-py3-none-any.whl (364.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.0a32.tar.gz
  • Upload date:
  • Size: 326.2 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.0a32.tar.gz
Algorithm Hash digest
SHA256 68d495a0a8b7fb167c174d28e7499d63958e19c284fc3411b2f5a75030862e4b
MD5 ad25eccc7972b393d10a4f0f40806a2e
BLAKE2b-256 7a6dc6ab6ad60fedb44e656e93f53c6be4a397a0575a7186cfa869ecd5111592

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.0a32-py3-none-any.whl
  • Upload date:
  • Size: 364.5 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.0a32-py3-none-any.whl
Algorithm Hash digest
SHA256 96098a6039cde1f6543cd8ddc881fa716bb012f2920b8f7347f5576c3dade2a8
MD5 51fcd05a7cae8f827ff0c5bcd5c95eaf
BLAKE2b-256 d5bcb9bf95e712ed8f2ec2c61d3f12a0efba6156265f015895598cf39df482a8

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