workflow-cli 0.1.0__py3-none-any.whl

wfcli/lark.py

@@ -0,0 +1,260 @@
+"""lark-cli 封装层 - 与飞书交互的唯一通道
+
+所有对飞书云盘的操作都通过此模块完成，内部调用 lark-cli 命令行工具。
+调用方只需关心 Python 数据结构和返回值，无需了解 lark-cli 的命令行细节。
+"""
+
+import json
+import subprocess
+from pathlib import Path
+from typing import Any
+
+import click
+
+
+class LarkError(Exception):
+    """lark-cli 调用异常"""
+    pass
+
+
+class LarkClient:
+    """lark-cli 封装客户端
+
+    所有方法均以 dict/list 返回，错误统一抛出 LarkError。
+    """
+
+    def __init__(self, timeout: int = 30):
+        self.timeout = timeout
+
+    def _run(self, cmd: list[str], expect_json: bool = True) -> Any:
+        """执行 lark-cli 命令，返回解析后的 JSON 或 stdout"""
+        try:
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                text=True,
+                timeout=self.timeout,
+            )
+        except subprocess.TimeoutExpired:
+            raise LarkError(f"命令超时（{self.timeout}s）: {' '.join(cmd)}")
+        except FileNotFoundError:
+            raise LarkError("未找到 lark-cli，请先安装: npm install -g @anthropic/lark-cli")
+
+        if result.returncode != 0:
+            err_msg = result.stderr.strip() or result.stdout.strip() or "未知错误"
+            raise LarkError(f"lark-cli 执行失败: {err_msg}\n命令: {' '.join(cmd)}")
+
+        output = result.stdout.strip()
+        if not output:
+            return {} if expect_json else ""
+
+        if expect_json:
+            try:
+                return json.loads(output)
+            except json.JSONDecodeError:
+                # 部分 lark-cli 命令返回的不是纯 JSON，尝试提取 JSON 块
+                for line in output.split("\n"):
+                    line = line.strip()
+                    if line.startswith("{") or line.startswith("["):
+                        try:
+                            return json.loads(line)
+                        except json.JSONDecodeError:
+                            continue
+                raise LarkError(f"无法解析 lark-cli 返回的 JSON:\n{output[:500]}")
+
+        return output
+
+    # ── 云盘文件列表 ──────────────────────────────────────────────
+
+    def drive_list_files(self, folder_token: str, page_size: int = 200) -> list[dict]:
+        """列出文件夹下的所有文件/子文件夹
+
+        Args:
+            folder_token: 父文件夹 token
+            page_size: 每页数量，最大 200
+
+        Returns:
+            文件列表，每项包含 name, token, type 等字段
+        """
+        params = json.dumps({"folder_token": folder_token, "page_size": page_size})
+        cmd = [
+            "lark-cli", "drive", "files", "list",
+            "--params", params,
+            "--as", "user",
+        ]
+        data = self._run(cmd)
+        # lark-cli 返回的结构可能是 {"data": {"files": [...]}} 或直接 {"files": [...]}
+        if isinstance(data, dict):
+            files = (
+                data.get("data", {}).get("files")
+                or data.get("files")
+                or data.get("data", {}).get("items")
+                or []
+            )
+            return files
+        return data if isinstance(data, list) else []
+
+    # ── 创建文件夹 ────────────────────────────────────────────────
+
+    def drive_create_folder(self, name: str, parent_token: str) -> str:
+        """在指定父文件夹下创建子文件夹
+
+        Args:
+            name: 文件夹名称
+            parent_token: 父文件夹 token
+
+        Returns:
+            新建文件夹的 folder_token
+        """
+        cmd = [
+            "lark-cli", "drive", "+create-folder",
+            "--name", name,
+            "--folder-token", parent_token,
+            "--as", "user",
+        ]
+        data = self._run(cmd)
+        if isinstance(data, dict):
+            token = (
+                data.get("data", {}).get("token")
+                or data.get("token")
+                or data.get("data", {}).get("folder_token")
+                or ""
+            )
+            if not token:
+                raise LarkError(f"创建文件夹成功但未返回 token: {data}")
+            return token
+        raise LarkError(f"创建文件夹返回异常: {data}")
+
+    # ── 上传文件 ──────────────────────────────────────────────────
+
+    def drive_upload(
+        self,
+        local_path: str | Path,
+        folder_token: str | None = None,
+        file_token: str | None = None,
+    ) -> str:
+        """上传本地文件到飞书云盘
+
+        Args:
+            local_path: 本地文件路径
+            folder_token: 目标文件夹 token（新文件上传时使用）
+            file_token: 已有文件 token（覆盖上传时使用）
+
+        Returns:
+            上传后的 file_token
+        """
+        local_path = Path(local_path)
+        if not local_path.exists():
+            raise LarkError(f"本地文件不存在: {local_path}")
+
+        cmd = [
+            "lark-cli", "drive", "+upload",
+            "--file", str(local_path),
+            "--as", "user",
+        ]
+        if file_token:
+            cmd.extend(["--file-token", file_token])
+        elif folder_token:
+            cmd.extend(["--folder-token", folder_token])
+        else:
+            raise LarkError("上传文件时必须指定 folder_token 或 file_token")
+
+        # lark-cli drive +download --output 必须为相对路径
+        # upload 不需要，但 cd 到文件所在目录更安全
+        cwd = local_path.parent
+        try:
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                text=True,
+                timeout=self.timeout,
+                cwd=str(cwd),
+            )
+        except subprocess.TimeoutExpired:
+            raise LarkError(f"上传超时（{self.timeout}s）: {local_path.name}")
+
+        if result.returncode != 0:
+            err_msg = result.stderr.strip() or result.stdout.strip()
+            raise LarkError(f"上传失败: {err_msg}")
+
+        # 尝试从输出中提取 file_token
+        try:
+            data = json.loads(result.stdout.strip())
+            token = (
+                data.get("data", {}).get("file_token")
+                or data.get("file_token")
+                or data.get("data", {}).get("token")
+                or ""
+            )
+            return token
+        except json.JSONDecodeError:
+            return ""
+
+    # ── 下载文件 ──────────────────────────────────────────────────
+
+    def drive_download(self, file_token: str, output_dir: str | Path = ".") -> Path:
+        """从飞书云盘下载文件
+
+        Args:
+            file_token: 文件的 file_token
+            output_dir: 输出目录
+
+        Returns:
+            下载后的本地文件路径
+        """
+        output_dir = Path(output_dir)
+        output_dir.mkdir(parents=True, exist_ok=True)
+
+        # lark-cli drive +download --output 必须为相对路径
+        # 先 cd 到目标目录再执行
+        cmd = [
+            "lark-cli", "drive", "+download",
+            "--file-token", file_token,
+            "--as", "user",
+        ]
+        try:
+            result = subprocess.run(
+                cmd,
+                capture_output=True,
+                text=True,
+                timeout=self.timeout,
+                cwd=str(output_dir),
+            )
+        except subprocess.TimeoutExpired:
+            raise LarkError(f"下载超时（{self.timeout}s）: {file_token}")
+
+        if result.returncode != 0:
+            err_msg = result.stderr.strip() or result.stdout.strip()
+            raise LarkError(f"下载失败: {err_msg}")
+
+        # 从输出中推断下载的文件名
+        output = result.stdout.strip()
+        try:
+            data = json.loads(output)
+            filename = data.get("data", {}).get("file_name") or data.get("file_name") or ""
+        except json.JSONDecodeError:
+            # 从输出文本中提取文件名
+            filename = ""
+            for line in output.split("\n"):
+                if "file_name" in line or "saved" in line.lower():
+                    filename = line.split(":")[-1].strip()
+                    break
+
+        if filename:
+            return output_dir / filename
+        # 如果无法确定文件名，返回目录下最新修改的文件
+        files = sorted(output_dir.iterdir(), key=lambda p: p.stat().st_mtime, reverse=True)
+        return files[0] if files else output_dir
+
+
+# ── 全局单例 ──────────────────────────────────────────────────────
+
+_client: LarkClient | None = None
+
+
+def get_client() -> LarkClient:
+    """获取 LarkClient 全局单例"""
+    global _client
+    if _client is None:
+        _client = LarkClient()
+    return _client

