zalobot-python 0.1.0__tar.gz

zalobot_python-0.1.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.3
+Name: zalobot-python
+Version: 0.1.0
+Summary: Python SDK for the Zalo Bot API
+Author: NovaH00
+Author-email: NovaH00 <trantay2006super@gmail.com>
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: requests>=2.32.5
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# WIP: Python SDK for the ZaloBot API
+
+## Installation
+For uv-astral  
+```bash
+uv add zalobot_python
+```
+For pip  
+```bash
+pip install zalobot_python
+```
+
+Usage
+```python
+import asyncio
+from zalobot_python import ZaloBot, BotInfo 
+
+bot = ZaloBot(BOT_TOKEN="<BOT TOKEN>")
+
+async def main():
+    bot_info: BotInfo = await bot.getMe()
+
+    print(f"Bot ID: {bot_info.id}")
+    print(f"Bot Name: {bot_info.display_name}")
+
+asyncio.run(main())
+```

zalobot_python-0.1.0/README.md

@@ -0,0 +1,27 @@
+# WIP: Python SDK for the ZaloBot API
+
+## Installation
+For uv-astral  
+```bash
+uv add zalobot_python
+```
+For pip  
+```bash
+pip install zalobot_python
+```
+
+Usage
+```python
+import asyncio
+from zalobot_python import ZaloBot, BotInfo 
+
+bot = ZaloBot(BOT_TOKEN="<BOT TOKEN>")
+
+async def main():
+    bot_info: BotInfo = await bot.getMe()
+
+    print(f"Bot ID: {bot_info.id}")
+    print(f"Bot Name: {bot_info.display_name}")
+
+asyncio.run(main())
+```

