syft-perm 0.3.89

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

import syft_perm as sp

# Open a file or folder
file = sp.open("my_data.txt")

# Grant permissions (higher levels include lower ones)
file.grant_read_access("[e-mail]")
file.grant_write_access("[e-mail]")  # Gets read + write
file.grant_admin_access("[e-mail]")       # Gets everything

# Use patterns for multiple files
project = sp.open("my_project/")
project.grant_write_access("*.py", "[e-mail]")
project.grant_read_access("docs/**/*.md", "*")  # Public docs

# Debug permissions
print(file.explain_permissions("[e-mail]"))

# Check access
if file.has_write_access("[e-mail]"):
    print("Colleague can modify this file")

# Display beautiful permission tables in Jupyter notebooks
file._repr_html_()  # Shows permissions table with compliance info

Permission Hierarchy

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

Key Features

• 🎯 Intuitive Permission Hierarchy - Higher permissions include all lower ones
• 🌟 Powerful Pattern Matching - Use *.py, docs/**/*.md to control multiple files
• 🔍 Nearest-Node Algorithm - Predictable inheritance from closest permission rules
• 🐛 Built-in Debugging - Trace exactly why permissions work or don't work
• 📁 Folder-Level Efficiency - Set permissions once on directories, files inherit automatically
• 🎮 Interactive Web Editor - Google Drive-style permission management interface

Beautiful Table Display

SyftPerm provides rich table displays for Jupyter notebooks:

# Display permissions table with compliance information
file._repr_html_()  # Shows user permissions, file limits, and compliance status

# The table includes:
# • User permissions (Read/Create/Write/Admin)
# • File size vs limits
# • File type compliance (directories, symlinks)
# • Overall compliance status
# • Direct link to web editor

Web Editor

For non-technical users, SyftPerm includes a web interface:

# Get editor URL for any file or folder
url = sp.get_editor_url("my_project/")
print(f"Edit permissions at: {url}")

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

MIT License - see LICENSE file for details.