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.1a1.tar.gz (357.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.1a1-py3-none-any.whl (414.2 kB view details)

Uploaded Python 3

File details

Details for the file ppio_sandbox-1.1.1a1.tar.gz.

File metadata

  • Download URL: ppio_sandbox-1.1.1a1.tar.gz
  • Upload date:
  • Size: 357.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.12 Linux/6.11.0-1018-azure

File hashes

Hashes for ppio_sandbox-1.1.1a1.tar.gz
Algorithm Hash digest
SHA256 f6932a4fcd4b88c4d6100b3f74c074198115d769d55c5d4c1675da2702109451
MD5 4d8745f77af08ce0c85ea3aa1cc995c5
BLAKE2b-256 3e211332af0515e200fa5ca3d81739dd796d43ce1f7ff13d0375b9440b7636b3

See more details on using hashes here.

File details

Details for the file ppio_sandbox-1.1.1a1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ppio_sandbox-1.1.1a1-py3-none-any.whl
Algorithm Hash digest
SHA256 324185a8f440811081ba5048a74413751ab34ae92578890822d43e87de300241
MD5 9b87bcbde961e28b83943a21f60c3749
BLAKE2b-256 188fff118c436f810d4516c9a5109bec135fe9b1c747e97c99da6cc37740b73f

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