wfcli/main.py

@@ -0,0 +1,29 @@
+"""CLI 入口 - 公司工作流工具"""
+
+import click
+
+from wfcli import __version__
+from wfcli.updater import try_auto_update
+from wfcli.commands.workspace import workspace
+from wfcli.commands.doc import doc
+from wfcli.commands.sync import sync
+from wfcli.commands.config_cmd import config
+from wfcli.commands.info import info
+
+
+@click.group()
+@click.version_option(version=__version__, prog_name="wf-cli")
+def cli():
+    """公司工作流 CLI 工具 - 提升日常工作效率"""
+    try_auto_update()
+
+
+cli.add_command(workspace)
+cli.add_command(doc)
+cli.add_command(sync)
+cli.add_command(config)
+cli.add_command(info)
+
+
+if __name__ == "__main__":
+    cli()

wfcli/updater.py

@@ -0,0 +1,78 @@
+"""静默自动更新模块
+
+策略：
+- 每天最多尝试一次更新（缓存文件 ~/.wfcli/.last_update）
+- subprocess 调用 pip install --upgrade wfcli，15 秒超时
+- 成功打印一行提示，失败静默忽略，绝不阻塞用户命令执行
+"""
+
+import subprocess
+import sys
+from datetime import datetime
+from pathlib import Path
+
+from wfcli import config as cfg
+
+_CACHE_DIR = cfg.CONFIG_DIR
+_LAST_UPDATE_FILE = _CACHE_DIR / ".last_update"
+_UPDATE_TIMEOUT = 15  # 秒
+
+
+def try_auto_update() -> None:
+    """尝试静默自动更新，失败则静默跳过，不影响后续命令执行"""
+    try:
+        # 检查是否启用了自动更新
+        if not cfg.get("update.enabled", True):
+            return
+
+        # 检查间隔（天）
+        interval = cfg.get("update.check_interval_days", 1)
+        if not _should_check(interval):
+            return
+
+        # 记录本次检查时间
+        _CACHE_DIR.mkdir(parents=True, exist_ok=True)
+        _LAST_UPDATE_FILE.write_text(datetime.now().isoformat())
+
+        # 尝试升级
+        result = subprocess.run(
+            [
+                sys.executable, "-m", "pip", "install",
+                "--upgrade", "wf-cli",
+                "--quiet",
+            ],
+            capture_output=True,
+            text=True,
+            timeout=_UPDATE_TIMEOUT,
+        )
+
+        if result.returncode == 0 and "Successfully installed" in result.stdout:
+            # 提取新版本号
+            for line in result.stdout.split("\n"):
+                if "wfcli" in line.lower():
+                    click_echo(f"  已自动升级到最新版本: {line.strip()}")
+                    return
+            click_echo("  已自动升级到最新版本")
+
+    except Exception:
+        # 网络超时、权限问题、pip 不存在等，全部静默忽略
+        pass
+
+
+def _should_check(interval_days: int) -> bool:
+    """判断是否应该检查更新"""
+    if not _LAST_UPDATE_FILE.exists():
+        return True
+    try:
+        last_str = _LAST_UPDATE_FILE.read_text().strip()
+        last_check = datetime.fromisoformat(last_str)
+        days_passed = (datetime.now() - last_check).days
+        return days_passed >= interval_days
+    except Exception:
+        return True
+
+
+def click_echo(msg: str) -> None:
+    """延迟导入 click 以避免启动时循环依赖"""
+    import click
+    click.echo(msg)