zalobot_python-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "zalobot-python"
+version = "0.1.0"
+description = "Python SDK for the Zalo Bot API"
+readme = "README.md"
+authors = [
+    { name = "NovaH00", email = "trantay2006super@gmail.com" }
+]
+requires-python = ">=3.14"
+dependencies = [
+    "httpx>=0.28.1",
+    "pydantic>=2.12.5",
+    "requests>=2.32.5",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"

zalobot_python-0.1.0/src/zalobot_python/__init__.py

@@ -0,0 +1,25 @@
+from .zalobot import ZaloBot
+from .models import (
+    BotInfo,
+    WebhookInfo,
+    MessageInfo,
+    EventName,
+    From,
+    Chat,
+    Message,
+    Event,
+    ZaloAPIError
+)
+
+__all__ = [
+    "ZaloBot",
+    "BotInfo",
+    "WebhookInfo",
+    "MessageInfo",
+    "EventName",
+    "From",
+    "Chat",
+    "Message",
+    "Event",
+    "ZaloAPIError"
+]

zalobot_python-0.1.0/src/zalobot_python/config.py

@@ -0,0 +1,2 @@
+class ZaloAPIConfig:
+    BASE_URL: str = "https://bot-api.zaloplatforms.com"

zalobot_python-0.1.0/src/zalobot_python/models.py

@@ -0,0 +1,72 @@
+from enum import StrEnum 
+from typing import Literal, TypeVar, override
+from pydantic import BaseModel, Field
+
+class Result(BaseModel):
+    """Represents the result field in the API successful response"""
+    pass
+
+T = TypeVar("T", bound=Result)
+class SuccessfulResponse[T](BaseModel):
+    ok: Literal[True] = True
+    result: T = Field(description="The result when the API call is successful.")
+
+class ErrorResponse(BaseModel):
+    ok: Literal[False] = False
+    description: str = Field(description="The description of the error")
+    error_code: int = Field(description="The error code")
+
+type APIResponse[T] = SuccessfulResponse[T] | ErrorResponse
+
+class ZaloAPIError(BaseException):
+    def __init__(self, error_code: int, description: str):
+        self.error_code: int = error_code
+        self.description: str = description
+        super().__init__()
+
+    @override
+    def __str__(self):
+        return f"error_code: {self.error_code}; description: {self.description}"
+
+class BotInfo(Result):
+    id: str  
+    account_name: str 
+    account_type: str 
+    can_join_groups: bool
+    display_name: str
+
+class WebhookInfo(Result):
+    url: str 
+    updated_at: int 
+
+class MessageInfo(Result):
+    message_id: str
+    date: int
+
+
+class EventName(StrEnum):
+    TEXT_RECEIVED        = "message.text.received"
+    IMAGE_RECEIVED       = "message.image.received"
+    STICKER_RECEIVED     = "message.sticker.received"
+    UNSUPPORTED_RECEIVED = "message.unsupported.received"
+
+
+class From(BaseModel):
+    id: str
+    display_name: str
+    is_bot: bool
+
+class Chat(BaseModel):
+    id: str
+    chat_type: str
+
+class Message(BaseModel):
+    sender: From = Field(alias="from")
+    chat: Chat
+    text: str
+    message_id: str
+    date: int
+
+class Event(BaseModel):
+    event_name: EventName
+    message: Message

zalobot_python-0.1.0/src/zalobot_python/zalobot.py

@@ -0,0 +1,144 @@
+from typing import Any, Literal
+import httpx
+
+from .models import (
+    APIResponse,
+    SuccessfulResponse,
+    ErrorResponse,
+    ZaloAPIError,
+    BotInfo,  
+    WebhookInfo,
+    MessageInfo,
+    Event
+)
+from .config import ZaloAPIConfig
+
+
+async def fetch[T](
+    url: str,
+    *,
+    method: Literal["GET", "POST"] = "GET",
+    body: dict[str, Any] | None = None,
+) -> APIResponse[T]:
+    async with httpx.AsyncClient() as client:
+
+        if method == "GET":
+            response = await client.get(url)
+
+        elif method == "POST":
+            response = await client.post(url, json=body)
+
+        response_json = response.json()
+
+        if response_json.get("ok"):
+            return SuccessfulResponse(**response_json)
+
+        return ErrorResponse(**response_json)
+
+class ZaloBot:
+    def __init__(self, BOT_TOKEN: str):
+        self._BOT_TOKEN: str = BOT_TOKEN
+        self._base_url: str = f"{ZaloAPIConfig.BASE_URL}/bot{BOT_TOKEN}"
+    
+    async def getMe(self) -> BotInfo:
+        url = f"{self._base_url}/getMe" 
+        
+        res: APIResponse[BotInfo] = await fetch(url)
+        
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            ) 
+        
+       
+        return res.result
+                      
+                
+    async def getUpdates(self, timeout: int = 30) -> Event:
+        url = f"{self._base_url}/getUpdates"
+        
+        payload = {
+            "timeout": timeout
+        }
+
+        res: APIResponse[Event] = await fetch(url, method="POST", body=payload)
+
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            )
+
+        return res.result
+
+    async def setWebhook(self, url: str, secret_token: str) -> WebhookInfo:
+        url = f"{self._base_url}/setWebhook"
+        
+        payload = {
+            "url": url,
+            "secret_token": secret_token
+        }
+
+        res: APIResponse[WebhookInfo] = await fetch(url, method="POST", body=payload)
+
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            )
+
+        return res.result
+    
+    async def deleteWebhook(self) -> WebhookInfo:
+        url = f"{self._base_url}/deleteWebhook"
+        
+        res: APIResponse[WebhookInfo] = await fetch(url)
+
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            )
+
+        return res.result
+
+    async def getWebhookInfo(self) -> WebhookInfo:
+        url = f"{self._base_url}/getWebhookInfo"
+        
+        res: APIResponse[WebhookInfo] = await fetch(url)
+
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            )
+
+        return res.result
+    
+    async def sendMessage(self, chat_id: str, text: str) -> MessageInfo:
+        url = f"{self._base_url}/sendMessage"
+        
+        payload = {
+            "chat_id": chat_id,
+            "text": text
+        }
+        res: APIResponse[MessageInfo] = await fetch(url, method="POST", body=payload)
+
+        if isinstance(res, ErrorResponse):
+            raise ZaloAPIError(
+                res.error_code,
+                res.description
+            )
+
+        return res.result
+
+
+    async def sendPhoto(self, chat_id: str, caption: str, photo_url: str) -> None:
+        raise NotImplementedError()
+
+    async def sendSticker(self, chat_id: str, sticker: str) -> None:
+        raise NotImplementedError()
+
+    async def sendChatAction(self, chat_id: str, action: str) -> None:
+        raise NotImplementedError()