bashkit 0.1.18__tar.gz → 0.1.19__tar.gz

{bashkit-0.1.18 → bashkit-0.1.19}/Cargo.lock

@@ -319,7 +319,7 @@ checksum = "2af50177e190e07a26ab74f8b1efbfe2ef87da2116221318cb1c2e82baf7de06"
 
 [[package]]
 name = "bashkit"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -365,7 +365,7 @@ dependencies = [
 
 [[package]]
 name = "bashkit-bench"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "anyhow",
  "bashkit",
@@ -380,7 +380,7 @@ dependencies = [
 
 [[package]]
 name = "bashkit-cli"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "anyhow",
  "bashkit",
@@ -396,7 +396,7 @@ dependencies = [
 
 [[package]]
 name = "bashkit-eval"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -412,7 +412,7 @@ dependencies = [
 
 [[package]]
 name = "bashkit-js"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "bashkit",
  "napi",
@@ -425,7 +425,7 @@ dependencies = [
 
 [[package]]
 name = "bashkit-python"
-version = "0.1.18"
+version = "0.1.19"
 dependencies = [
  "bashkit",
  "num-bigint",
@@ -4607,9 +4607,9 @@ checksum = "f87165f0995f63a9fbeea62b64d10b4d9d8e78ec6d7d51fb2125fda7bb36788f"
 
 [[package]]
 name = "rustls-webpki"
-version = "0.103.10"
+version = "0.103.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "df33b2b81ac578cabaf06b89b0631153a3f416b0a886e8a7a1707fb51abbd1ef"
+checksum = "8279bb85272c9f10811ae6a6c547ff594d6a7f3c6c6b02ee9726d1d0dcfcdd06"
 dependencies = [
  "aws-lc-rs",
  "ring",
@@ -5321,7 +5321,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd"
 dependencies = [
  "fastrand",
- "getrandom 0.3.4",
+ "getrandom 0.4.2",
  "once_cell",
  "rustix",
  "windows-sys 0.61.2",

{bashkit-0.1.18 → bashkit-0.1.19}/Cargo.toml

@@ -7,7 +7,7 @@ resolver = "2"
 members = ["crates/*"]
 
 [workspace.package]
-version = "0.1.18"
+version = "0.1.19"
 edition = "2024"
 license = "MIT"
 authors = ["Everruns"]

bashkit-0.1.19/PKG-INFO

@@ -0,0 +1,402 @@
+Metadata-Version: 2.4
+Name: bashkit
+Version: 0.1.19
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Rust
+Classifier: Topic :: Software Development :: Interpreters
+Classifier: Topic :: Security
+Requires-Dist: deepagents>=0.3.11 ; extra == 'deepagents'
+Requires-Dist: langchain-anthropic>=0.3 ; extra == 'deepagents'
+Requires-Dist: pytest>=7.0 ; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23 ; extra == 'dev'
+Requires-Dist: langchain-core>=0.3 ; extra == 'langchain'
+Requires-Dist: langchain-anthropic>=0.3 ; extra == 'langchain'
+Requires-Dist: pydantic-ai>=1.0 ; extra == 'pydantic-ai'
+Provides-Extra: deepagents
+Provides-Extra: dev
+Provides-Extra: langchain
+Provides-Extra: pydantic-ai
+Summary: A sandboxed bash interpreter for AI agents
+Keywords: bash,sandbox,ai,agent,shell,interpreter
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Changelog, https://github.com/everruns/bashkit/releases
+Project-URL: Homepage, https://github.com/everruns/bashkit
+Project-URL: Issues, https://github.com/everruns/bashkit/issues
+Project-URL: Repository, https://github.com/everruns/bashkit
+
+# Bashkit
+
+[![PyPI](https://img.shields.io/pypi/v/bashkit)](https://pypi.org/project/bashkit/)
+
+Sandboxed bash interpreter for Python. Native bindings to the `bashkit` Rust core for fast, in-process execution with a virtual filesystem.
+
+## Features
+
+- Sandboxed execution in-process, without containers or subprocess orchestration
+- Full bash syntax: variables, pipelines, redirects, loops, functions, and arrays
+- 160 built-in commands including `grep`, `sed`, `awk`, `jq`, `curl`, and `find`
+- Persistent interpreter state across calls, including variables, cwd, and VFS contents
+- Direct virtual filesystem APIs, constructor mounts, and live host mounts
+- Snapshot and restore support on `Bash` and `BashTool`
+- AI integrations for LangChain, PydanticAI, and Deep Agents
+
+## Installation
+
+```bash
+pip install bashkit
+
+# Optional integrations
+pip install 'bashkit[langchain]'
+pip install 'bashkit[pydantic-ai]'
+pip install 'bashkit[deepagents]'
+```
+
+## Quick Start
+
+### Sync Execution
+
+```python
+from bashkit import Bash
+
+bash = Bash()
+
+result = bash.execute_sync("echo 'Hello, World!'")
+print(result.stdout)  # Hello, World!
+
+bash.execute_sync("export APP_ENV=dev")
+print(bash.execute_sync("echo $APP_ENV").stdout)  # dev
+```
+
+### Async Execution
+
+```python
+import asyncio
+from bashkit import Bash
+
+
+async def main():
+    bash = Bash()
+
+    result = await bash.execute("echo -e 'banana\\napple\\ncherry' | sort")
+    print(result.stdout)  # apple\nbanana\ncherry
+
+    await bash.execute("printf 'data\\n' > /tmp/file.txt")
+    saved = await bash.execute("cat /tmp/file.txt")
+    print(saved.stdout)  # data
+
+
+asyncio.run(main())
+```
+
+## Configuration
+
+### Constructor Options
+
+```python
+from bashkit import Bash
+
+bash = Bash(
+    username="agent",
+    hostname="sandbox",
+    max_commands=1000,
+    max_loop_iterations=10000,
+    max_memory=10 * 1024 * 1024,
+    timeout_seconds=30,
+    python=False,
+)
+```
+
+## Virtual Filesystem
+
+### Direct Methods on Bash and BashTool
+
+```python
+from bashkit import Bash
+
+bash = Bash()
+bash.mkdir("/data", recursive=True)
+bash.write_file("/data/config.json", '{"debug": true}\n')
+bash.append_file("/data/config.json", '{"trace": false}\n')
+
+print(bash.read_file("/data/config.json"))
+print(bash.exists("/data/config.json"))
+print(bash.ls("/data"))
+print(bash.glob("/data/*.json"))
+```
+
+The same direct filesystem helpers are available on `BashTool()`.
+
+### FileSystem Accessor
+
+```python
+from bashkit import Bash
+
+bash = Bash()
+fs = bash.fs()
+
+fs.mkdir("/data", recursive=True)
+fs.write_file("/data/blob.bin", b"\x00\x01hello")
+fs.copy("/data/blob.bin", "/data/backup.bin")
+
+assert fs.read_file("/data/blob.bin") == b"\x00\x01hello"
+assert fs.exists("/data/backup.bin")
+```
+
+### Pre-Initialized Files
+
+```python
+from bashkit import Bash
+
+bash = Bash(files={
+    "/config/static.txt": "ready\n",
+    "/config/report.json": lambda: '{"ok": true}\n',
+})
+
+print(bash.execute_sync("cat /config/static.txt").stdout)
+print(bash.execute_sync("cat /config/report.json").stdout)
+```
+
+### Real Filesystem Mounts
+
+```python
+from bashkit import Bash
+
+bash = Bash(mounts=[
+    {"host_path": "/path/to/data", "vfs_path": "/data"},
+    {"host_path": "/path/to/workspace", "vfs_path": "/workspace", "writable": True},
+])
+
+print(bash.execute_sync("ls /workspace").stdout)
+```
+
+### Live Mounts
+
+```python
+from bashkit import Bash, FileSystem
+
+bash = Bash()
+workspace = FileSystem.real("/path/to/workspace", writable=True)
+
+bash.mount("/workspace", workspace)
+bash.execute_sync("echo 'hello' > /workspace/demo.txt")
+bash.unmount("/workspace")
+```
+
+## Error Handling
+
+```python
+from bashkit import Bash, BashError
+
+bash = Bash()
+
+try:
+    bash.execute_sync_or_throw("exit 42")
+except BashError as err:
+    print(err.exit_code)  # 42
+    print(err.stderr)
+    print(str(err))
+```
+
+Use `execute_or_throw()` and `execute_sync_or_throw()` when you want failures surfaced as exceptions instead of inspecting `exit_code` manually.
+
+## Cancellation
+
+```python
+from bashkit import Bash
+
+bash = Bash()
+
+bash.cancel()  # no-op if nothing is running
+bash.reset()   # reset state before reusing the instance
+```
+
+`BashTool` exposes the same `cancel()` and `reset()` methods.
+
+## BashTool
+
+`BashTool` wraps `Bash` and adds tool-contract metadata for agent frameworks:
+
+- `name`
+- `short_description`
+- `version`
+- `description()`
+- `help()`
+- `system_prompt()`
+- `input_schema()`
+- `output_schema()`
+
+```python
+from bashkit import BashTool
+
+tool = BashTool()
+
+print(tool.description())
+print(tool.input_schema())
+
+result = tool.execute_sync("echo 'Hello from BashTool'")
+print(result.stdout)
+```
+
+## ScriptedTool
+
+Use `ScriptedTool` to register Python callbacks as bash-callable tools:
+
+```python
+from bashkit import ScriptedTool
+
+
+def get_user(params, stdin=None):
+    return '{"id": 1, "name": "Alice"}'
+
+
+tool = ScriptedTool("api")
+tool.add_tool(
+    "get_user",
+    "Fetch user by ID",
+    callback=get_user,
+    schema={"type": "object", "properties": {"id": {"type": "integer"}}},
+)
+
+result = tool.execute_sync("get_user --id 1 | jq -r '.name'")
+print(result.stdout)  # Alice
+```
+
+## Snapshot / Restore
+
+```python
+from bashkit import Bash
+
+bash = Bash(username="agent", max_commands=100)
+bash.execute_sync("export BUILD_ID=42; mkdir -p /workspace && cd /workspace && echo ready > state.txt")
+
+snapshot = bash.snapshot()
+
+restored = Bash.from_snapshot(snapshot, username="agent", max_commands=100)
+assert restored.execute_sync("echo $BUILD_ID").stdout.strip() == "42"
+assert restored.execute_sync("cat /workspace/state.txt").stdout.strip() == "ready"
+
+restored.reset()
+restored.restore_snapshot(snapshot)
+assert restored.execute_sync("pwd").stdout.strip() == "/workspace"
+```
+
+`BashTool` exposes the same `snapshot()`, `restore_snapshot(...)`, and `from_snapshot(...)` APIs.
+
+## Framework Integrations
+
+### LangChain
+
+```python
+from bashkit.langchain import create_bash_tool
+
+tool = create_bash_tool()
+```
+
+### PydanticAI
+
+```python
+from bashkit.pydantic_ai import create_bash_tool
+
+tool = create_bash_tool()
+```
+
+### Deep Agents
+
+```python
+from bashkit.deepagents import BashkitBackend, BashkitMiddleware
+```
+
+## API Reference
+
+### Bash
+
+- `execute(commands: str) -> ExecResult`
+- `execute_sync(commands: str) -> ExecResult`
+- `execute_or_throw(commands: str) -> ExecResult`
+- `execute_sync_or_throw(commands: str) -> ExecResult`
+- `cancel()`
+- `reset()`
+- `snapshot() -> bytes`
+- `restore_snapshot(data: bytes)`
+- `from_snapshot(data: bytes, **kwargs) -> Bash`
+- `mount(vfs_path: str, fs: FileSystem)`
+- `unmount(vfs_path: str)`
+- Direct VFS helpers: `read_file`, `write_file`, `append_file`, `mkdir`, `remove`, `exists`, `stat`, `read_dir`, `ls`, `glob`, `copy`, `rename`, `symlink`, `chmod`, `read_link`
+
+### BashTool
+
+- All execution, cancellation, reset, snapshot, restore, mount, and direct VFS helpers from `Bash`
+- Tool metadata: `name`, `short_description`, `version`
+- `description() -> str`
+- `help() -> str`
+- `system_prompt() -> str`
+- `input_schema() -> str`
+- `output_schema() -> str`
+
+### ScriptedTool
+
+- `add_tool(name, description, callback, schema=None)`
+- `execute(script: str) -> ExecResult`
+- `execute_sync(script: str) -> ExecResult`
+- `execute_or_throw(script: str) -> ExecResult`
+- `execute_sync_or_throw(script: str) -> ExecResult`
+- `env(key: str, value: str)`
+- `tool_count() -> int`
+
+### FileSystem
+
+- `mkdir(path, recursive=False)`
+- `write_file(path, content)`
+- `read_file(path) -> bytes`
+- `append_file(path, content)`
+- `exists(path) -> bool`
+- `remove(path, recursive=False)`
+- `stat(path) -> dict`
+- `read_dir(path) -> list`
+- `rename(src, dst)`
+- `copy(src, dst)`
+- `symlink(target, link)`
+- `chmod(path, mode)`
+- `read_link(path) -> str`
+- `FileSystem.real(host_path, writable=False) -> FileSystem`
+
+### ExecResult and BashError
+
+- `ExecResult.stdout`
+- `ExecResult.stderr`
+- `ExecResult.exit_code`
+- `ExecResult.error`
+- `ExecResult.success`
+- `ExecResult.to_dict()`
+- `BashError.exit_code`
+- `BashError.stderr`
+
+## Platform Support
+
+- Linux: `x86_64`, `aarch64` (glibc and musl wheels)
+- macOS: `x86_64`, `aarch64`
+- Windows: `x86_64`
+- Python: `3.9` through `3.13`
+
+## How It Works
+
+Bashkit is built on the `bashkit` Rust core, which implements a sandboxed bash interpreter and virtual filesystem. The Python package exposes that engine through a native extension, so commands run in-process with persistent state and resource limits, without shelling out to the host system.
+
+## Part of Everruns
+
+Bashkit is part of the [Everruns](https://github.com/everruns) ecosystem. See the [bashkit monorepo](https://github.com/everruns/bashkit) for the Rust core, the JavaScript package (`@everruns/bashkit`), and related tooling.
+
+## License
+
+MIT
+