wfcli/utils/__init__.py

@@ -0,0 +1 @@
+"""utils 工具包"""

wfcli/utils/display.py

@@ -0,0 +1,66 @@
+"""终端输出格式化 - 基于 rich 的美化输出"""
+
+from rich.console import Console
+from rich.table import Table
+from rich.panel import Panel
+from rich.text import Text
+
+console = Console()
+
+
+def print_success(msg: str) -> None:
+    """打印成功信息"""
+    console.print(f"[green]✓[/green] {msg}")
+
+
+def print_error(msg: str) -> None:
+    """打印错误信息"""
+    console.print(f"[red]✗[/red] {msg}")
+
+
+def print_warning(msg: str) -> None:
+    """打印警告信息"""
+    console.print(f"[yellow]![/yellow] {msg}")
+
+
+def print_info(msg: str) -> None:
+    """打印普通信息"""
+    console.print(f"[blue]i[/blue] {msg}")
+
+
+def print_table(headers: list[str], rows: list[list[str]], title: str = "") -> None:
+    """打印格式化表格"""
+    table = Table(title=title, show_lines=False, pad_edge=False)
+    for h in headers:
+        table.add_column(h, style="cyan")
+    for row in rows:
+        table.add_row(*row)
+    console.print(table)
+
+
+def print_file_list(files: list[dict], title: str = "文件列表") -> None:
+    """打印文件列表"""
+    headers = ["名称", "类型", "Token"]
+    rows = []
+    for f in files:
+        name = f.get("name", "")
+        ftype = "文件夹" if f.get("type") == "folder" else "文件"
+        token = f.get("token", "")[:20] + "..." if len(f.get("token", "")) > 20 else f.get("token", "")
+        rows.append([name, ftype, token])
+    print_table(headers, rows, title)
+
+
+def print_panel(content: str, title: str = "", style: str = "blue") -> None:
+    """打印面板"""
+    panel = Panel(content, title=title, border_style=style)
+    console.print(panel)
+
+
+def print_step(step: int, total: int, msg: str) -> None:
+    """打印步骤进度"""
+    console.print(f"[dim][{step}/{total}][/dim] {msg}")
+
+
+def print_divider() -> None:
+    """打印分隔线"""
+    console.rule()

