bocai-cli 0.1.0__py3-none-any.whl

bocai_cli/commands/report.py

@@ -0,0 +1,93 @@
+from __future__ import annotations
+
+import typer
+
+from bocai_cli.api import ApiFacade
+from bocai_cli.command_utils import command_handler
+from bocai_cli.config import load_config
+from bocai_cli.date_range_validation import validate_optional_date_range
+from bocai_cli.output import print_json
+
+app = typer.Typer(help="report相关命令。", invoke_without_command=True)
+
+
+@app.callback()
+def report_root(ctx: typer.Context) -> None:
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit(code=0)
+
+
+def _build_api() -> ApiFacade:
+    config = load_config()
+    return ApiFacade(
+        base_url=config.base_url,
+        token=config.token,
+        timeout_seconds=config.timeout_seconds,
+    )
+
+
+@app.command("revenue", help="获取营收数据")
+@command_handler
+def revenue(
+    start_date: str | None = typer.Option(
+        None,
+        "--start-date",
+        help="开始日期，格式 YYYY-MM-DD。",
+    ),
+    end_date: str | None = typer.Option(
+        None,
+        "--end-date",
+        help="结束日期，格式 YYYY-MM-DD。",
+    ),
+    center_id: str | None = typer.Option(
+        None,
+        "--center-id",
+        help="门店ID。",
+    ),
+) -> None:
+    validate_optional_date_range(start_date, end_date)
+
+    api = _build_api()
+    data = api.report.get_revenue(
+        start_date=start_date,
+        end_date=end_date,
+        center_id=center_id,
+    )
+    print_json({"status": "ok", "data": data})
+
+
+@app.command("revenue-detail", help="获取营收明细数据")
+@command_handler
+def revenue_detail(
+    detail_type: str = typer.Option(
+        ...,
+        "--type",
+        help="营收明细类型。",
+    ),
+    start_date: str | None = typer.Option(
+        None,
+        "--start-date",
+        help="开始日期，格式 YYYY-MM-DD。",
+    ),
+    end_date: str | None = typer.Option(
+        None,
+        "--end-date",
+        help="结束日期，格式 YYYY-MM-DD。",
+    ),
+    center_id: str | None = typer.Option(
+        None,
+        "--center-id",
+        help="门店ID。",
+    ),
+) -> None:
+    validate_optional_date_range(start_date, end_date)
+
+    api = _build_api()
+    data = api.report.get_revenue_detail(
+        type_=detail_type,
+        start_date=start_date,
+        end_date=end_date,
+        center_id=center_id,
+    )
+    print_json({"status": "ok", "data": data})

bocai_cli/commands/reservation.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+import typer
+
+from bocai_cli.api import ApiFacade
+from bocai_cli.command_utils import command_handler
+from bocai_cli.config import load_config
+from bocai_cli.date_range_validation import validate_date_range
+from bocai_cli.output import print_json
+
+app = typer.Typer(help="预约相关命令。", invoke_without_command=True)
+
+
+@app.callback()
+def reservation_root(ctx: typer.Context) -> None:
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit(code=0)
+
+
+def _build_api() -> ApiFacade:
+    config = load_config()
+    return ApiFacade(
+        base_url=config.base_url,
+        token=config.token,
+        timeout_seconds=config.timeout_seconds,
+    )
+
+
+@app.command("list", help="获取预约记录数据")
+@command_handler
+def list_reservation(
+    start_date: str = typer.Option(
+        ...,
+        "--start-date",
+        help="开始日期，格式 YYYY-MM-DD。",
+    ),
+    end_date: str = typer.Option(
+        ...,
+        "--end-date",
+        help="结束日期，格式 YYYY-MM-DD。",
+    ),
+    page_num: int = typer.Option(
+        ...,
+        "--page-num",
+        min=0,
+        help="页码，必须大于等于 0。",
+    ),
+    page_size: int = typer.Option(
+        ...,
+        "--page-size",
+        min=1,
+        help="每页条数，必须大于等于 1。",
+    ),
+    center_id: str | None = typer.Option(
+        None,
+        "--center-id",
+        help="门店ID。",
+    ),
+) -> None:
+    validate_date_range(start_date, end_date)
+
+    api = _build_api()
+    data = api.reservation.list(
+        start_date=start_date,
+        end_date=end_date,
+        page_num=page_num,
+        page_size=page_size,
+        center_id=center_id,
+    )
+    print_json({"status": "ok", "data": data})

