Syft Awake 🚀
See who's online and ready to collaborate in your SyftBox network
What is it?
Syft Awake helps coordinate live collaboration on SyftBox - the open-source platform for privacy-first AI development. Check who's online before starting federated learning experiments, research sessions, or collaborative development.
Quick Start
pip install syft-awake
import syft_awake as sa
# Ping someone to see if they're online
response = sa.ping_user("colleague@university.edu")
if response:
print(f"{response.responder} is {response.status}")
# Find everyone who's currently online
responses = sa.ping_network()
online_now = [r.responder for r in responses]
print(f"Online: {', '.join(online_now)}")
Use Cases
🧪 Research Coordination
# Check if collaborators are available before starting experiments
research_team = ["alice@university.edu", "bob@lab.org"]
responses = sa.ping_network(research_team)
if len(responses) >= 2:
print("Enough researchers online - let's start the federated learning!")
🤝 Live Development Sessions
# See who's available for pair programming or code review
responses = sa.ping_network()
for r in responses:
if "development" in r.capabilities:
print(f"{r.responder} is available for development work")
📊 Distributed Computing
# Find compute nodes with light workload for your job
responses = sa.ping_network()
available_nodes = [r for r in responses if r.workload == "light"]
print(f"Found {len(available_nodes)} available compute nodes")
API
Just two simple functions:
ping_user(email, timeout=30) → AwakeResponse or None
ping_network(emails=None, timeout=15) → List[AwakeResponse]
Auto-installs and auto-discovers network members. Works silently in the background.
How It Works
- Automatic: Simply importing the library installs the SyftBox app
- Private: Uses SyftBox's secure, file-based communication
- Decentralized: No central servers - direct peer-to-peer pings
- Smart Discovery: Finds other users by scanning your local SyftBox network
Perfect for coordinating real-time collaboration in privacy-preserving AI research and development.
License
Apache 2.0
Metadata
Release files for syft-awake 0.2.1
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_awake-0.2.1.tar.gz | 46.7 kB | Without provenance | Details for syft_awake-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| syft_awake-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for syft_awake-0.2.1-py3-none-any.whl |
Total release size: 60.9 kB
Release files / syft_awake-0.2.1.tar.gz
| Download URL | syft_awake-0.2.1.tar.gz |
|---|---|
| Size | 46.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37acddbe7a2f052e4483c971e8f7ad223ec987f837c1c68d7b91455d1495e9ef
|
|
BLAKE2b-256 checksum How to use checksums |
f014956438515ca483d73f41428f19b0f2511ae8a35d7dbadaf61b7e6e13ff18
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.4.20
|
Release files / syft_awake-0.2.1-py3-none-any.whl
| Download URL | syft_awake-0.2.1-py3-none-any.whl |
|---|---|
| Size | 14.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
78f7ee19ec6eee5dd7f082127feccaf533b046704a691904a4e8c05bad771d5d
|
|
BLAKE2b-256 checksum How to use checksums |
f0835e6ea34c0fe87d88b5eacd87969944b8dabc3b71b3bbe408f6343a3bca8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.4.20
|
Security for syft-awake 0.2.1
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.