Pre-release

This release is a pre-release and may not be stable for production use.

SLIM Python Bindings (UniFFI)

Python bindings for SLIM (Secure Low-Latency Interactive Messaging) using UniFFI.

This provides a Python interface to the SLIM data plane, enabling secure, low-latency messaging with support for point-to-point and group (multicast) communication patterns.

Overview

These Python bindings are generated from the agntcy-slim-bindings-ffi crate using UniFFI, providing a native Python interface that wraps the high-performance Rust implementation.

Key Features

  • Point-to-Point Messaging: Direct communication between two endpoints
  • Group Messaging: Multicast communication with multiple participants
  • Secure by Default: Support for TLS, mTLS, and various authentication methods
  • MLS Encryption: End-to-end encryption for sessions
  • Delivery Confirmation: Optional completion handles for reliable messaging
  • Flexible Authentication: Shared secrets, JWT, SPIRE integration
  • slimrpc Support: Protocol Buffers RPC over SLIM - see SLIMRPC.md for details

Architecture

The Python bindings are built using Maturin, which automatically generates Python bindings from the Rust UniFFI adapter:

slim-bindings/
├── rust/          # Rust UniFFI bindings (shared by Go, Python, etc.)
│   ├── src/
│   │   ├── app.rs
│   │   ├── build_info.rs
│   │   ├── client_config.rs
│   │   ├── common_config.rs
│   │   ├── completion_handle.rs
│   │   ├── config.rs
│   │   ├── errors.rs
│   │   ├── identity.rs
│   │   ├── identity_config.rs
│   │   ├── init_config.rs
│   │   ├── lib.rs
│   │   ├── message_context.rs
│   │   ├── name.rs
│   │   ├── server_config.rs
│   │   ├── service.rs
│   │   └── session.rs
│   └── Cargo.toml
├── go/               # Go-specific bindings and examples
└── python/           # Python-specific bindings and examples (this directory)
    ├── examples/              # Example applications
    ├── tests/                 # Unit and integration tests
    └── Taskfile.yaml          # Build and development tasks

Prerequisites

  • Rust toolchain (1.70+)
  • Python (3.10+)
  • uv (Python package manager): https://docs.astral.sh/uv/
  • Task (optional, for convenient build commands)

Installation

Development Build

cd python
task python:bindings:build

This will:

  1. Install all dependencies
  2. Compile the Rust UniFFI adapter
  3. Generate Python bindings using Maturin
  4. Install the package in development mode

Creating Distribution Packages

Build Wheels for Multiple Python Versions

To create distributable wheel packages for Python 3.10, 3.11, 3.12, 3.13 and 3.14:

task python:bindings:packaging

Or directly with Maturin:

uv run maturin build --release -i 3.10 3.11 3.12 3.13

Maturin automatically:

  1. Compiles the Rust UniFFI adapter library
  2. Generates Python bindings from UniFFI scaffolding
  3. Bundles the native library into platform-specific wheels
  4. Creates wheels for each specified Python version

The resulting wheels are self-contained and ready for distribution.

Custom Build Options

You can customize the build with the following variables:

# Build for a specific target architecture
task python:bindings:packaging TARGET=aarch64-apple-darwin

# Build in debug mode (default is release)
task python:bindings:packaging PROFILE=debug

# Cross-compile for Linux on macOS
task python:bindings:packaging TARGET=x86_64-unknown-linux-gnu

Output Structure

After running the packaging task, you'll find:

dist/
├── slim_uniffi_bindings-0.7.0-cp310-*.whl  # Python 3.10 wheel
├── slim_uniffi_bindings-0.7.0-cp311-*.whl  # Python 3.11 wheel
├── slim_uniffi_bindings-0.7.0-cp312-*.whl  # Python 3.12 wheel
└── slim_uniffi_bindings-0.7.0-cp313-*.whl  # Python 3.13 wheel

Note: The native library is automatically bundled inside each wheel.

