one line to rule them all

MANIFEST.in

@@ -1,2 +1,2 @@
-recursive-include syftbox *.html *.js *.css *.zip
+recursive-include syftbox *.html *.js *.css *.zip *.sh
 recursive-include default_apps *.py *.sh *.html *.js *.css *.zip *.png *.txt *.csv

README.md

@@ -66,13 +66,13 @@ uv run syftbox/client/client.py
 ### Run Client
 
 ```
-syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox --email=your@email.org --port=8082  --server=http://20.168.10.234:8080
+syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox --email=your@email.org --port=8082  --server=http://syftbox.openmined.org:8080
 ```
 
 ### Deploy
 
 This builds the latest source to a wheel and deploys and restarts the server:
-http://20.168.10.234:8080
+http://syftbox.openmined.org:8080
 
 ```
 ./scripts/deploy.sh

scripts/live_andrew.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-uv run syftbox/client/client.py --config_path=./users/live_andrew.json --sync_folder=./users/live_andrew --email=andrew@openmined.org --port=8082  --server=http://20.168.10.234:8080
+uv run syftbox/client/client.py --config_path=./users/live_andrew.json --sync_folder=./users/live_andrew --email=andrew@openmined.org --port=8082  --server=http://syftbox.openmined.org:8080

scripts/live_madhava.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-uv run syftbox/client/client.py --config_path=./users/live_madhava.json --sync_folder=./users/live_madhava --email=madhava@openmined.org --port=8081 --server=http://20.168.10.234:8080
+uv run syftbox/client/client.py --config_path=./users/live_madhava.json --sync_folder=./users/live_madhava --email=madhava@openmined.org --port=8081 --server=http://syftbox.openmined.org:8080

syftbox/client/client.py

@@ -344,9 +344,10 @@ async def lifespan(app: CustomFastAPI, client_config: ClientConfig | None = None
     app.scheduler = scheduler
     app.running_plugins = {}
     app.loaded_plugins = load_plugins(client_config)
-    print("> Loaded plugins:", list(app.loaded_plugins.keys()))
+    print("> Loaded plugins:", sorted(list(app.loaded_plugins.keys())))
     app.watchdog = start_watchdog(app)
 
+    print("> Starting autorun plugins:", sorted(client_config.autorun_plugins))
     for plugin in client_config.autorun_plugins:
         start_plugin(app, plugin)
 

syftbox/server/server.py

@@ -179,18 +179,11 @@ async def lifespan(app: FastAPI, settings: ServerSettings | None = None):
        |___/        {__version__:>17}
 
 
-# MacOS and Linux
-Install uv
-curl -LsSf https://astral.sh/uv/install.sh | sh
+# Install Syftbox (MacOS and Linux)
+curl -LsSf https://syftboxstage.openmined.org/install.sh | sh
 
-# create a virtualenv `.venv` in current working dir
-uv venv
-
-# Install SyftBox
-uv pip install -U syftbox
-
-# run the client
-uv run syftbox client
+# Run the client
+syftbox client
 """
 
 
@@ -447,8 +440,14 @@ async def datasites(server_settings: ServerSettings = Depends(get_server_setting
     raise HTTPException(status_code=400, detail={"status": "error"})
 
 
+@app.get("/install.sh")
+async def install():
+    install_script = current_dir / "templates" / "install.sh"
+    return FileResponse(install_script, media_type="text/plain")
+
+
 @app.get("/info")
-def info():
+async def info():
     return {
         "version": __version__,
     }

syftbox/server/templates/install.sh

@@ -0,0 +1,203 @@
+#!/bin/sh
+
+set -e
+
+# --no-prompt => disables the run client prompt
+ASK_RUN_CLIENT=1
+
+# --run => disables the prompt & runs the client
+RUN_CLIENT=0
+
+red='\033[1;31m'
+yellow='\033[0;33m'
+cyan='\033[0;36m'
+green='\033[1;32m'
+reset='\033[0m'
+
+err() {
+    echo "${red}ERROR${reset}: $1" >&2
+    exit 1
+}
+
+info() {
+    echo "${cyan}$1${reset}"
+}
+
+warn() {
+    echo "${yellow}$1${reset}"
+}
+
+success() {
+    echo "${green}$1${reset}"
+}
+
+check_cmd() {
+    command -v "$1" > /dev/null 2>&1
+    return $?
+}
+
+need_cmd() {
+    if ! check_cmd "$1"
+    then err "need '$1' (command not found)"
+    fi
+}
+
+downloader() {
+    if check_cmd curl
+    then curl -sSfL "$1"
+    elif check_cmd wget
+    then wget -qO- "$1"
+    else need_cmd "curl or wget"
+    fi
+}
+
+need_python() {
+    # check if either python3 or python is available
+    if ! check_cmd python && ! check_cmd python3
+    then err "need 'python' or 'python3' (command not found)"
+    fi
+}
+
+check_home_path() {
+    # check if a path exists as ~/path or $HOME/path
+    if echo $PATH | grep -q "$HOME/$1" || echo $PATH | grep -q "~/$1"
+    then return 0
+    else return 1
+    fi
+}
+
+write_path() {
+    local _path_contents="$1"
+    local _profile_path="$2"
+    # if profile exists, add the export
+    if [ -f "$_profile_path" ]
+    then
+        echo "export PATH=\"$_path_contents\$PATH\"" >> $_profile_path;
+    fi
+}
+
+patch_path() {
+    local _path_expr=""
+
+    if ! check_home_path ".cargo/bin"
+    then _path_expr="$HOME/.cargo/bin:"
+    fi
+
+    if ! check_home_path ".local/bin"
+    then _path_expr="${_path_expr}$HOME/.local/bin:"
+    fi
+
+    # reload env vars
+    export PATH="$_path_expr$PATH"
+
+    # write to profile files
+    write_path $_path_expr "$HOME/.profile"
+    write_path $_path_expr "$HOME/.zshrc"
+    write_path $_path_expr "$HOME/.bashrc"
+    write_path $_path_expr "$HOME/.bash_profile"
+}
+
+download_uv() {
+    if ! check_cmd "uv"
+    then downloader https://astral.sh/uv/install.sh | env INSTALLER_PRINT_QUIET=1 sh
+    fi
+}
+
+install_uv() {
+    download_uv
+    patch_path
+}
+
+install_syftbox() {
+    need_cmd "uv"
+    exit=$(uv tool install -Uq syftbox)
+    if ! $(exit)
+    then err "failed to install syftbox"
+    fi
+}
+
+pre_install() {
+    # ----- pre-install checks ----
+    # uv doesn't really need python,
+    # ... but incase we want we can toggle this on
+    # need_python
+
+    # if you see this message, you're good to go
+    echo "
+ ____         __ _   ____
+/ ___| _   _ / _| |_| __ )  _____  __
+\___ \| | | | |_| __|  _ \ / _ \ \/ /
+ ___) | |_| |  _| |_| |_) | (_) >  <
+|____/ \__, |_|  \__|____/ \___/_/\_\\
+       |___/
+"
+}
+
+run_client() {
+    echo
+    success "Starting SyftBox client..."
+    exec ~/.local/bin/syftbox client
+}
+
+prompt_run_client() {
+    # prompt if they want to start the client
+    echo
+    prompt=$(echo "${yellow}Start the client now? [y/n]  ${reset}")
+    while [ "$start_client" != "y" ] && [ "$start_client" != "Y" ] && [ "$start_client" != "n" ] && [ "$start_client" != "N" ]
+    do
+        read -p "$prompt" start_client < /dev/tty
+    done
+
+    if [ "$start_client" = "y" ] || [ "$start_client" = "Y" ]
+    then run_client
+    else prompt_restart_shell
+    fi
+}
+
+prompt_restart_shell() {
+    echo
+    warn "RESTART your shell or RELOAD shell profile"
+    echo "  \`source ~/.zshrc\`        (for zsh)"
+    echo "  \`source ~/.bash_profile\` (for bash)"
+    echo "  \`source ~/.profile\`      (for sh)"
+
+    success "\nAfter reloading, start the client"
+    echo "  \`syftbox client\`"
+}
+
+post_install() {
+    if [ $RUN_CLIENT -eq 1 ]
+    then run_client
+    elif [ $ASK_RUN_CLIENT -eq 1 ]
+    then prompt_run_client
+    else prompt_restart_shell
+    fi
+}
+
+do_install() {
+    for arg in "$@"; do
+        case "$arg" in
+            -r|--run|run)
+                RUN_CLIENT=1
+                ;;
+            -n|--no-prompt|no-prompt)
+                ASK_RUN_CLIENT=0
+                ;;
+            *)
+                ;;
+        esac
+    done
+
+    pre_install
+
+    info "Installing uv"
+    install_uv
+
+    info "Installing SyftBox"
+    install_syftbox
+
+    success "Installation completed!"
+    post_install
+}
+
+do_install "$@" || exit 1