bocai_cli/config.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import os
+import sys
+from dataclasses import asdict, dataclass
+from pathlib import Path
+from typing import Any
+
+import tomli_w
+
+from bocai_cli.errors import ConfigValidationError
+
+try:
+    import tomllib
+except ModuleNotFoundError:  # pragma: no cover
+    import tomli as tomllib  # type: ignore[no-redef]
+
+DEFAULT_CONFIG_PATH = Path.home() / ".config" / "bocai-cli" / "config.toml"
+
+
+@dataclass
+class AppConfig:
+    base_url: str | None = None
+    token: str | None = None
+    timeout_seconds: float = 30.0
+    app_id: str | None = None
+    secret: str | None = None
+    token_url: str | None = None
+    token_backup: str | None = None
+    token_updated_at: str | None = None
+
+
+def get_config_path() -> Path:
+    raw_path = os.getenv("BOCAI_CLI_CONFIG_PATH")
+    if raw_path:
+        return Path(raw_path).expanduser()
+    return DEFAULT_CONFIG_PATH
+
+
+def load_config(path: Path | None = None) -> AppConfig:
+    config_path = path or get_config_path()
+    if not config_path.exists():
+        return AppConfig()
+
+    try:
+        with config_path.open("rb") as f:
+            data = tomllib.load(f)
+    except tomllib.TOMLDecodeError as exc:
+        raise ConfigValidationError(
+            "配置文件格式错误，请检查 TOML 语法。",
+            details={"config_path": str(config_path)},
+        ) from exc
+    except OSError as exc:
+        raise ConfigValidationError(
+            "配置文件读取失败，请检查文件权限或路径。",
+            details={"config_path": str(config_path)},
+        ) from exc
+
+    return AppConfig(
+        base_url=_optional_string(data.get("base_url")),
+        token=_optional_string(data.get("token")),
+        timeout_seconds=_optional_float(data.get("timeout_seconds"), default=30.0),
+        app_id=_optional_string(data.get("app_id")),
+        secret=_optional_string(data.get("secret")),
+        token_url=_optional_string(data.get("token_url")),
+        token_backup=_optional_string(data.get("token_backup")),
+        token_updated_at=_optional_string(data.get("token_updated_at")),
+    )
+
+
+def save_config(config: AppConfig, path: Path | None = None) -> Path:
+    config_path = path or get_config_path()
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+
+    payload = _to_toml_payload(config)
+    with config_path.open("wb") as f:
+        f.write(tomli_w.dumps(payload).encode("utf-8"))
+
+    _enforce_permissions_best_effort(config_path)
+    return config_path
+
+
+def _to_toml_payload(config: AppConfig) -> dict[str, Any]:
+    values = asdict(config)
+    payload: dict[str, Any] = {}
+    for key, value in values.items():
+        if value is None:
+            continue
+        payload[key] = value
+    return payload
+
+
+def _optional_string(raw: Any) -> str | None:
+    if raw is None:
+        return None
+    value = str(raw).strip()
+    return value or None
+
+
+def _optional_float(raw: Any, default: float) -> float:
+    if raw is None:
+        return default
+    try:
+        return float(raw)
+    except (TypeError, ValueError):
+        return default
+
+
+def _enforce_permissions_best_effort(path: Path) -> None:
+    if sys.platform.startswith("win"):
+        return
+
+    try:
+        path.chmod(0o600)
+    except OSError:
+        return

bocai_cli/date_range_validation.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from datetime import date, datetime
+
+from bocai_cli.errors import ConfigValidationError
+
+
+def _parse_date(value: str, *, option_name: str) -> date:
+    try:
+        return datetime.strptime(value, "%Y-%m-%d").date()
+    except ValueError as exc:
+        raise ConfigValidationError(
+            f"--{option_name} 格式必须为 YYYY-MM-DD。",
+            details={"invalid": [option_name]},
+        ) from exc
+
+
+def validate_date_range(start_date: str, end_date: str) -> None:
+    start = _parse_date(start_date, option_name="start-date")
+    end = _parse_date(end_date, option_name="end-date")
+    if start > end:
+        raise ConfigValidationError(
+            "--start-date 不能晚于 --end-date。",
+            details={"start_date": start_date, "end_date": end_date},
+        )
+
+    range_days = (end - start).days + 1
+    if range_days > 31:
+        raise ConfigValidationError(
+            "--start-date 到 --end-date 的时间范围不能超过 31 天。",
+            details={
+                "start_date": start_date,
+                "end_date": end_date,
+                "range_days": range_days,
+            },
+        )
+
+
+def validate_optional_date_range(start_date: str | None, end_date: str | None) -> None:
+    if (start_date is None) != (end_date is None):
+        raise ConfigValidationError("--start-date 和 --end-date 必须同时提供。")
+
+    if start_date is None and end_date is None:
+        return
+
+    assert start_date is not None
+    assert end_date is not None
+    validate_date_range(start_date, end_date)

