pywayne-lark-bot-listener

Pywayne Lark Bot Listener - Real-Time Event Processing

Overview

LarkBotListener is a WebSocket-based event listener for Feishu (Lark) that enables real-time message and event processing. It provides decorator-based handlers for all message types and bot events, with automatic resource handling, message deduplication, and async/sync compatibility.

Key Features:

• Message Handlers: text, image, file, audio, media, sticker, post, interactive
• Event Handlers: recall, read, reaction, bot added/removed, member changes, chat updates
• Auto Resource Handling: Download images/files to temp dir, auto-cleanup after processing
• Auto Upload/Send: Return new file path from handler → automatically upload and send back
• Flexible Parameters: Handlers declare only parameters they need (text, chat_id, user_name, etc.)
• Message Deduplication: Per-handler deduplication with configurable expiry
• Async/Sync Compatible: Support both async def and def handler functions
• Built-in LarkBot: Access full LarkBot API via listener.bot
• Streaming Reply Helpers: Keep one card updated in place during long-running work
• Card Action Callbacks: HTTP handler for interactive card button clicks

Companion:

• Uses LarkBot internally for sending messages (see pywayne-lark-bot skill)

Installation

pip install pywayne lark-oapi

Quick Start

from pywayne.lark_bot_listener import LarkBotListener

# Initialize listener
listener = LarkBotListener(
    app_id="cli_xxxxxxxxxxxx",
    app_secret="your_app_secret",
    message_expiry_time=60  # Deduplication expiry in seconds
)

# Handle text messages
@listener.text_handler()
async def on_text(text: str, chat_id: str):
    print(f"Received: {text}")
    listener.send_message(chat_id, f"Echo: {text}")

# Start listening
listener.run()

LarkBotListener Class

Constructor

listener = LarkBotListener(
    app_id: str,
    app_secret: str,
    message_expiry_time: int = 60  # Deduplication cache expiry (seconds)
)