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.3b1.tar.gz (339.1 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.3b1-py3-none-any.whl (391.0 kB view details)

Uploaded Python 3

File details

Details for the file ppio_sandbox-1.1.3b1.tar.gz.

File metadata

  • Download URL: ppio_sandbox-1.1.3b1.tar.gz
  • Upload date:
  • Size: 339.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.13 Linux/6.17.0-1008-azure

File hashes

Hashes for ppio_sandbox-1.1.3b1.tar.gz
Algorithm Hash digest
SHA256 deee5455cc01bd1a980bb0da85a860b503cc028e35253d9b46fe4647d7ab7192
MD5 8404e60dc01e98f366ba5c66f9310cc9
BLAKE2b-256 2594418e8600ae365f08f1a68f5ce65b74136483704389f870b42055c24ce4dd

See more details on using hashes here.

File details

Details for the file ppio_sandbox-1.1.3b1-py3-none-any.whl.

File metadata

  • Download URL: ppio_sandbox-1.1.3b1-py3-none-any.whl
  • Upload date:
  • Size: 391.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.13 Linux/6.17.0-1008-azure

File hashes

Hashes for ppio_sandbox-1.1.3b1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd11289d698402b9963806e63cd22810a7d98d67dced4dd312d0440f62c99d69
MD5 13e9ce5a34a173228080125e7e8cd541
BLAKE2b-256 72404a6d587efb3ab24db59050e5e41b15b056f0b399a3142b89ee44606d0c69

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