bocai_cli/errors.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass
+class BocaiCliError(Exception):
+    message: str
+    status_code: int | None = None
+    details: dict[str, Any] = field(default_factory=dict)
+
+    def __str__(self) -> str:
+        return self.message
+
+
+class ConfigValidationError(BocaiCliError):
+    pass
+
+
+class ApiRequestError(BocaiCliError):
+    pass

bocai_cli/main.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+import typer
+
+from bocai_cli.commands.registry import register_commands
+
+app = typer.Typer(no_args_is_help=True, help="菠菜SAAS CLI")
+register_commands(app)
+
+if __name__ == "__main__":
+    app()

bocai_cli/output.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+import json
+from typing import Any
+
+import typer
+
+
+def print_json(payload: dict[str, Any]) -> None:
+    typer.echo(json.dumps(payload, ensure_ascii=False))
+
+
+def print_error(
+    message: str,
+    *,
+    status_code: int | None = None,
+    details: dict[str, Any] | None = None,
+) -> None:
+    error_payload: dict[str, Any] = {
+        "status": "error",
+        "message": message,
+    }
+    if status_code is not None:
+        error_payload["status_code"] = status_code
+    if details:
+        error_payload["details"] = details
+
+    print_json(error_payload)

bocai_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: bocai-cli
+Version: 0.1.0
+Summary: CLI wrapper for SaaS APIs
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: typer>=0.12.3
+Provides-Extra: dev
+Requires-Dist: pytest>=8.2.0; extra == 'dev'
+Requires-Dist: respx>=0.21.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# bocai-cli
+
+使用 Python + Typer 封装 SaaS API 的命令行工具。
+
+## 安装
+
+### 1) 本地路径安装
+
+```bash
+python -m pip install .
+```
+
+### 2) 可编辑安装（开发）
+
+```bash
+python -m pip install -e .
+```
+
+### 3) 私有 Git 安装
+
+```bash
+python -m pip install "git+<repo-url>@<tag-or-commit>"
+```
+
+### 4）使用构建生成的wheel安装
+```bash
+pip install xxx.whl(e.g. bocai_cli-0.1.0-py3-none-any.whl)
+```
+
+## 构建 wheel（私仓分发），同时打包依赖
+
+```bash
+python -m pip wheel . -w dist
+```
+
+构建后会在 `dist/` 目录下生成类似 `bocai_cli-0.1.0-py3-none-any.whl` 的文件。
+
+
+## 构建 wheel（私仓分发），不打包依赖
+
+```bash
+python -m pip wheel . --no-deps -w dist
+```
+
+构建后会在 `dist/` 目录下生成类似 `bocai_cli-0.1.0-py3-none-any.whl` 的文件。
+
+## 安装后验证
+
+```bash
+bocai-cli --help
+bocai-cli auth --help
+bocai-cli report --help
+```
+
+## 配置文件
+### Windows系统
+C:\Users\{用户名}\.config\bocai-cli\config.toml
+### Linux系统
+#### 先读环境变量 BOCAI_CLI_CONFIG_PATH
+#### 没有就读默认路径：~/.config/bocai-cli/config.toml
+/home/{用户名}/.config/bocai-cli\config.toml (非root用户)  
+
+/root/.config/bocai-cli\config.toml (root用户)
+### config.toml配置内容（base_url,app_id,secret按实际替换)
+base_url = "http://10.0.0.227:10086"  
+
+app_id = "test_app_001"  
+
+secret = "test_secret_123456"