wfcli/utils/fs.py

@@ -0,0 +1,142 @@
+"""本地文件系统操作工具"""
+
+import re
+from pathlib import Path
+from typing import Any
+
+
+def find_workspace_root(start: Path | None = None) -> Path | None:
+    """从 start 向上查找包含 WORKSPACE.md 的目录
+
+    Args:
+        start: 起始目录，默认为当前工作目录
+
+    Returns:
+        工作空间根目录路径，未找到返回 None
+    """
+    current = start or Path.cwd()
+    current = current.resolve()
+    while True:
+        if (current / "WORKSPACE.md").exists():
+            return current
+        parent = current.parent
+        if parent == current:
+            return None
+        current = parent
+
+
+def require_workspace_root() -> Path:
+    """获取工作空间根目录，不存在则报错退出"""
+    import click
+    root = find_workspace_root()
+    if root is None:
+        raise click.ClickException(
+            "当前目录不在任何工作空间中。\n"
+            "请先 cd 到工作空间目录，或使用 'wfcli workspace pull' 下载工作空间。"
+        )
+    return root
+
+
+def parse_workspace_md(path: Path) -> dict[str, Any]:
+    """解析 WORKSPACE.md，提取结构化信息
+
+    Returns:
+        {
+            "name": str,              # 工作空间名称
+            "description": str,       # 简介
+            "workflow_link": str,     # workflow.md 飞书链接
+            "directories": [...],     # 目录结构
+            "templates": {...},       # 模板索引 {类型: 模板路径}
+            "naming_rules": str,      # 命名规范
+        }
+    """
+    content = path.read_text(encoding="utf-8")
+    result: dict[str, Any] = {
+        "name": "",
+        "description": "",
+        "workflow_link": "",
+        "directories": [],
+        "templates": {},
+        "naming_rules": "",
+        "raw_content": content,
+    }
+
+    # 提取飞书链接
+    link_match = re.search(r"https?://[^\s)]+feishu[^\s)]*", content)
+    if link_match:
+        result["workflow_link"] = link_match.group(0)
+
+    # 提取工作空间名称（通常在第一个 # 标题或开头描述中）
+    title_match = re.search(r"^#\s+(.+)", content, re.MULTILINE)
+    if title_match:
+        result["name"] = title_match.group(1).strip()
+
+    # 提取目录结构（代码块中的树形结构）
+    tree_match = re.search(r"```\n(.*?)```", content, re.DOTALL)
+    if tree_match:
+        tree_text = tree_match.group(1)
+        result["directories"] = _parse_tree(tree_text)
+
+    # 提取模板索引表
+    result["templates"] = _parse_template_table(content)
+
+    return result
+
+
+def _parse_tree(tree_text: str) -> list[dict]:
+    """解析树形目录结构文本"""
+    dirs = []
+    for line in tree_text.strip().split("\n"):
+        # 匹配如 "01_会议纪要" 或 "├── 01_会议纪要" 格式
+        match = re.search(r"(\d{2}_\S+)", line)
+        if match:
+            name = match.group(1).strip()
+            # 判断层级
+            depth = 0
+            if "│" in line or "├" in line or "└" in line:
+                depth = line.count("│") + (1 if "├" in line or "└" in line else 0)
+            dirs.append({"name": name, "depth": depth})
+    return dirs
+
+
+def _parse_template_table(content: str) -> dict[str, str]:
+    """从 Markdown 表格中提取模板索引"""
+    templates = {}
+    # 匹配表格行: | 文档类型 | 模板路径 | ...
+    for line in content.split("\n"):
+        cells = [c.strip() for c in line.split("|")]
+        if len(cells) >= 3 and not line.startswith("|---") and not line.startswith("| :"):
+            doc_type = cells[1].strip()
+            template_path = cells[2].strip()
+            if doc_type and template_path and doc_type != "文档类型" and template_path != "模板路径":
+                templates[doc_type] = template_path
+    return templates
+
+
+def ensure_dir(path: Path) -> Path:
+    """确保目录存在，不存在则创建"""
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def list_local_dirs(root: Path) -> list[Path]:
+    """列出工作空间下的一级目录"""
+    return sorted(
+        [d for d in root.iterdir() if d.is_dir() and not d.name.startswith(".")],
+        key=lambda p: p.name,
+    )
+
+
+def list_local_files(directory: Path, pattern: str = "*") -> list[Path]:
+    """列出目录下的文件"""
+    return sorted(
+        [f for f in directory.glob(pattern) if f.is_file()],
+        key=lambda p: p.name,
+    )
+
+
+def read_template(template_path: Path) -> str:
+    """读取模板文件内容"""
+    if not template_path.exists():
+        raise FileNotFoundError(f"模板文件不存在: {template_path}")
+    return template_path.read_text(encoding="utf-8")