Installing from Wheel

Users can install the wheel package directly:

pip install slim_uniffi_bindings-0.7.0-cp310-*.whl

The native library is automatically included in the wheel and will be loaded at runtime.

Examples

Examples are a separate project in the examples/ directory.

See examples/README.md for detailed instructions.

Quick Start with Examples

cd examples

# View available examples
task

# Run simple example
task simple

# Run point-to-point examples
task p2p:alice    # Terminal 1
task p2p:bob      # Terminal 2

Quick Start

Simple Example

import slim_uniffi_bindings as slim

# Initialize crypto provider
slim.initialize_crypto_provider()

# Get version
print(f"SLIM Version: {slim.get_version()}")

# Create an app with shared secret authentication
app_name = {
    'components': ['org', 'example', 'app'],
    'id': None
}
app = slim.create_app_with_secret(app_name, "my-secret")

print(f"App ID: {app.id()}")
print(f"App Name: {'/'.join(app.name().components)}")

Run the simple example:

cd examples
task simple

Point-to-Point Communication

Terminal 1 - Receiver (Alice):

cd examples
task p2p:alice

Terminal 2 - Sender (Bob):

cd examples
task p2p:bob

Group Communication

Terminal 1 - Participant (Alice):

cd examples
task group:participant:alice

Terminal 2 - Participant (Bob):

cd examples
task group:participant:bob

Terminal 3 - Moderator:

cd examples
task group:moderator

For more details, see examples/README.md.

API Overview

Application Creation

# Create app with shared secret
app = slim.create_app_with_secret(app_name, shared_secret)

# Get app information
app_id = app.id()
app_name = app.name()

Server Operations

# Connect to server
client_config = {
    'endpoint': 'http://localhost:46357',
    'tls': {'insecure': True, ...}
}
conn_id = app.connect(client_config)

# Run server
server_config = {
    'endpoint': '127.0.0.1:46357',
    'tls': {'insecure': True, ...}
}
app.run_server(server_config)

# Disconnect
app.disconnect(conn_id)

Session Management

# Create session
session_config = {
    'session_type': 'PointToPoint',  # or 'Group'
    'enable_mls': False,
    'max_retries': 3,
    'interval_ms': 100,
    'initiator': True,
    'metadata': {}
}
session = app.create_session(session_config, destination_name)

# Listen for incoming session
session = app.listen_for_session(timeout_ms=30000)

# Delete session
app.delete_session(session)

Messaging

# Send message (fire-and-forget)
session.publish(data, "text/plain", metadata)

# Send with delivery confirmation
completion = session.publish_with_completion(data, "text/plain", metadata)
completion.wait()  # Block until delivered

# Receive message
msg = session.get_message(timeout_ms=5000)
print(f"Payload: {msg.payload}")
print(f"From: {msg.context.source_name}")
print(f"Type: {msg.context.payload_type}")

# Reply to message
session.publish_to(msg.context, reply_data, "text/plain", None)

Group Operations

# Invite participant to group
session.invite(participant_name)

# Remove participant
session.remove(participant_name)

Examples

Examples Directory Structure

examples/
├── common/
│   └── common.py          # Shared utilities
├── simple/
│   └── main.py            # Basic functionality demo
├── point_to_point/
│   └── main.py            # P2P messaging
└── group/
    └── main.py            # Group/multicast messaging

Running Examples

All examples require a running SLIM server. Start the Go server:

cd go
task example:server

Then run Python examples:

# Simple example
task example

# Point-to-point
task example:p2p:alice      # Terminal 1
task example:p2p:bob        # Terminal 2

# Group messaging
task example:group:participant:alice    # Terminal 1
task example:group:participant:bob      # Terminal 2
task example:group:moderator            # Terminal 3

Testing

Unit Tests

task test
# or
python -m pytest tests/unit_test.py -v

Integration Tests

Integration tests require a running SLIM server:

# Terminal 1: Start server
cd ../go && task example:server

