FastAPI + SyftBox
Project description
fastsyftbox
Build offline-first Python apps with FastAPI and SyftBox — FAST.
🚀 Features
- Build local admin UIs with FastAPI.
- Build delay-tolerant UIs/APIs using SyftEvents.
- Keep private data offline with SyftBox HTTP over RPC.
- Builtin JS SDK with
fetchcompatible syntax - Debug APIs with a built-in Postman-style interface.
🔧 Purpose
How can you build a web app that runs on your own device, without uploading data to the cloud?
With SyftBox, you can:
- Run a webserver anywhere that can go offline and keep functioning when it comes back online.
- Access your data even when offline or when your laptop lid is closed.
⚡ Quick Start
Install with uv and create your app:
uvx fastsyftbox version
uvx fastsyftbox create app test
To start in hot-reloading more:
cd test
./run.sh
This generates a sample FastAPI app in app.py:
app = FastSyftBox(
app_name=app_name,
syftbox_endpoint_tags=[
"syftbox"
], # endpoints with this tag are also available via Syft RPC
include_syft_openapi=True, # Create OpenAPI endpoints for syft-rpc routes
)
# normal fastapi
@app.get("/", response_class=HTMLResponse)
def root():
return HTMLResponse("<html><body><h1>Welcome to {app_name}</h1>")
# build a model with pydantic
class MessageModel(BaseModel):
message: str
name: str | None = None
# make syftbox rpc endpoints easily
# syft://{datasite}/app_data/{app_name}/rpc/hello
@app.post("/hello", tags=["syftbox"])
def hello_handler(request: MessageModel):
print("got request", request)
response = MessageModel(message=f"Hi {request.name}", name="Bob")
return response.model_dump_json()
# Debug your RPC endpoints in the browser
app.enable_debug_tool(
endpoint="/hello",
example_request=str(MessageModel(message="Hello!", name="Alice").model_dump_json()),
publish=True,
)
HTTP / JS
Vanilla JS fetch:
const url = "http://somewebsite.com/api"
const request = await fetch(url, {
method: 'POST',
headers,
body
});
Becomes syftFetch:
const syftUrl = "syft://madhava@openmined.org/app_data/fastsyftbox/rpc/hello"
const request = await syftFetch(syftUrl, {
method: 'POST',
headers,
body
});
Under the hood:
- Translates to the correct HTTP request
- Adds
syft-xheaders - Waits for queued response
- Polls future until completed
What is SyftBox?
🧱 Your Dependencies
Add any Python dependencies to requirements.txt and run.sh will install them fresh every run.
🧪 RPC Debug Tool
Its like Postman but for SyftBox RPC.
A built-in HTML/JS tool helps you debug your HTTP over RPC endpoints. To enable:
app.enable_debug_tool(
endpoint="/hello",
example_request=str(MessageModel(message="Hello!", name="Alice").model_dump_json()),
publish=True,
)
🧭 Construct syft:// RPC URLs
🎯 Configure custom headers
🔍 View real-time responses
Then visit either: http://localhost:${SYFTBOX_ASSIGNED_PORT}/rpc-debug or if you have publish=True https://syftboxdev.openmined.org/datasites/{{ email }}/public/{{ app_name }}/rpc-debug.html
📥 SyftBox App Install via GitHub
syftbox app install GITHUB_URL
This executes run.sh and binds your app to a random port: http://localhost:${SYFTBOX_ASSIGNED_PORT}
📚 Example fastsyftbox Apps
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fastsyftbox-0.1.8.tar.gz.
File metadata
- Download URL: fastsyftbox-0.1.8.tar.gz
- Upload date:
- Size: 25.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f3d1370bd9cfec5875290082bd2b061afcad8a82a903ea970f7d03482f4fa7b9
|
|
| MD5 |
8b556f1577dd299ef1b6a965d2b5005d
|
|
| BLAKE2b-256 |
1a4a12d0f7e7a90ce88356c1663c7a643d13e33ed4374fa0a916f61bed2bd44b
|
File details
Details for the file fastsyftbox-0.1.8-py3-none-any.whl.
File metadata
- Download URL: fastsyftbox-0.1.8-py3-none-any.whl
- Upload date:
- Size: 28.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
177968334bfd00ecd8f4c3bdb751c594accf401b444b4852dc776fab908fcbad
|
|
| MD5 |
cf951f021ce08bf899fe0dedcbbf2863
|
|
| BLAKE2b-256 |
334b0c4acd9bdc3abc2aa7bf551e9b35995ba831c182dd5813e046134c93f66d
|
