syft-perm 0.4.0

Minimal utilities for managing SyftBox file permissions

SyftPerm

File permission management for SyftBox made simple.

SyftPerm provides intuitive Python APIs for managing SyftBox file permissions with powerful pattern matching, inheritance, and debugging capabilities.

📚 Complete Documentation

Installation

pip install syft-perm

Quick Start - Learn the Entire API in 2 Minutes

import syft_perm as sp

# 1. Opening files and folders
file = sp.open("data.csv")                    # Open a file
folder = sp.open("my_project/")                # Open a folder
remote = sp.open("syft://[e-mail]/data.csv")  # Remote files

# 2. Granting permissions (each level includes all lower permissions)
file.grant_read_access("[e-mail]")      # Can view
file.grant_create_access("[e-mail]")  # Can view + create new files
file.grant_write_access("[e-mail]")    # Can view + create + modify
file.grant_admin_access("[e-mail]")   # Full control

# 3. Revoking permissions
file.revoke_read_access("[e-mail]")     # Remove all access
file.revoke_create_access("[e-mail]") # Remove create (keeps read)
file.revoke_write_access("[e-mail]")   # Remove write (keeps read/create)
file.revoke_admin_access("[e-mail]")  # Remove admin privileges

# 4. Checking permissions
if file.has_read_access("[e-mail]"):
    print("Bob can read this file")

if file.has_create_access("[e-mail]"):
    print("Alice can create new files")

if file.has_write_access("[e-mail]"):
    print("Team can modify this file")
    
if file.has_admin_access("[e-mail]"):
    print("Admin has full control")

# 5. Understanding permissions with explain
explanation = file.explain_permissions("[e-mail]")
print(explanation)  # Shows why bob has/doesn't have access

# 6. Working with the Files API
all_files = sp.files.all()                     # Get all permissioned files
paginated = sp.files.get(limit=10, offset=0)   # Get first 10 files
filtered = sp.files.search(admin="[e-mail]")  # My admin files
sliced = sp.files[0:5]                          # First 5 files using slice

# 7. Moving files while preserving permissions
new_file = file.move_file_and_its_permissions("archive/data.csv")

# 8. Interactive features (Jupyter/web)
file.share                                      # Show sharing widget

Permission Hierarchy Explained

• Read: View file contents
• Create: Read + create new files in folders
• Write: Read + Create + modify existing files
• Admin: Read + Create + Write + manage permissions

Permission Hierarchy

• Read - View file contents
• Create - Read + create new files
• Write - Read + Create + modify existing files
• Admin - Read + Create + Write + manage permissions

Learn More

• 5-Minute Quick Start - Get productive immediately
• Comprehensive Tutorials - Master advanced features
• API Reference - Complete Python API docs

Requirements

• Python 3.9+
• Works on Windows, macOS, and Linux

Contributing

1. Check out our GitHub Issues
2. Read the Contributing Guide
3. Join the OpenMined Community

License

Apache 2.0 License - see LICENSE file for details.