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 Aug 13, 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:
Latest release

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 Aug 13, 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.1.0-py3-none-win_arm64.whl (19.5 MB view details)

Uploaded Python 3Windows ARM64

slim_bindings-2.1.0-py3-none-win_amd64.whl (20.8 MB view details)

Uploaded Python 3Windows x86-64

slim_bindings-2.1.0-py3-none-musllinux_1_2_x86_64.whl (23.5 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

slim_bindings-2.1.0-py3-none-musllinux_1_2_aarch64.whl (22.6 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

slim_bindings-2.1.0-py3-none-manylinux_2_28_x86_64.whl (23.5 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

slim_bindings-2.1.0-py3-none-manylinux_2_28_aarch64.whl (22.7 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

slim_bindings-2.1.0-py3-none-macosx_11_0_arm64.whl (21.7 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

slim_bindings-2.1.0-py3-none-macosx_10_12_x86_64.whl (22.4 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file slim_bindings-2.1.0-py3-none-win_arm64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 482cc455e0c7ec020266c73e291ab6a43dc8aec54e73687527f0865bd90264a5
MD5 473a874cbe78572229d42489b7e9a294
BLAKE2b-256 17d1f59680d020b13ee5a68b4e126e3b3539dd2a39796cf6db7477e37913f8d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 0c5711ac2275a6bf6b7d4ab06311ad09872f879d1d804c33b79fbacc5041b357
MD5 d997737dfa86685e48111ab04ddce17e
BLAKE2b-256 f4b66f2ad9af6234c5f8474d091817460bdc71e09a2c4ecfd2b7ac0736f483ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 bbe5260be7a5813436cbe733ab028af0d6fdb465f52d777e9589aa1b23d6d4eb
MD5 6530833692af22eb1cc5878ab6c5f727
BLAKE2b-256 f7a1c96c3ffb067c96e9374fd432c5a948ef2131724affbfba1ea9be9ede3b7a

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 6da7e3ea5f0c8fdb2053044b8366ad0e1e38e4d076f58608fc2b8b5efb8b9340
MD5 5d6a69264cf4d0a3525f5178cc271cee
BLAKE2b-256 3d30a3e9b6be87160e78fb5102611353d9ed8c8081a4f8fa9e70268bb05a926c

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 61d624a1f2c757c53083e058e4acbabdf4e68fc42816ef747ebcf8814f3e1ef9
MD5 ad6119c011f6621f5c6cb58965cacc58
BLAKE2b-256 49148308339ef6e697102fff497b8335751bae9195507a4186557ae441696145

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 fee2cd4441661da449032e627de68add7ce9e051bef3af89e79cb75155177b26
MD5 52dda32627b5ad3c094ba78608ea970a
BLAKE2b-256 fef82fd44d927c9a43bbb3711f95900e46795f85b545b8084e6b2a83653b2aa5

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 21e475e6456866de0ffe1cea2c337193696075e139184f096448cae4dd72721c
MD5 581c9ad0aad2aa1b570206ee9c093629
BLAKE2b-256 a7d8e2d537bea1593a2d76024974e154455f0bc472c03851003042204bfe9c90

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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.1.0-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for slim_bindings-2.1.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 babed1548a5faf318ce95e7f53ffb1a0b01580f541d8e9c0444009c080c60dbd
MD5 3b2fb38c36328a53b05b562c20714395
BLAKE2b-256 f40584136c26b7b8ead5c8b93a0f51b08bb81d9f426e138d6e8bae9bcef6bff9

See more details on using hashes here.

Provenance

The following attestation bundles were made for slim_bindings-2.1.0-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

This release

2.1.0 This release

8 files

2.0.0

8 files

Pre-release

2.0.0a7

8 files

Pre-release

2.0.0a5

8 files

Pre-release

2.0.0a4

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