luffa-bot-python-sdk 0.1.1

Async Python SDK for building bots on the Luffa messaging platform

Luffa Bot Python SDK

Async, OpenAI-style SDK for building bots for the Luffa messaging platform.

Features

• Fully async (based on httpx and asyncio)
• OpenAI-style interface (luffa_bot.robot_key = "...")
• Simple APIs: receive(), send_to_user(), send_to_group(), and run()
• Advanced group messages with buttons, confirms, and @mentions
• Built-in deduplication, concurrency control, and middleware support
• CLI for quick bot setup

---

Installation

pip install luffa-bot-python-sdk

---

Quickstart

import asyncio
import luffa_bot

# Set the robot secret key
luffa_bot.robot_key = "YOUR_ROBOT_SECRET"

async def main():
    # Poll once for messages
    envelopes = await luffa_bot.receive()
    for env in envelopes:
        for msg in env.messages:
            if env.type == 0:
                await luffa_bot.send_to_user(env.uid, f"You said: {msg.text}")
            else:
                await luffa_bot.send_to_group(env.uid, f"[group] {msg.text}")

asyncio.run(main())

---

Running a Bot Loop

Use the built-in run() method to continuously poll and handle messages.

import asyncio
import luffa_bot

luffa_bot.robot_key = "YOUR_ROBOT_SECRET"

async def handler(msg, env, client):
    if "help" in msg.text.lower():
        await client.send_to_user(env.uid, "How can I help?")
    else:
        await client.send_to_user(env.uid, f"Echo: {msg.text}")

asyncio.run(luffa_bot.run(handler, interval=1.0, concurrency=5))

Features of run()

• Automatic deduplication by msgId
• Configurable polling interval
• Concurrency limit (process multiple messages at once)
• Middleware and error hook support

---

Sending Group Messages with Buttons

from luffa_bot.models import GroupMessagePayload, SimpleButton

payload = GroupMessagePayload(
    text="Pick an option:",
    button=[SimpleButton(name="OK", selector="ok")]
)

await luffa_bot.send_to_group("GROUP_ID", payload, message_type=2)

• message_type=1 → Text only
• message_type=2 → Buttons/advanced messages

---

Environment Variables

• LUFFA_ROBOT_SECRET: Default robot key if not set via luffa_bot.robot_key.

---

CLI

A CLI is included for quick bot testing:

export LUFFA_ROBOT_SECRET="..."

# Run an echo bot
luffa-bot run --interval 1.0

# Send DM to a user
luffa-bot send --uid <USER_ID> --text "Hello"

# Send message to a group with buttons
luffa-bot send-group --uid <GROUP_ID> --text "Hi group" --with-buttons

---

Development

• Tests: Run pytest (uses pytest-asyncio + respx)
• Lint: Run ruff check .
• Type-check: Run mypy .

---

Author

Niraj Kulkarni (Sabma Labs, University of Surrey)

---

License

MIT License.