bocai_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,29 @@
+bocai_cli/__init__.py,sha256=4t_crzhrLum--oyowUMxtjBTzUtWp7oRTF22ewEvJG4,49
+bocai_cli/client.py,sha256=xjtirUDW9ip3kHAhKaTnaXiqtZaFMqx81Yx5KFQogzs,1754
+bocai_cli/command_utils.py,sha256=JlE_fh_cWRpEnoUamNLrZSEm-GOWy-QdiXHDW3Xgt9c,764
+bocai_cli/config.py,sha256=f5DZ_zd7hkLZfNjzqrdZvg2HVO94hZZJ3GwH4TXVWyI,3254
+bocai_cli/date_range_validation.py,sha256=5mKA3I13-VmdNrHJTz4tpf902tqrwVumS6tWEUvadqM,1584
+bocai_cli/errors.py,sha256=1r9104aIibAmGIIGOBwwggZNPl-PpT-6mZo-wMi5qa0,418
+bocai_cli/main.py,sha256=VjiHlam7LeX9OKbM8H3_Wye_iqcu-XO2n2sMexhUWW8,234
+bocai_cli/output.py,sha256=c-kvmVpuTxY-CEVuRv93nyEGy5Tu-jPGsrfuHKd3F4o,598
+bocai_cli/api/__init__.py,sha256=72HnDON6aRw-hcNCDkeUYvCtcKG_VAiAR82h39kd-dE,588
+bocai_cli/api/auth_client.py,sha256=Oec2H4C1ofQKS9ePFVy-M9nYm7ZBzjuoQmAYy2em0U0,830
+bocai_cli/api/card_client.py,sha256=HqBvpBop9T2phJtglR0Z5RPOeHxaGltRU16LPBit7r0,2294
+bocai_cli/api/checkin_client.py,sha256=H620MXbPtc_06ncVuQgj7ksh2ZkiTUEntxWZeb0J_ts,755
+bocai_cli/api/course_client.py,sha256=dDx-a-SBx2ilUcDudqqh4BTmCUa0oFkjlokj0_l3dCo,2300
+bocai_cli/api/facade.py,sha256=-ok7YPlOnDMAYZJCw5svOjqS6RJANeoi0z6giJGvWPs,1040
+bocai_cli/api/report_client.py,sha256=pQQ71_gIowMH3AX9cVnOd3UZWpgf5gpoNKhkx-2qZCY,1343
+bocai_cli/api/reservation_client.py,sha256=4DmgazRQIPLtuvxNR_p-QUyzexk6NMemtuXz3uX4wDw,763
+bocai_cli/api/transport.py,sha256=BAJWm5dlPpl7lOPaxj2V1ebXlj_VX2ostJMiPn13Ss0,5368
+bocai_cli/commands/__init__.py,sha256=gAOyyeRGRJiAV0sL3in9-ETCvJCDVUIvXbgsGJ3RsEE,374
+bocai_cli/commands/auth.py,sha256=EL9KKZ15Lw9Fa5IEFiEJB4fqcjwlksRCXmGqt6kDCDs,1877
+bocai_cli/commands/card.py,sha256=vzELiduvzmh8zT25qDvwuPMsr6eZNsgwaCcjGMev-ac,7764
+bocai_cli/commands/checkin.py,sha256=Okj76j0BUv1sK-ygTpsprXxeIogqjMbCMUNFSsEQS-A,1789
+bocai_cli/commands/course.py,sha256=72Cor9pwa4DRdKGL0NR9qwij0PWp6T5rtoN4Ld6TQ1M,7810
+bocai_cli/commands/registry.py,sha256=BpKsCkn3cHXgmULGFuksu8MfQZfTAIJePKK0Cg179cA,1230
+bocai_cli/commands/report.py,sha256=_weEShAsRO8PT3LewHQs2-xATMnOgWlpQW-Mxe3FsWM,2381
+bocai_cli/commands/reservation.py,sha256=O7a9o2Obci1RZdlh_2X2i6vqQICwGfahAJOlxRRSZu0,1801
+bocai_cli-0.1.0.dist-info/METADATA,sha256=0ojRQBqUmmqQtsVculD5IL1L5iHd2G8FXuKiqiY33AE,1798
+bocai_cli-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+bocai_cli-0.1.0.dist-info/entry_points.txt,sha256=iaKWpXFc8niVX-4Eimhpzwq3R11pfFxjpZS4RFJLpEU,49
+bocai_cli-0.1.0.dist-info/RECORD,,

bocai_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

bocai_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+bocai-cli = bocai_cli.main:app