workflow-cli 0.1.0__tar.gz

workflow_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 wf-cli contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

workflow_cli-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include README.md
+include LICENSE
+graft src/wfcli
+graft tests
+prune src/wfcli/__pycache__
+prune tests/__pycache__
+prune src/*.egg-info
+global-exclude *.pyc
+global-exclude __pycache__

workflow_cli-0.1.0/PKG-INFO

@@ -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

workflow_cli-0.1.0/README.md

@@ -0,0 +1,78 @@
+# 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

workflow_cli-0.1.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "workflow-cli"
+version = "0.1.0"
+description = "公司工作流 CLI 工具 —— 提升日常工作效率"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    {name = "TODO", email = "TODO@example.com"},
+]
+keywords = ["cli", "workflow", "feishu", "lark"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "click>=8.0",
+    "rich>=13.0",
+]
+
+[project.optional-dependencies]
+toml = ["tomli>=2.0", "tomli-w>=1.0"]
+
+[project.urls]
+Homepage = "https://github.com/TODO/workflow-cli"
+Repository = "https://github.com/TODO/workflow-cli"
+Issues = "https://github.com/TODO/workflow-cli/issues"
+
+[project.scripts]
+wf-cli = "wfcli.main:cli"
+
+[tool.setuptools.packages.find]
+where = ["src"]

workflow_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

workflow_cli-0.1.0/src/wfcli/__init__.py

@@ -0,0 +1,3 @@
+"""公司工作流 CLI 工具"""
+
+__version__ = "0.1.0"

workflow_cli-0.1.0/src/wfcli/commands/__init__.py

@@ -0,0 +1 @@
+"""commands 子命令包"""

workflow_cli-0.1.0/src/wfcli/commands/config_cmd.py

@@ -0,0 +1,45 @@
+"""config 子命令 - 配置管理"""
+
+import click
+
+from wfcli import config as cfg
+
+
+@click.group()
+def config():
+    """配置管理"""
+    pass
+
+
+@config.command()
+def show():
+    """查看当前配置"""
+    data = cfg.load_config()
+    _print_dict(data)
+
+
+@config.command()
+@click.argument("key")
+@click.argument("value")
+def set(key: str, value: str):
+    """修改配置项，如: wfcli config set feishu.root_folder_token xxx"""
+    cfg.set_value(key, value)
+    click.echo(f"已更新: {key} = {value}")
+
+
+@config.command()
+def reset():
+    """重置为默认配置"""
+    cfg.save_config(cfg.DEFAULT_CONFIG)
+    click.echo("已重置为默认配置")
+
+
+def _print_dict(data: dict, indent: int = 0) -> None:
+    """递归打印字典内容"""
+    prefix = "  " * indent
+    for k, v in data.items():
+        if isinstance(v, dict):
+            click.echo(f"{prefix}[{k}]")
+            _print_dict(v, indent + 1)
+        else:
+            click.echo(f"{prefix}{k} = {v}")

workflow_cli-0.1.0/src/wfcli/commands/doc.py

@@ -0,0 +1,149 @@
+"""doc 子命令 - 文档生成"""
+from __future__ import annotations
+
+from pathlib import Path
+from datetime import datetime
+
+import click
+
+from wfcli.core.docgen import (
+    select_template,
+    collect_inputs,
+    generate_document,
+    check_and_save,
+    run_checklist,
+)
+from wfcli.core.template import load_template
+from wfcli.core.naming import build_filename
+from wfcli.utils.fs import require_workspace_root, parse_workspace_md
+from wfcli.utils.display import print_success, print_error, print_info
+
+
+@click.group()
+def doc():
+    """文档生成"""
+    pass
+
+
+@doc.command()
+@click.option("--type", "-t", "doc_type", default=None, help="文档类型（跳过交互式选择）")
+@click.option("--topic", default=None, help="文档主题")
+@click.option("--output", "-o", default=None, help="指定输出目录（相对于工作空间根目录）")
+def generate(doc_type: str | None, topic: str | None, output: str | None):
+    """按模板生成交档
+
+    交互式选择模板、填写内容，按命名规范保存到本地对应目录。
+    """
+    ws_root = require_workspace_root()
+    ws_info = parse_workspace_md(ws_root / "WORKSPACE.md")
+
+    # 1. 选择模板
+    if doc_type:
+        from wfcli.core.template import list_templates
+        templates = list_templates(ws_root)
+        template_info = next(
+            (t for t in templates if doc_type in t["type"] or doc_type in t["name"]),
+            None,
+        )
+        if not template_info:
+            print_error(f"未找到匹配的文档类型: {doc_type}")
+            print_info("可用类型:")
+            for t in templates:
+                click.echo(f"  - {t['type']}")
+            return
+    else:
+        template_info = select_template(ws_root)
+
+    print_info(f"使用模板: {template_info['name']}")
+
+    # 2. 加载模板
+    template_data = load_template(template_info["path"])
+
+    # 3. 收集用户输入
+    if not topic:
+        topic = click.prompt("文档主题")
+
+    inputs = collect_inputs(template_data)
+
+    # 4. 生成文档
+    print_info("生成文档...")
+    content = generate_document(
+        template_data=template_data,
+        inputs=inputs,
+        title=topic,
+    )
+
+    # 5. 预览
+    click.echo("\n" + "─" * 50)
+    click.echo(content[:500])
+    if len(content) > 500:
+        click.echo(f"\n... (共 {len(content)} 字符)")
+    click.echo("─" * 50)
+
+    # 6. 自检
+    if not run_checklist(template_data):
+        if not click.confirm("\n自检未全部通过，是否仍要保存？", default=False):
+            return
+
+    # 7. 确定保存位置
+    if output:
+        target_dir = output
+    else:
+        # 根据模板类型推断存放目录
+        target_dir = _infer_target_dir(ws_root, template_info["type"])
+
+    # 8. 保存
+    saved_path = check_and_save(
+        content=content,
+        workspace_root=ws_root,
+        target_dir=target_dir,
+        topic=topic,
+    )
+
+    print_success(f"文档已保存: {saved_path.relative_to(ws_root)}")
+    print_info(f"完整路径: {saved_path}")
+    print_info("提交到云盘: wfcli sync push " + str(saved_path))
+
+
+@doc.command()
+def list():
+    """列出当前工作空间的可用文档类型"""
+    ws_root = require_workspace_root()
+
+    from wfcli.core.template import list_templates
+    templates = list_templates(ws_root)
+
+    if not templates:
+        print_info("当前工作空间没有可用模板")
+        return
+
+    print_info(f"工作空间: {ws_root.name}")
+    click.echo()
+    for t in templates:
+        click.echo(f"  - {t['type']}  ({t['name']}.md)")
+
+
+def _infer_target_dir(ws_root: Path, doc_type: str) -> str:
+    """根据文档类型推断存放目录
+
+    从 WORKSPACE.md 的模板索引表中查找，找不到则用类型名作为目录名。
+    """
+    ws_info = parse_workspace_md(ws_root / "WORKSPACE.md")
+    templates_map = ws_info.get("templates", {})
+
+    # 在模板索引中查找
+    for dtype, tpath in templates_map.items():
+        if doc_type in dtype:
+            # 从模板路径推断存放目录
+            # 模板路径如 "00_模板/01_01_会议纪要模板.md"
+            # 存放目录如 "01_会议纪要"
+            for d in (ws_root).iterdir():
+                if d.is_dir() and doc_type in d.name:
+                    return d.name
+
+    # 兜底：查找包含类型名的目录
+    for d in ws_root.iterdir():
+        if d.is_dir() and doc_type in d.name:
+            return d.name
+
+    return doc_type

workflow_cli-0.1.0/src/wfcli/commands/info.py

@@ -0,0 +1,46 @@
+"""info 子命令 - 版本和状态信息"""
+
+import sys
+from pathlib import Path
+
+import click
+
+from wfcli import __version__
+from wfcli import config as cfg
+from wfcli.utils.fs import find_workspace_root
+from wfcli.utils.display import print_info, print_success
+
+
+@click.command()
+def info():
+    """显示版本和当前工作状态"""
+    click.echo(f"wfcli v{__version__}")
+    click.echo(f"Python {sys.version.split()[0]}")
+    click.echo(f"配置文件: {cfg.CONFIG_FILE}")
+
+    if cfg.CONFIG_FILE.exists():
+        print_success("配置文件已就绪")
+    else:
+        print_info("配置文件不存在，将使用默认配置")
+
+    # 当前工作空间
+    ws_root = find_workspace_root()
+    if ws_root:
+        print_info(f"当前工作空间: {ws_root.name} ({ws_root})")
+    else:
+        print_info("当前不在任何工作空间中")
+
+    # lark-cli 检测
+    import subprocess
+    try:
+        result = subprocess.run(
+            ["lark-cli", "--version"],
+            capture_output=True, text=True, timeout=5,
+        )
+        if result.returncode == 0:
+            ver = result.stdout.strip().split("\n")[0]
+            print_info(f"lark-cli: {ver}")
+        else:
+            print_info("lark-cli: 未检测到")
+    except (FileNotFoundError, subprocess.TimeoutExpired):
+        print_info("lark-cli: 未安装或不可用")