How openmined/syft works
Project type and purpose
• This is a Python-based distributed application (“SyftBox”) that ships as a CLI/TUI client plus a server backend.
• The client side manages “apps” (user computations), data synchronization, benchmarking, and an interactive text UI.
• The server side exposes a REST API (versioned under /api/v1), persists metadata (SQL DB + file_store), sends email/telemetry, and hosts simple web templates.
File structure
• Top-level directories:
• syftbox/app – core entry points and CLI/manager logic
• syftbox/client – client SDK: API wrappers, plugin manager, benchmark modules, sync plugins, routers
• syftbox/lib – shared utilities, constants, workspace, permission logic
• syftbox/server – HTTP server: routers, middleware, DB layer, templates, emails, telemetry
• syftbox/tui – text UI widgets & driver
• Other folders:
• default_apps / projects / fetchers – example or user-supplied workloads that the client can schedule and sync
• config, docker, scripts, docs – deployment configs, Dockerfile, CI/CD pipelines, documentation.
README for additional insights
• Describes installation (uv, virtualenv), one-liner “install.sh” and “syftbox client” invocation.
• Mentions server deployment scripts and local dev mode for server+clients.
Detail
• Sub-components (e.g., benchmark/netstats_http, sync/producer, server/emails/router).
• Configuration points (config/prod, config/stage) and deployment artifacts (Dockerfile, uv.lock, workflows).