# Terminal 2: Run integration tests
SLIM_INTEGRATION_TEST=1 python -m pytest tests/integration_test.py -v -s

Development

Available Tasks

task                           # Show help
task build                     # Build package with Maturin
task test                      # Run tests
task python:bindings:packaging # Build wheels for multiple Python versions
task clean                     # Clean build artifacts

Project Structure

  • slim_uniffi_bindings/ - Python package (bindings generated by Maturin)
  • examples/ - Example applications
  • tests/ - Unit and integration tests
  • Taskfile.yaml - Build automation
  • pyproject.toml - Package configuration (Maturin build system)

Comparison with Go Bindings

Both Python and Go bindings use the same UniFFI adapter, ensuring API consistency:

Feature Python Go
Binding Generation uniffi-bindgen uniffi-bindgen-go
API Style Pythonic (snake_case) Idiomatic Go (PascalCase)
Error Handling Exceptions Error returns
Async Support Sync wrapper over async Rust Sync wrapper over async Rust
Examples ✅ ✅
Tests ✅ ✅

API Reference

Core Types

  • Name: Application/service identifier with components and optional ID
  • SessionConfig: Configuration for creating sessions
  • TlsConfig: TLS settings for secure connections
  • ServerConfig: Server endpoint and TLS configuration
  • ClientConfig: Client endpoint and TLS configuration
  • MessageContext: Message metadata (source, destination, type, metadata)
  • ReceivedMessage: Received message with context and payload

Main Classes

  • BindingsAdapter: Main app interface for session management
  • BindingsSessionContext: Session interface for messaging
  • FfiCompletionHandle: Completion handle for delivery confirmation

Session Types

  • PointToPoint: Direct one-to-one communication
  • Group: One-to-many multicast communication

Troubleshooting

ImportError: Cannot find slim_uniffi_bindings

Make sure you've built the package:

task build
# or
uv run maturin develop

Connection Refused

Ensure the SLIM server is running:

cd ../go && task example:server

Build Errors

If you encounter build errors, try cleaning and rebuilding:

task clean
uv run maturin develop

Contributing

When contributing to the Python bindings:

  1. Maintain API consistency with Go bindings
  2. Follow Python naming conventions (snake_case)
  3. Add tests for new functionality
  4. Update examples if adding features
  5. Keep documentation up to date

License

Apache-2.0 - See LICENSE.md for details

See Also

Project links

Data verified by PyPI on Jul 21, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.1.0)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for agntcy from gravatar.com agntcy Avatar for janossk from gravatar.com janossk

Credits

Author: AGNTCY Contributors

GitHub Statistics

Data verified by PyPI on Jul 21, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.10

Provides Extra

examples

Classifiers

Report project as malware

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

slim_bindings-2.0.0a4-py3-none-win_arm64.whl (14.8 MB view details)

Uploaded Python 3Windows ARM64

slim_bindings-2.0.0a4-py3-none-win_amd64.whl (15.8 MB view details)

Uploaded Python 3Windows x86-64

