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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.3a2.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.3a2.tar.gz
Algorithm Hash digest
SHA256 766d86a4b884c28bdb529124461651aa4779793a2850cdca7b1476b108f85fee
MD5 d5a039959fd56ec9c4863a8c4f213aaa
BLAKE2b-256 b17a8a09c5d9e3775d6607a12e2b54ccbf185ec369c53eafebd580c1787fa488

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ppio_sandbox-1.1.3a2-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.3a2-py3-none-any.whl
Algorithm Hash digest
SHA256 108497461d78161ff9d11552a2fea034c33f6d8ba00bd9d15f959c6952fac653
MD5 e91fbce39235623e4f97df9484d5117f
BLAKE2b-256 29a9750bc23795457dea6d6ee1cc53110f6d1c2ed33e97dd362002a29f960f5e

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