async-zulip-bot-sdk

Async Zulip Bot SDK API Documentation

Welcome to the API documentation for Async Zulip Bot SDK. This documentation provides detailed information about all core components of the SDK.

Table of Contents

• Quick Start
• Core Components
  • AsyncClient - Async Zulip API Client
  • BaseBot - Bot Base Class
  • BotRunner - Bot Runner
• Command System
  • CommandParser - Command Parser
  • CommandSpec - Command Specification
  • CommandArgument - Command Arguments
• Data Models
  • Request Types
  • Response Types
  • Data Types
• Configuration
• Logging

Introduction

Async Zulip Bot SDK is an asynchronous Zulip bot development framework based on Python asyncio. It provides:

• 🚀 Fully asynchronous API client
• 🤖 Easy-to-use Bot base class
• 📝 Powerful command parsing system
• 🔧 Flexible configuration management
• 📊 Type-safe data models

Installation

pip install async-zulip-bot-sdk

Quick Example

from bot_sdk import BaseBot, BotRunner, AsyncClient, Message

class MyBot(BaseBot):
    async def on_message(self, message: Message) -> None:
        if "hello" in message.content.lower():
            await self.send_reply(message, "Hello! 👋")

if __name__ == "__main__":
    from bot_sdk import run_bot
    run_bot(MyBot)

Version

Current version: 0.9.1-async

License

This project is licensed under the MIT License.

This site is open source. Improve this page.