Syft-client
Syft client lets data scientists submit computations which are ran by data owners on private data — all through cloud storage their organizations already use (Google Drive, Microsoft 365, etc.). No new infrastructure required.
Docs
- Workflow — End-to-end privacy-preserving data analysis workflow
- API Reference — All public client methods and properties
- Authentication & Setup — Google Cloud OAuth setup for local/Jupyter usage
- Background Services — Email notifications, auto-approval, and TUI dashboard
- Connections — How the Google Drive transport layer works
- Permissions - Permissions for syft-client
Features
- Privacy-preserving — Private data never leaves the data owner's machine; only approved results are shared
- Transport-agnostic — Works over Google Drive today, extensible to any file-based transport
- Offline-first — Full functionality even when peers are offline; changes sync when connectivity resumes
- Peer-to-peer with explicit auth — Data owners must approve each collaborator before any data flows
- Isolated job execution — Jobs run in sandboxed Python virtual environments with controlled access to private data
- Dataset sharing with mock/private separation — Data scientists explore mock data, then submit jobs that run on the real thing
Quick Start
uv pip install syft-client
import syft_client as sc
# Login (colab auth, for non-colab pass token_path)
do = sc.login_do(email="do@org.com")
ds = sc.login_ds(email="ds@org.com")
# Peer request & approve
ds.add_peer("do@org.com")
do.approve_peer_request("ds@org.com")
# Create & sync dataset
do.create_dataset(
name="census",
mock_path="mock.txt",
private_path="private.txt",
users=["ds@org.com"],
)
do.sync(); ds.sync()
datasets = ds.datasets.get_all()
Write an analysis.py that reads the dataset and produces a result in our case this is just the length of the data. Inside a job, resolve_dataset_file_path automatically resolves to the private data:
# analysis.py
import json
import syft_client as sc
data_path = sc.resolve_dataset_file_path("census")
with open(data_path, "r") as f:
data = f.read()
with open("outputs/result.json", "w") as f:
json.dump({"length": len(data)}, f)
Submit the job and retrieve results:
# Submit job
ds.submit_python_job(
user="do@org.com",
code_path="analysis.py",
)
ds.sync(); do.sync()
# Data owner Approves & runs job
do.jobs[0].approve()
do.process_approved_jobs(share_outputs_with_submitter=True)
do.sync(); ds.sync()
result = open(ds.jobs[-1].output_paths[0]).read()
Packages
| Package | Description |
|---|---|
syft-datasets |
Dataset management and sharing |
syft-job |
Job submission and execution |
syft-permissions |
Permission system for Syft datasites |
syft-perms |
User-facing permission API for Syft datasites |
syft-bg |
Background services TUI dashboard for SyftBox |
syft-notebook-ui |
Jupyter notebook display utilities |
Development
# Install in development mode
uv pip install -e .
# Run tests
just test-unit # Unit tests (fast, mocked)
just test-integration # Integration tests (slow, real API)
Built by OpenMined — building open-source technology for privacy-preserving data science and AI.
Metadata
Release files for syft-client 0.1.117
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| syft_client-0.1.117.tar.gz | 106.1 kB | Without provenance | Details for syft_client-0.1.117.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| syft_client-0.1.117-py3-none-any.whl | Python 3 | none | any | Details for syft_client-0.1.117-py3-none-any.whl |
Total release size: 229.7 kB
Release files / syft_client-0.1.117.tar.gz
| Download URL | syft_client-0.1.117.tar.gz |
|---|---|
| Size | 106.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
efbe9efbea3e3436c8fbe56487f1264b062a969e88390211863048cd6973858b
|
|
BLAKE2b-256 checksum How to use checksums |
c5925ca376a38cc3d62b679292110efb075ea5ac368ee7534840640fe2e531ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / syft_client-0.1.117-py3-none-any.whl
| Download URL | syft_client-0.1.117-py3-none-any.whl |
|---|---|
| Size | 123.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6dd9f0a4347dba2942f68cfc8938529df33b8ac7723bbe09f7c74463b79e5f6c
|
|
BLAKE2b-256 checksum How to use checksums |
8a599c6c0333c9b922d258bc95319932c27a15ebf0b9b37f00149cd3fe7c6e4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Security for syft-client 0.1.117
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.