Skip to main content

Add your description here

Project description

 ____         __ _   ____
/ ___| _   _ / _| |_| __ )  _____  __
\___ \| | | | |_| __|  _ \ / _ \ \/ /
 ___) | |_| |  _| |_| |_) | (_) >  <
|____/ \__, |_|  \__|____/ \___/_/\_\
       |___/

Quickstart User Installation

SyftBox 1 liner

curl -LsSf https://syftbox.openmined.org/install.sh | sh -s -- run

Manual install

install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

create a virtualenv somewhere

uv venv .venv

Install Syftbox

uv pip install -U syftbox

run the client

uv run syftbox client

Quickstart Client Developer Installation

Step 0: Open your terminal to the root of this Github repository

Begin by opening your terminal and navigating to the root directory of this github repository (so when you run 'ls' it should show folders like "syftbox", "server", "tests", etc.). Then run the commands in steps 1-4:

Step 1: Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Step 2: Install uv (using homebrew — which is better for this than pip)

brew install uv

Step 3: Install a virtual environment using uv

uv venv

Step 4: Install a relative version of uv.

uv pip install -e .

Step 5: Run the client

uv run syftbox/client/client.py

Alternative Options

Run Client

syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox --email=your@email.org --port=8082  --server=https://syftbox.openmined.org

Staging Server

If you have issues or want to use a bleeding edge server try --server=https://syftboxstage.openmined.org

Deploy

This builds the latest source to a wheel and deploys and restarts the server: https://syftbox.openmined.org

./scripts/deploy.sh

Dev Mode

Run the server and clients locally in editable mode with: Server:

./scripts/server.sh

Client1:

./scripts/madhava.sh

Client2:

./scripts/andrew.sh

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

syftbox-0.2.9.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

syftbox-0.2.9-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file syftbox-0.2.9.tar.gz.

File metadata

  • Download URL: syftbox-0.2.9.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for syftbox-0.2.9.tar.gz
Algorithm Hash digest
SHA256 a41d430bde7be90d324a9bdf34f89a03bfcd89c6bed6fd9cc8a0b21d82c948f6
MD5 67fa69146b6c68be8611e2c887890a14
BLAKE2b-256 6f4c05e8466fe7818ef2970c0c2f1312781ae732a9c3494b36980cf9866dabab

See more details on using hashes here.

File details

Details for the file syftbox-0.2.9-py3-none-any.whl.

File metadata

  • Download URL: syftbox-0.2.9-py3-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for syftbox-0.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 aeca5b84af01c9cbc9a5db744906b795f0c0a206c3e425e99d3dad1f82b576ed
MD5 848ab134a3bba180a45760639c658786
BLAKE2b-256 4ae739291fd326dbf4c4abc985585886b317295a7f3f521c7bcbeaa34f456e1d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page