redis-afs 0.1.0

Python SDK for the AFS control plane and agent filesystem mounts.

redis-afs

Python SDK for creating AFS workspaces, mounting them in-process, reading and writing files, checkpointing work, and running shell commands against an isolated AFS-backed workspace.

Install

pip install redis-afs

Quick Start

import os
from redis_afs import AFS

afs = AFS(api_key=os.environ["AFS_API_KEY"])
workspace = afs.workspace.create(name="foobar")

fs = afs.fs.mount(
    workspaces=[{"name": workspace["name"]}],
    mode="rw",
)

try:
    fs.write_file("/src/README.md", "hello world")
    result = fs.bash().exec("cat /foobar/src/README.md")
    print(result.stdout)
finally:
    fs.close()

MountedFS also works as a context manager:

with afs.fs.mount(workspaces=[{"name": "foobar"}], mode="rw") as fs:
    fs.write_file("/README.md", "hello")

Authentication

export AFS_API_KEY="afs_..."

Set AFS_API_BASE_URL to target a local or Self-managed control plane. If not provided, the SDK defaults to https://afs.cloud.

API Reference

See api-docs.md for the full Python API surface, including workspace management, checkpoints, mount semantics, file operations, shell execution, low-level MCP access, and current limitations.

Test

From sdk/python:

PYTHONPATH=src python3 -m unittest discover -s tests

From the project root:

PYTHONPATH=sdk/python/src python3 -m unittest discover -s sdk/python/tests