chattool 5.2.0__tar.gz → 5.3.0__tar.gz

{chattool-5.2.0/src/chattool.egg-info → chattool-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: chattool
-Version: 5.2.0
+Version: 5.3.0
 Summary: Toolkit for Chat API
 Author-email: Rex Wang <1073853456@qq.com>
 License: MIT license
@@ -40,6 +40,8 @@ Requires-Dist: alibabacloud_alidns20150109>=3.5.10; extra == "tools"
 Requires-Dist: alibabacloud_tea_openapi>=0.3.0; extra == "tools"
 Requires-Dist: tencentcloud-sdk-python; extra == "tools"
 Requires-Dist: netifaces; extra == "tools"
+Requires-Dist: lark-oapi==1.5.3; extra == "tools"
+Requires-Dist: flask; extra == "tools"
 Provides-Extra: tests
 Requires-Dist: coverage; extra == "tests"
 Requires-Dist: pytest>=3; extra == "tests"
@@ -81,161 +83,136 @@ Dynamic: license-file
 [English](README_en.md) | [简体中文](README.md)
 </div>
 
-基于 OpenAI API 的 `Chat` 对象，支持多轮对话以及异步处理数据等。
+集成 LLM 对话、飞书机器人、DNS 管理、SSL 证书等工具的 Python 开发套件。
 
-## 安装方法
+## 安装
 
 ```bash
 pip install chattool --upgrade
 ```
 
-## 使用方法
+## 功能概览
 
-### 环境变量配置
+### 1. 环境变量管理 (`chatenv`)
 
-ChatTool 使用集中式配置管理，支持`.env`文件、环境变量和默认值。
+集中式配置管理，密码类字段自动脱敏显示，交互模式隐藏敏感输入。
 
-1. **CLI 管理配置**（推荐）：
-   ```bash
-   # 交互式初始化（引导设置各项配置）
-   chatenv init -i
-   
-   # 设置配置项
-   chatenv set OPENAI_API_KEY=sk-xxx
-   
-   # 查看配置
-   chatenv cat
-   ```
+```bash
+# 交互式初始化（敏感字段自动隐藏输入）
+chatenv init -i
+
+# 仅初始化指定服务配置
+chatenv init -i -t openai
+chatenv init -i -t feishu
 
-2. **手动配置**：
-   你可以手动创建 `.env` 文件或设置环境变量。
+# 查看全部配置（敏感值自动打码）
+chatenv cat
 
-   **OpenAI 配置**
-   ```bash
-   export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-   export OPENAI_API_BASE="https://api.example.com/v1"
-   export OPENAI_API_MODEL="gpt-3.5-turbo"
-   ```
+# 按类型过滤查看
+chatenv cat -t feishu
 
-   **阿里云 DNS 配置**
-   ```bash
-   export ALIBABA_CLOUD_ACCESS_KEY_ID="your-access-key-id"
-   export ALIBABA_CLOUD_ACCESS_KEY_SECRET="your-access-key-secret"
-   export ALIBABA_CLOUD_REGION_ID="cn-hangzhou"
-   ```
+# 设置 / 查看单项
+chatenv set OPENAI_API_KEY=sk-xxx
+chatenv get OPENAI_API_KEY
 
-   **腾讯云 DNS 配置**
-   ```bash
-   export TENCENT_SECRET_ID="your-secret-id"
-   export TENCENT_SECRET_KEY="your-secret-key"
-   export TENCENT_REGION_ID="ap-guangzhou"
-   ```
+# 多配置 profile 管理
+chatenv save work && chatenv use work
+```
 
-### Chat 对象使用
+### 2. Chat 对话 (`chattool.Chat`)
 
-示例1，多轮对话：
+基于 OpenAI API 的对话对象，支持多轮对话、批量处理、异步并发和流式输出。
 
 ```python
-# 初次对话
+from chattool import Chat
+
+# 多轮对话
 chat = Chat("Hello!")
 resp = chat.get_response()
-
-# 继续对话
 chat.user("How are you?")
-next_resp = chat.get_response()
+chat.get_response()
+chat.save("chat.json", mode="w")
 
-# 人为添加返回内容
-chat.user("What's your name?")
-chat.assistant("My name is GPT-3.5.")
-
-# 保存对话内容
-chat.save("chat.json", mode="w") # 默认为 "a"
-
-# 打印对话历史
-chat.print_log()
+# 异步并发
+import asyncio
+base = Chat().system("你是一个有用的助手")
+tasks = [base.copy().user(f"主题 {i}").async_get_response() for i in range(5)]
+responses = asyncio.run(asyncio.gather(*tasks))
+
+# 流式输出
+async for chunk in Chat().user("写一首诗").async_get_response_stream():
+    if chunk.delta_content:
+        print(chunk.delta_content, end="", flush=True)
 ```
 
-示例2，批量处理数据（串行），并使用缓存文件 `chat.jsonl`：
-
-```python
-# 串行处理（按需保存）
-msgs = ["1", "2", "3", "4", "5", "6", "7", "8", "9"]
-results = []
-for m in msgs:
-    chat = Chat()
-    chat.system("你是一个熟练的数字翻译家。")
-    resp = chat.user(f"请将该数字翻译为罗马数字：{m}").get_response()
-    results.append(resp.content)
-    chat.save("chat.jsonl", mode="a")
-```
+### 3. 飞书/Lark 机器人 (`chattool lark`)
 
-示例3，异步并发与流式输出：
+一行命令发消息、启动 Echo/AI 机器人，支持文本、图片、文件、富文本等消息类型。
 
-```python
-import asyncio
-from chattool import Chat
+```bash
+# 发送消息
+chattool lark send -r USER_ID -m "Hello"
+chattool lark send -r USER_ID --image photo.png
+chattool lark send -r USER_ID --file report.pdf
 
-async def run():
-    # 并发问答
-    base = Chat().system("你是一个有用的助手")
-    tasks = [base.copy().user(f"请解释：主题 {i}").async_get_response() for i in range(2)]
-    responses = await asyncio.gather(*tasks)
-    for r in responses:
-        print(r.content)
-
-    # 流式输出
-    print("流式: ", end="")
-    async for chunk in Chat().user("写一首关于春天的短诗").async_get_response_stream():
-        if chunk.delta_content:
-            print(chunk.delta_content, end="", flush=True)
-    print()
-
-asyncio.run(run())
-```
+# 启动 Echo 机器人（WebSocket）
+chattool serve lark echo
 
-### DNS 工具箱
+# 启动 AI 对话机器人
+chattool serve lark ai --model gpt-4o
 
-ChatTool 提供了统一的 DNS 管理接口，支持阿里云和腾讯云。
+# 查看机器人信息和权限
+chattool lark info
+chattool lark scopes
+```
 
 ```python
-from chattool.tools.dns import create_dns_client
+from chattool.tools.lark import LarkBot
 
-# 创建阿里云客户端
-aliyun = create_dns_client("aliyun")
-aliyun.add_domain_record("example.com", "www", "A", "1.1.1.1")
+bot = LarkBot()
+bot.send_text("ou_xxx", "open_id", "Hello!")
+bot.send_image_file("ou_xxx", "open_id", "photo.png")
 
-# 创建腾讯云客户端
-tencent = create_dns_client("tencent")
-tencent.add_domain_record("example.com", "www", "A", "1.1.1.1")
+@bot.on_message
+def handle(ctx):
+    ctx.reply_text(f"收到: {ctx.text}")
+
+bot.start()
 ```
 
-**命令行工具 (CLI)**
+### 4. DNS 管理 (`chattool dns`)
 
-提供了便捷的 DDNS（动态域名解析）更新工具和 SSL 证书管理：
+统一的 DNS 接口，支持阿里云和腾讯云，提供 DDNS 动态更新和 SSL 证书自动续期。
 
 ```bash
-# 获取 DNS 记录
+# 查询 / 设置 DNS 记录
 chattool dns get test.example.com
-
-# 设置 DNS 记录
 chattool dns set test.example.com -v 1.2.3.4
 
-# DDNS 动态域名更新 (公网 IP)
+# DDNS 动态域名 (公网 / 局域网)
 chattool dns ddns -d example.com -r home --monitor
-
-# DDNS 动态域名更新 (局域网 IP)
 chattool dns ddns -d example.com -r nas --ip-type local --local-ip-cidr 192.168.1.0/24
 
 # SSL 证书自动更新
 chattool dns cert-update -d example.com -e admin@example.com --cert-dir ./certs
 ```
 
+### 5. 其他工具
+
+| 工具 | 命令 | 说明 |
+|------|------|------|
+| 网络扫描 | `chattool network scan` | 扫描局域网活跃主机和 SSH 端口 |
+| MCP 服务 | `chattool mcp inspect` | MCP Server 能力检查 |
+| 截图服务 | `chattool serve capture` | 本地网页截图服务 |
+| 证书分发 | `chattool serve cert` / `chattool client cert` | SSL 证书集中管理与客户端拉取 |
+
 ## 开源协议
 
-使用 MIT 协议开源。
+MIT License
 
 ## 更新日志
 
-- 当前版本 `4.1.0`，统一 `Chat` API（同步/异步/流式），默认环境变量配置，改进重试与调试工具
-- 历史：`2.x-3.x` 阶段逐步完善异步处理与批量用法
-- 更早版本沿革请参考仓库提交记录
+- `5.3.0` — 飞书机器人（消息收发、事件路由、AI 对话）、CLI 工具链（`chattool lark`、`chattool serve lark`）
+- `5.0.0` — DNS 管理（阿里云/腾讯云）、DDNS、SSL 证书自动续期、环境变量集中管理
+- `4.1.0` — 统一 `Chat` API（同步/异步/流式），默认环境变量配置
+- 更早版本请参考仓库提交记录

chattool-5.3.0/README.md

@@ -0,0 +1,154 @@
+<div align="center">
+    <a href="https://pypi.python.org/pypi/chattool">
+        <img src="https://img.shields.io/pypi/v/chattool.svg" alt="PyPI version" />
+    </a>
+    <a href="https://github.com/cubenlp/chattool/actions/workflows/ci.yml">
+        <img src="https://github.com/cubenlp/chattool/actions/workflows/ci.yml/badge.svg" alt="Tests" />
+    </a>
+    <a href="https://chattool.wzhecnu.cn">
+        <img src="https://img.shields.io/badge/docs-github_pages-blue.svg" alt="Documentation Status" />
+    </a>
+    <a href="https://codecov.io/gh/cubenlp/chattool">
+        <img src="https://codecov.io/gh/cubenlp/chattool/branch/master/graph/badge.svg" alt="Coverage" />
+    </a>
+</div>
+
+<div align="center">
+    <img src="https://qiniu.wzhecnu.cn/PicBed6/picgo/chattool.jpeg" alt="ChatAPI Toolkit" width="360", style="border-radius: 20px;">
+
+[English](README_en.md) | [简体中文](README.md)
+</div>
+
+集成 LLM 对话、飞书机器人、DNS 管理、SSL 证书等工具的 Python 开发套件。
+
+## 安装
+
+```bash
+pip install chattool --upgrade
+```
+
+## 功能概览
+
+### 1. 环境变量管理 (`chatenv`)
+
+集中式配置管理，密码类字段自动脱敏显示，交互模式隐藏敏感输入。
+
+```bash
+# 交互式初始化（敏感字段自动隐藏输入）
+chatenv init -i
+
+# 仅初始化指定服务配置
+chatenv init -i -t openai
+chatenv init -i -t feishu
+
+# 查看全部配置（敏感值自动打码）
+chatenv cat
+
+# 按类型过滤查看
+chatenv cat -t feishu
+
+# 设置 / 查看单项
+chatenv set OPENAI_API_KEY=sk-xxx
+chatenv get OPENAI_API_KEY
+
+# 多配置 profile 管理
+chatenv save work && chatenv use work
+```
+
+### 2. Chat 对话 (`chattool.Chat`)
+
+基于 OpenAI API 的对话对象，支持多轮对话、批量处理、异步并发和流式输出。
+
+```python
+from chattool import Chat
+
+# 多轮对话
+chat = Chat("Hello!")
+resp = chat.get_response()
+chat.user("How are you?")
+chat.get_response()
+chat.save("chat.json", mode="w")
+
+# 异步并发
+import asyncio
+base = Chat().system("你是一个有用的助手")
+tasks = [base.copy().user(f"主题 {i}").async_get_response() for i in range(5)]
+responses = asyncio.run(asyncio.gather(*tasks))
+
+# 流式输出
+async for chunk in Chat().user("写一首诗").async_get_response_stream():
+    if chunk.delta_content:
+        print(chunk.delta_content, end="", flush=True)
+```
+
+### 3. 飞书/Lark 机器人 (`chattool lark`)
+
+一行命令发消息、启动 Echo/AI 机器人，支持文本、图片、文件、富文本等消息类型。
+
+```bash
+# 发送消息
+chattool lark send -r USER_ID -m "Hello"
+chattool lark send -r USER_ID --image photo.png
+chattool lark send -r USER_ID --file report.pdf
+
+# 启动 Echo 机器人（WebSocket）
+chattool serve lark echo
+
+# 启动 AI 对话机器人
+chattool serve lark ai --model gpt-4o
+
+# 查看机器人信息和权限
+chattool lark info
+chattool lark scopes
+```
+
+```python
+from chattool.tools.lark import LarkBot
+
+bot = LarkBot()
+bot.send_text("ou_xxx", "open_id", "Hello!")
+bot.send_image_file("ou_xxx", "open_id", "photo.png")
+
+@bot.on_message
+def handle(ctx):
+    ctx.reply_text(f"收到: {ctx.text}")
+
+bot.start()
+```
+
+### 4. DNS 管理 (`chattool dns`)
+
+统一的 DNS 接口，支持阿里云和腾讯云，提供 DDNS 动态更新和 SSL 证书自动续期。
+
+```bash
+# 查询 / 设置 DNS 记录
+chattool dns get test.example.com
+chattool dns set test.example.com -v 1.2.3.4
+
+# DDNS 动态域名 (公网 / 局域网)
+chattool dns ddns -d example.com -r home --monitor
+chattool dns ddns -d example.com -r nas --ip-type local --local-ip-cidr 192.168.1.0/24
+
+# SSL 证书自动更新
+chattool dns cert-update -d example.com -e admin@example.com --cert-dir ./certs
+```
+
+### 5. 其他工具
+
+| 工具 | 命令 | 说明 |
+|------|------|------|
+| 网络扫描 | `chattool network scan` | 扫描局域网活跃主机和 SSH 端口 |
+| MCP 服务 | `chattool mcp inspect` | MCP Server 能力检查 |
+| 截图服务 | `chattool serve capture` | 本地网页截图服务 |
+| 证书分发 | `chattool serve cert` / `chattool client cert` | SSL 证书集中管理与客户端拉取 |
+
+## 开源协议
+
+MIT License
+
+## 更新日志
+
+- `5.3.0` — 飞书机器人（消息收发、事件路由、AI 对话）、CLI 工具链（`chattool lark`、`chattool serve lark`）
+- `5.0.0` — DNS 管理（阿里云/腾讯云）、DDNS、SSL 证书自动续期、环境变量集中管理
+- `4.1.0` — 统一 `Chat` API（同步/异步/流式），默认环境变量配置
+- 更早版本请参考仓库提交记录

{chattool-5.2.0 → chattool-5.3.0}/pyproject.toml

@@ -50,6 +50,8 @@ tools = [
     "alibabacloud_tea_openapi>=0.3.0",
     "tencentcloud-sdk-python",
     "netifaces",
+    "lark-oapi==1.5.3",
+    "flask",
 ]
 tests = [
     "coverage",
@@ -95,7 +97,8 @@ include-package-data = true
 markers = [
     "integration: mark test as integration test",
     "dns: mark test as dns test",
-    "mcp: mark test as mcp test"
+    "mcp: mark test as mcp test",
+    "lark: mark test as lark test"
 ]
 filterwarnings = [
     "ignore::DeprecationWarning:alibabacloud_tea_openapi.*",

{chattool-5.2.0 → chattool-5.3.0}/src/chattool/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = """Rex Wang"""
 __email__ = '1073853456@qq.com'
-__version__ = '5.2.0'
+__version__ = '5.3.0'
 
 from dotenv import load_dotenv
 
@@ -14,6 +14,7 @@ from .utils import (
 )
 from .const import CHATTOOL_REPO_DIR
 from .config import OpenAIConfig, AzureConfig, AliyunConfig, TencentConfig, ZulipConfig
+from .tools import LarkBot, AliyunDNSClient, TencentDNSClient, DynamicIPUpdater, SSLCertUpdater
 
 setup_jupyter_async()
 load_dotenv(CHATTOOL_REPO_DIR / '.env')
@@ -34,4 +35,9 @@ __all__ = [
     "AliyunConfig",
     "TencentConfig",
     "ZulipConfig",
+    "LarkBot",
+    "AliyunDNSClient",
+    "TencentDNSClient",
+    "DynamicIPUpdater",
+    "SSLCertUpdater",
 ]

{chattool-5.2.0 → chattool-5.3.0}/src/chattool/cli/chatenv.py

@@ -26,11 +26,33 @@ def profiles():
     else:
         click.echo(f"No profiles found in {CHATTOOL_ENV_DIR}")
 
+def _resolve_config_types(config_types):
+    """Resolve -t filter to matching config classes. Returns None if no filter."""
+    if not config_types:
+        return None
+    normalized = [t.lower() for t in config_types]
+    matched = [
+        cls for cls in BaseEnvConfig._registry
+        if cls._title.lower() in normalized
+        or any(a.lower() in normalized for a in getattr(cls, '_aliases', []))
+    ]
+    return matched
+
+
 @cli.command(name='cat')
 @click.argument('name', required=False)
 @click.option('--no-mask', is_flag=True, help='Show values in plain text without masking.')
-def cat_env(name, no_mask):
-    """Print the content of an environment profile or current .env."""
+@click.option('--type', '-t', 'config_types', multiple=True,
+              help='Filter configuration types (e.g. openai, feishu, aliyun).')
+def cat_env(name, no_mask, config_types):
+    """Print the content of an environment profile or current .env.
+
+    \b
+    Examples:
+      chatenv cat                # show all
+      chatenv cat -t feishu      # only show Feishu config
+      chatenv cat -t openai -t feishu
+    """
     if name:
         config_path = CHATTOOL_ENV_DIR / f'{name}.env'
     else:
@@ -40,52 +62,67 @@ def cat_env(name, no_mask):
         click.echo(f"Error: Environment file '{config_path}' not found.", err=True)
         return
 
-    content = config_path.read_text()
-    if no_mask:
-        click.echo(content)
-        return
-
-    # Identify sensitive keys
+    # Build lookup sets
     sensitive_keys = set()
     for config_cls in BaseEnvConfig._registry:
         for _, field in config_cls.get_fields().items():
             if field.is_sensitive:
                 sensitive_keys.add(field.env_key)
 
-    # Line-by-line processing for masking
+    # If -t is specified, only show keys belonging to those configs
+    filter_keys = None
+    if config_types:
+        matched = _resolve_config_types(config_types)
+        if not matched:
+            click.echo(f"No configuration types matched: {', '.join(config_types)}")
+            click.echo("Available types (and aliases):")
+            for cls in BaseEnvConfig._registry:
+                aliases = getattr(cls, '_aliases', [])
+                alias_str = f" ({', '.join(aliases)})" if aliases else ""
+                click.echo(f"  - {cls._title}{alias_str}")
+            return
+        filter_keys = set()
+        for cls in matched:
+            for _, field in cls.get_fields().items():
+                filter_keys.add(field.env_key)
+
+    content = config_path.read_text()
+    if no_mask and filter_keys is None:
+        click.echo(content)
+        return
+
     for line in content.splitlines():
         line_strip = line.strip()
+
         if not line_strip or line_strip.startswith('#'):
-            click.echo(line)
+            if filter_keys is None:
+                click.echo(line)
             continue
-        
-        if '=' in line:
-            key, value = line.split('=', 1)
-            key = key.strip()
-            
-            if key in sensitive_keys:
-                val_part = value.strip()
-                quote = ''
-                raw_val = val_part
-                
-                # Handle quotes
-                if len(val_part) >= 2:
-                    if (val_part.startswith("'") and val_part.endswith("'")) or \
-                       (val_part.startswith('"') and val_part.endswith('"')):
-                        quote = val_part[0]
-                        raw_val = val_part[1:-1]
-                
-                # Masking logic
-                masked = mask_secret(raw_val)
-                
-                # Reconstruct line with masked value
-                # We try to preserve the key part as is (from split), but we lost the whitespace around =
-                # Since we don't know the exact whitespace, we just output KEY=VALUE
-                click.echo(f"{key}={quote}{masked}{quote}")
-            else:
+
+        if '=' not in line:
+            if filter_keys is None:
                 click.echo(line)
-        else:
+            continue
+
+        key, value = line.split('=', 1)
+        key = key.strip()
+
+        if filter_keys is not None and key not in filter_keys:
+            continue
+
+        if no_mask or key not in sensitive_keys:
             click.echo(line)
+        else:
+            val_part = value.strip()
+            quote = ''
+            raw_val = val_part
+            if len(val_part) >= 2:
+                if (val_part.startswith("'") and val_part.endswith("'")) or \
+                   (val_part.startswith('"') and val_part.endswith('"')):
+                    quote = val_part[0]
+                    raw_val = val_part[1:-1]
+            masked = mask_secret(raw_val)
+            click.echo(f"{key}={quote}{masked}{quote}")
 
 @cli.command(name='save')
 @click.argument('name')
@@ -141,18 +178,12 @@ def init(interactive, config_types):
     - Aliyun: ali, aliyun, alidns
     - Tencent: tencent, tx, tencent-dns
     - Zulip: zulip
+    - Feishu: feishu, lark
     """
     
-    # Filter config classes if types are specified
     target_configs = BaseEnvConfig._registry
     if config_types:
-        normalized_types = [t.lower() for t in config_types]
-        target_configs = [
-            cls for cls in BaseEnvConfig._registry 
-            if cls._title.lower() in normalized_types or 
-               any(alias.lower() in normalized_types for alias in getattr(cls, '_aliases', []))
-        ]
-        
+        target_configs = _resolve_config_types(config_types)
         if not target_configs:
             click.echo(f"No configuration types matched: {', '.join(config_types)}")
             click.echo("Available types (and aliases):")
@@ -178,16 +209,29 @@ def init(interactive, config_types):
                     prompt_text += f" ({field.desc})"
                 
                 default_val = field.value if field.value is not None else field.default
-                
-                new_val = click.prompt(
-                    prompt_text,
-                    default=default_val if default_val is not None else "",
-                    show_default=True,
-                    type=str
-                )
-                
-                if new_val:
-                     field.value = new_val
+
+                if field.is_sensitive:
+                    hint = mask_secret(default_val) if default_val else ""
+                    if hint:
+                        prompt_text += f" [{hint}]"
+                    new_val = click.prompt(
+                        prompt_text,
+                        default="",
+                        show_default=False,
+                        hide_input=True,
+                        type=str,
+                    )
+                    if new_val:
+                        field.value = new_val
+                else:
+                    new_val = click.prompt(
+                        prompt_text,
+                        default=default_val if default_val is not None else "",
+                        show_default=True,
+                        type=str,
+                    )
+                    if new_val:
+                        field.value = new_val
     
     BaseEnvConfig.save_env_file(str(CHATTOOL_ENV_FILE), __version__)
     click.echo(f"Configuration saved to {CHATTOOL_ENV_FILE}")

{chattool-5.2.0 → chattool-5.3.0}/src/chattool/cli/client/__init__.py

@@ -3,6 +3,7 @@ from .cert_updater import main as ssl_updater_main
 from .dns_updater import cli as dns_updater_cli
 from .mcp import cli as mcp_cli
 from .network import network as network_cli
+from .lark import cli as lark_cli
 
 __all__ = [
     "cert_client",
@@ -10,4 +11,5 @@ __all__ = [
     "dns_updater_cli",
     "mcp_cli",
     "network_cli",
+    "lark_cli",
 ]