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.0a27.tar.gz (328.6 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.0a27-py3-none-any.whl (367.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.0a27.tar.gz
  • Upload date:
  • Size: 328.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.12 Linux/6.14.0-1012-azure

File hashes

Hashes for ppio_sandbox-1.1.0a27.tar.gz
Algorithm Hash digest
SHA256 112f33a0e9b307be78ccd34e6c0e03151ae408e239132b9f43fee54b812f76c8
MD5 00fcbfa7229f76161b92cd0e8130200c
BLAKE2b-256 1fa1ae584ce5b669ca0e093e554993c4b17d81d39900afd054599836e118ef54

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.0a27-py3-none-any.whl
  • Upload date:
  • Size: 367.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.12 Linux/6.14.0-1012-azure

File hashes

Hashes for ppio_sandbox-1.1.0a27-py3-none-any.whl
Algorithm Hash digest
SHA256 f449b0ba43a3f06398838cb78717ff8218f4d8cb81043279c3b62cd5f1114fdf
MD5 9bc36f831573993f73180795fe23988e
BLAKE2b-256 febbb0c5e2ce8b84b384c74cdb2414a6f2ece5ba398ae2d8601e7b1ebf7dc4a9

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