workflow_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: workflow-cli
+Version: 0.1.0
+Summary: 公司工作流 CLI 工具 —— 提升日常工作效率
+Author-email: TODO <TODO@example.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/TODO/workflow-cli
+Project-URL: Repository, https://github.com/TODO/workflow-cli
+Project-URL: Issues, https://github.com/TODO/workflow-cli/issues
+Keywords: cli,workflow,feishu,lark
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Provides-Extra: toml
+Requires-Dist: tomli>=2.0; extra == "toml"
+Requires-Dist: tomli-w>=1.0; extra == "toml"
+Dynamic: license-file
+
+# wf-cli
+
+公司工作流 CLI 工具 —— 提升日常工作效率的命令行助手。
+
+## 功能
+
+| 命令 | 说明 |
+|------|------|
+| `wf-cli workspace` | 管理工作空间（创建/下载/新增文档类型/更新模板） |
+| `wf-cli doc` | 基于模板交互式生成文档 |
+| `wf-cli sync` | 与飞书云盘双向同步文件 |
+| `wf-cli config` | 查看和修改 CLI 配置 |
+| `wf-cli info` | 显示版本和当前工作环境状态 |
+
+## 安装
+
+```bash
+pip install workflow-cli
+```
+
+## 前置依赖
+
+- **Python >= 3.10**
+- **[lark-cli](https://www.npmjs.com/package/lark-cli)**（可选，飞书云盘集成需要）：`npm install -g lark-cli`
+
+> 💡 即使没有安装 lark-cli，`wf-cli info` 等命令仍可正常运行，仅飞书相关操作会友好提示。
+
+## 快速开始
+
+```bash
+# 查看帮助
+wf-cli --help
+
+# 查看当前状态
+wf-cli info
+
+# 查看默认配置
+wf-cli config show
+
+# 修改飞书根目录 token
+wf-cli config set feishu.root_folder_token <your-token>
+
+# 列出云盘上的工作空间
+wf-cli workspace list
+
+# 下载工作空间到本地
+wf-cli workspace pull
+
+# 生成文档
+wf-cli doc generate
+```
+
+## 配置
+
+配置文件位于 `~/.wfcli/config.toml`（TOML 格式），首次运行时自动生成默认配置。
+
+可配置项：
+
+| 配置项 | 说明 | 默认值 |
+|--------|------|--------|
+| `feishu.root_folder_token` | 飞书云盘工作空间根目录 token | 已预设 |
+| `workspace.default_local_dir` | 默认本地下载路径 | `~/workspaces` |
+| `update.enabled` | 是否启用自动更新 | `true` |
+| `update.check_interval_days` | 更新检查间隔（天） | `1` |
+
+## Python 3.10 用户注意
+
+Python 3.10 不内置 `tomllib`，请安装时带上 `toml` 额外依赖：
+
+```bash
+pip install workflow-cli[toml]
+```
+
+Python 3.11+ 用户无需额外操作。
+
+## 许可证
+
+MIT