slim_bindings-2.0.0a4-py3-none-musllinux_1_2_x86_64.whl (18.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

slim_bindings-2.0.0a4-py3-none-musllinux_1_2_aarch64.whl (17.6 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

slim_bindings-2.0.0a4-py3-none-manylinux_2_28_x86_64.whl (18.3 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

slim_bindings-2.0.0a4-py3-none-manylinux_2_28_aarch64.whl (17.5 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

slim_bindings-2.0.0a4-py3-none-macosx_11_0_arm64.whl (16.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

slim_bindings-2.0.0a4-py3-none-macosx_10_12_x86_64.whl (17.4 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file slim_bindings-2.0.0a4-py3-none-win_arm64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 a6825159997702a72b4b59a91a9442f18c5f5514fced308e5b43346eaa85c7c3
MD5 faaa4c890650fe975a6ed6debde1b9d6
BLAKE2b-256 71c04a96a074442e1c1df331f35d538c063e09dd28cd6d88835aa5b869edd14a

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-win_arm64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 62e15eed758a48239fb0aeb3d9adbc2aa6b28cef75e41c06e82c2ddf6e388200
MD5 3a7df3be36f279876bb3800cc15c8f11
BLAKE2b-256 8d7edf2436ce74d74fefac73e2b52bad6bcd461bf314f873d7c852618dc04f3e

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-win_amd64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 1fea3efb65488009a69f14e2a656ecf4fb948a3301a0d55fe868a43d75878f8c
MD5 febdc24c9f458ae435b9dfb873c84ef0
BLAKE2b-256 13566a1811369798b726ca651cd5620157cbda496e47f8f83c52c1ece0adcf7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-musllinux_1_2_x86_64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 5a6fb9ca06bec72240df296a5ca505d95dcb43b57c8b975ea12ff89156745538
MD5 53f9de74820e0afdbf86b9adbecffd35
BLAKE2b-256 7113f20edea14620ca713dae3b2895600758352f7a934cb5afe47fe20ed6be2a

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-musllinux_1_2_aarch64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 294db33b808087929e74eee9dc0b6c8467c82afd828d8d06cdf25369136b0dc2
MD5 c1ec7f52cfdf0cdfe3aa6af58eb163f0
BLAKE2b-256 438d3c401f84eb3f78e4a4f4891c946a9920b51154edc69e8fbc26eb29800fdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-manylinux_2_28_x86_64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 fa92ea38cfa31440553a712de402cd2f4e8aa352ff71d0b8542b25058d47a047
MD5 36dadd12fd52da8bc0f6829b4a651ab3
BLAKE2b-256 ebc1cb70a0384be14decbe2675a01a52d3e2fed80d714e6ceb22390d201c4be1

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-manylinux_2_28_aarch64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 86a56f36c00bd93e6b5576070dde1ed00e761db343f4f1a650aa8630f322929d
MD5 ce65e4858eab24183e457a8a86d6066e
BLAKE2b-256 861b747b63219710cb27716cee47650c152e943567b1f6118edf91da432a407d

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-macosx_11_0_arm64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slim_bindings-2.0.0a4-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.0.0a4-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 04b2d9186f89b7f60e4584c385d9e477a2ffa2aae9f97e5cc11030612f9ac8d8
MD5 a7f5aa3a3c062d2c5b87492aaf1bbbcc
BLAKE2b-256 5d1daf6e01a971e99bf0bc3b811d45bcee818b14ac6cbed00d0a0931a1165339

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.0.0a4-py3-none-macosx_10_12_x86_64.whl:

Publisher: release-bindings.yaml on agntcy/slim-bindings

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Pre-release

2.1.1rc2

8 files

2.1.0

8 files

2.0.0

8 files

Pre-release

2.0.0a7

8 files

Pre-release

2.0.0a5

8 files

This release
Pre-release

2.0.0a4 This release

8 files

Pre-release

2.0.0a3

8 files

Pre-release

2.0.0a2

8 files

Pre-release

2.0.0a1

8 files

Pre-release

2.0.0a0

8 files

1.4.1

8 files

1.4.0

8 files

Pre-release

1.4.0rc3

8 files

Pre-release

1.4.0rc2

8 files

Pre-release

1.4.0rc0

8 files

1.3.0

8 files

Pre-release

1.3.0rc3

8 files

Pre-release

1.3.0rc1

8 files

Pre-release

1.3.0rc0

8 files

1.2.0

8 files

1.1.1

8 files

1.1.0

8 files

1.0.1

8 files

1.0.0

8 files

Pre-release

1.0.0rc0

8 files

0.7.1

21 files

0.7.0

21 files

0.6.3

26 files

0.6.2

26 files

0.6.1

26 files

0.6.0

26 files

0.5.0

26 files

0.4.1

21 files

0.4.0

26 files

0.3.6

26 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page