autotd-buaa 0.1.1__tar.gz

autotd_buaa-0.1.1/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include pyproject.toml
+recursive-include src/auto_td/templates *.json
+recursive-include tests *.py
+exclude config.json
+exclude user_config.jsonl
+exclude td.py
+prune images

autotd_buaa-0.1.1/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: autotd-buaa
+Version: 0.1.1
+Summary: BUAA TD automation command line utility
+Author: autoTD maintainers
+Keywords: buaa,td,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# AutoTD
+
+`autoTD` 是一个可安装的命令行工具包。安装后提供 `autotd` 命令，用于初始化本地配置目录、管理用户和图片、运行 TD 打卡流程、查询服务器返回的本学期锻炼次数，以及以前台进程方式进行定时轮询。
+
+> `autotd user count` 会发送真实 `checkdata` 请求来解析服务器消息中的次数，可能产生服务器侧刷卡/打卡记录。
+
+## 安装与打包
+
+本项目采用标准 `pyproject.toml` 包结构：
+
+```bash
+python3 -m pip install -e .
+autotd --help
+```
+
+构建本地 wheel/sdist：
+
+```bash
+python3 -m build
+```
+
+内部测试发布可使用 TestPyPI：
+
+```bash
+python3 -m twine upload --repository testpypi dist/*
+```
+
+## 初始化
+
+所有运行数据存储在 `~/.autoTD` 下。测试或临时运行时可用 `AUTOTD_HOME` 覆盖：
+
+```bash
+autotd init
+autotd init --from ./autoTD
+```
+
+目录结构：
+
+```text
+~/.autoTD/
+├── config.json
+├── users.json
+├── settings.json
+├── state.json
+├── images/
+└── logs/
+    └── YYYY-MM-DD-daytime-log.txt
+```
+
+## 用户管理
+
+```bash
+autotd user add 22375080 --entrance 2 --exit 6 --entrance-image image3.jpg --exit-image image2.jpg
+autotd user add 22375080 --quick 沙河
+autotd user add 22375080 --quick 学院路
+autotd user list
+autotd user show 22375080
+autotd user update 22375080 --card-id CARDID --entrance 3 --exit 7 --entrance-image image1.jpg --exit-image image2.jpg
+autotd user delete 22375080
+autotd user count 22375080
+```
+
+`card_id` 为空时会自动使用学号的 16 进制大写形式。
+
+使用 `--quick` 时，只需要指定校区：
+
+- `--quick 沙河`: 随机选择沙河入口机 `8/9/10`、沙河出口机 `11/12/13`，并从 `~/.autoTD/images/` 随机选择入口/出口图片。
+- `--quick 学院路`: 随机选择学院路/本部入口机 `2/3/4`、学院路/本部出口机 `5/6/7`，并从 `~/.autoTD/images/` 随机选择入口/出口图片。
+- 其他字段使用默认值：`rounds=3`、`wait_time_min=180`、`wait_time_max=240`、`card_id` 自动生成。
+
+## 图片管理
+
+```bash
+autotd image add ./image3.jpg
+autotd image add ./photo.jpg --name entrance.jpg
+autotd image add ./photo.jpg --name entrance.jpg --overwrite
+autotd image list
+```
+
+图片会复制到 `~/.autoTD/images/`。用户配置中引用的是图片文件名。
+
+## 运行
+
+立即执行一次所有用户：
+
+```bash
+autotd run --once
+```
+
+如果定时开关关闭，`autotd run` 也会立即执行一次。执行时某个用户失败会记录日志并继续后续用户。
+
+## 定时运行
+
+定时运行是前台常驻进程，不创建系统服务。
+
+```bash
+autotd schedule show
+autotd schedule enable
+autotd schedule disable
+autotd schedule set --poll-seconds 60 --windows "07:30-10:00,11:30-14:00,15:30-20:00"
+autotd run
+```
+
+默认时间段为：
+
+- 07:30 - 10:00
+- 11:30 - 14:00
+- 15:30 - 20:00
+
+定时模式按北京时间判断日期。一天只会做一次定时批量尝试；无论成功或失败，当天都不会自动重试。
+
+## 测试
+
+```bash
+python3 -m unittest discover -s tests -v
+```

autotd_buaa-0.1.1/README.md

@@ -0,0 +1,116 @@
+# AutoTD
+
+`autoTD` 是一个可安装的命令行工具包。安装后提供 `autotd` 命令，用于初始化本地配置目录、管理用户和图片、运行 TD 打卡流程、查询服务器返回的本学期锻炼次数，以及以前台进程方式进行定时轮询。
+
+> `autotd user count` 会发送真实 `checkdata` 请求来解析服务器消息中的次数，可能产生服务器侧刷卡/打卡记录。
+
+## 安装与打包
+
+本项目采用标准 `pyproject.toml` 包结构：
+
+```bash
+python3 -m pip install -e .
+autotd --help
+```
+
+构建本地 wheel/sdist：
+
+```bash
+python3 -m build
+```
+
+内部测试发布可使用 TestPyPI：
+
+```bash
+python3 -m twine upload --repository testpypi dist/*
+```
+
+## 初始化
+
+所有运行数据存储在 `~/.autoTD` 下。测试或临时运行时可用 `AUTOTD_HOME` 覆盖：
+
+```bash
+autotd init
+autotd init --from ./autoTD
+```
+
+目录结构：
+
+```text
+~/.autoTD/
+├── config.json
+├── users.json
+├── settings.json
+├── state.json
+├── images/
+└── logs/
+    └── YYYY-MM-DD-daytime-log.txt
+```
+
+## 用户管理
+
+```bash
+autotd user add 22375080 --entrance 2 --exit 6 --entrance-image image3.jpg --exit-image image2.jpg
+autotd user add 22375080 --quick 沙河
+autotd user add 22375080 --quick 学院路
+autotd user list
+autotd user show 22375080
+autotd user update 22375080 --card-id CARDID --entrance 3 --exit 7 --entrance-image image1.jpg --exit-image image2.jpg
+autotd user delete 22375080
+autotd user count 22375080
+```
+
+`card_id` 为空时会自动使用学号的 16 进制大写形式。
+
+使用 `--quick` 时，只需要指定校区：
+
+- `--quick 沙河`: 随机选择沙河入口机 `8/9/10`、沙河出口机 `11/12/13`，并从 `~/.autoTD/images/` 随机选择入口/出口图片。
+- `--quick 学院路`: 随机选择学院路/本部入口机 `2/3/4`、学院路/本部出口机 `5/6/7`，并从 `~/.autoTD/images/` 随机选择入口/出口图片。
+- 其他字段使用默认值：`rounds=3`、`wait_time_min=180`、`wait_time_max=240`、`card_id` 自动生成。
+
+## 图片管理
+
+```bash
+autotd image add ./image3.jpg
+autotd image add ./photo.jpg --name entrance.jpg
+autotd image add ./photo.jpg --name entrance.jpg --overwrite
+autotd image list
+```
+
+图片会复制到 `~/.autoTD/images/`。用户配置中引用的是图片文件名。
+
+## 运行
+
+立即执行一次所有用户：
+
+```bash
+autotd run --once
+```
+
+如果定时开关关闭，`autotd run` 也会立即执行一次。执行时某个用户失败会记录日志并继续后续用户。
+
+## 定时运行
+
+定时运行是前台常驻进程，不创建系统服务。
+
+```bash
+autotd schedule show
+autotd schedule enable
+autotd schedule disable
+autotd schedule set --poll-seconds 60 --windows "07:30-10:00,11:30-14:00,15:30-20:00"
+autotd run
+```
+
+默认时间段为：
+
+- 07:30 - 10:00
+- 11:30 - 14:00
+- 15:30 - 20:00
+
+定时模式按北京时间判断日期。一天只会做一次定时批量尝试；无论成功或失败，当天都不会自动重试。
+
+## 测试
+
+```bash
+python3 -m unittest discover -s tests -v
+```

autotd_buaa-0.1.1/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=77.0.3", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "autotd-buaa"
+version = "0.1.1"
+description = "BUAA TD automation command line utility"
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+  { name = "autoTD maintainers" }
+]
+keywords = ["buaa", "td", "cli"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12"
+]
+
+[project.scripts]
+autotd = "auto_td.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+auto_td = ["templates/*.json"]

autotd_buaa-0.1.1/setup.cfg

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

autotd_buaa-0.1.1/src/auto_td/__init__.py

@@ -0,0 +1,6 @@
+"""autoTD command line package."""
+
+__version__ = "0.1.1"
+
+# Expose submodule for test-time patching and simple interactive imports.
+from . import quick as quick  # noqa: E402,F401

autotd_buaa-0.1.1/src/auto_td/cli.py

@@ -0,0 +1,293 @@
+import argparse
+import json
+from pathlib import Path
+from typing import List, Optional
+
+from .client import TDClient
+from .logging_utils import setup_logging
+from .models import User
+from .quick import build_quick_user
+from .runner import run_all_users
+from .scheduler import run_forever
+from .storage import AppStorage
+
+
+def main(argv: Optional[List[str]] = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+    try:
+        return int(args.func(args) or 0)
+    except Exception as exc:
+        print(f"error: {exc}")
+        return 1
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(prog="autotd")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    init_parser = subparsers.add_parser("init", help="初始化 ~/.autoTD")
+    init_parser.add_argument("--from", dest="source", help="从旧 autoTD 项目导入配置")
+    init_parser.set_defaults(func=cmd_init)
+
+    user_parser = subparsers.add_parser("user", help="用户管理")
+    user_sub = user_parser.add_subparsers(dest="user_command", required=True)
+    user_add = user_sub.add_parser("add", help="新增用户")
+    _add_user_identity_args(user_add)
+    user_add.set_defaults(func=cmd_user_add)
+
+    user_sub.add_parser("list", help="列出用户").set_defaults(func=cmd_user_list)
+    user_show = user_sub.add_parser("show", help="查看用户")
+    user_show.add_argument("student_id")
+    user_show.set_defaults(func=cmd_user_show)
+
+    user_update = user_sub.add_parser("update", help="修改用户")
+    user_update.add_argument("student_id")
+    user_update.add_argument("--card-id")
+    user_update.add_argument("--entrance", type=int)
+    user_update.add_argument("--exit", type=int)
+    user_update.add_argument("--entrance-image")
+    user_update.add_argument("--exit-image")
+    user_update.add_argument("--rounds", type=int)
+    user_update.add_argument("--wait-time-min", type=int)
+    user_update.add_argument("--wait-time-max", type=int)
+    user_update.set_defaults(func=cmd_user_update)
+
+    user_delete = user_sub.add_parser("delete", help="删除用户")
+    user_delete.add_argument("student_id")
+    user_delete.set_defaults(func=cmd_user_delete)
+
+    user_count = user_sub.add_parser(
+        "count",
+        help="发送真实 checkdata 请求并解析服务器返回的本学期锻炼次数；可能产生服务器侧刷卡记录",
+    )
+    user_count.add_argument("student_id")
+    user_count.set_defaults(func=cmd_user_count)
+
+    image_parser = subparsers.add_parser("image", help="图片管理")
+    image_sub = image_parser.add_subparsers(dest="image_command", required=True)
+    image_add = image_sub.add_parser("add", help="新增图片")
+    image_add.add_argument("path")
+    image_add.add_argument("--name")
+    image_add.add_argument("--overwrite", action="store_true")
+    image_add.set_defaults(func=cmd_image_add)
+    image_sub.add_parser("list", help="列出图片").set_defaults(func=cmd_image_list)
+
+    run_parser = subparsers.add_parser("run", help="运行打卡")
+    run_parser.add_argument("--once", action="store_true", help="强制立即运行一次")
+    run_parser.set_defaults(func=cmd_run)
+
+    schedule_parser = subparsers.add_parser("schedule", help="定时配置")
+    schedule_sub = schedule_parser.add_subparsers(dest="schedule_command", required=True)
+    schedule_sub.add_parser("show", help="查看定时配置").set_defaults(func=cmd_schedule_show)
+    schedule_sub.add_parser("enable", help="启用定时").set_defaults(func=cmd_schedule_enable)
+    schedule_sub.add_parser("disable", help="关闭定时").set_defaults(func=cmd_schedule_disable)
+    schedule_set = schedule_sub.add_parser("set", help="设置定时参数")
+    schedule_set.add_argument("--poll-seconds", type=int)
+    schedule_set.add_argument("--windows")
+    schedule_set.set_defaults(func=cmd_schedule_set)
+    return parser
+
+
+def cmd_init(args) -> int:
+    storage = AppStorage()
+    storage.initialize(Path(args.source) if args.source else None)
+    print(f"initialized {storage.home}")
+    return 0
+
+
+def cmd_user_add(args) -> int:
+    storage = _storage()
+    if args.quick:
+        user = build_quick_user(storage, args.student_id, args.quick, card_id=args.card_id or "")
+    else:
+        _require_manual_user_args(args)
+        user = User.from_dict(_user_args_to_dict(args))
+    storage.save_user(user)
+    print(f"added {user.student_id}")
+    return 0
+
+
+def cmd_user_list(_args) -> int:
+    storage = _storage()
+    users = storage.list_users()
+    if not users:
+        print("no users")
+        return 0
+    for user in users:
+        print(f"{user.student_id}\tcard={user.card_id}\tentrance={user.entrance_machine_id}\texit={user.exit_machine_id}")
+    return 0
+
+
+def cmd_user_show(args) -> int:
+    storage = _storage()
+    user = storage.get_user(args.student_id)
+    if user is None:
+        raise KeyError(f"用户不存在: {args.student_id}")
+    print(json.dumps(user, ensure_ascii=False, indent=2))
+    return 0
+
+
+def cmd_user_update(args) -> int:
+    storage = _storage()
+    current = storage.get_user(args.student_id)
+    if current is None:
+        raise KeyError(f"用户不存在: {args.student_id}")
+    updates = {
+        "card_id": args.card_id,
+        "entrance_machine_id": args.entrance,
+        "exit_machine_id": args.exit,
+        "entrance_image": args.entrance_image,
+        "exit_image": args.exit_image,
+        "rounds": args.rounds,
+        "wait_time_min": args.wait_time_min,
+        "wait_time_max": args.wait_time_max,
+    }
+    for key, value in updates.items():
+        if value is not None:
+            current[key] = value
+    user = User.from_dict(current)
+    storage.save_user(user)
+    print(f"updated {user.student_id}")
+    return 0
+
+
+def cmd_user_delete(args) -> int:
+    storage = _storage()
+    if not storage.delete_user(args.student_id):
+        raise KeyError(f"用户不存在: {args.student_id}")
+    print(f"deleted {args.student_id}")
+    return 0
+
+
+def cmd_user_count(args) -> int:
+    storage = _storage()
+    user = storage.get_user_model(args.student_id)
+    client = TDClient(storage.load_config())
+    count = client.query_count(user, machine_id=user.entrance_machine_id)
+    storage.set_last_count(user.student_id, count)
+    print(f"{user.student_id}: 本学期锻炼次数 {count}")
+    return 0
+
+
+def cmd_image_add(args) -> int:
+    storage = _storage()
+    name = storage.add_image(Path(args.path), name=args.name, overwrite=args.overwrite)
+    print(f"added image {name}")
+    return 0
+
+
+def cmd_image_list(_args) -> int:
+    storage = _storage()
+    for name in storage.list_images():
+        print(name)
+    return 0
+
+
+def cmd_run(args) -> int:
+    storage = _storage()
+    logger = setup_logging(storage)
+
+    def run_once():
+        result = run_all_users(storage, logger=logger)
+        print_summary(result)
+        return result
+
+    if args.once or not storage.load_settings().get("schedule", {}).get("enabled", False):
+        run_once()
+    else:
+        run_forever(storage, run_once)
+    return 0
+
+
+def cmd_schedule_show(_args) -> int:
+    storage = _storage()
+    print(json.dumps(storage.load_settings().get("schedule", {}), ensure_ascii=False, indent=2))
+    return 0
+
+
+def cmd_schedule_enable(_args) -> int:
+    storage = _storage()
+    storage.update_settings({"schedule": {"enabled": True}})
+    print("schedule enabled")
+    return 0
+
+
+def cmd_schedule_disable(_args) -> int:
+    storage = _storage()
+    storage.update_settings({"schedule": {"enabled": False}})
+    print("schedule disabled")
+    return 0
+
+
+def cmd_schedule_set(args) -> int:
+    storage = _storage()
+    patch = {"schedule": {}}
+    if args.poll_seconds is not None:
+        if args.poll_seconds <= 0:
+            raise ValueError("poll-seconds 必须大于 0")
+        patch["schedule"]["poll_seconds"] = args.poll_seconds
+    if args.windows:
+        patch["schedule"]["windows"] = [item.strip() for item in args.windows.split(",") if item.strip()]
+    storage.update_settings(patch)
+    print("schedule updated")
+    return 0
+
+
+def print_summary(result) -> None:
+    print(f"total={result.total} success={result.success_count} failure={result.failure_count}")
+    for item in result.results:
+        status = "success" if item.success else "failure"
+        print(f"{item.index}. {item.student_id}: {status} {item.message}")
+
+
+def _storage() -> AppStorage:
+    storage = AppStorage()
+    if not storage.home.exists():
+        raise FileNotFoundError(f"配置目录不存在，请先运行 autotd init: {storage.home}")
+    return storage
+
+
+def _add_user_identity_args(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument("student_id")
+    parser.add_argument("--card-id")
+    parser.add_argument("--quick", help="快速配置校区：沙河 或 学院路")
+    parser.add_argument("--entrance", type=int)
+    parser.add_argument("--exit", type=int)
+    parser.add_argument("--entrance-image")
+    parser.add_argument("--exit-image")
+    parser.add_argument("--rounds", type=int, default=3)
+    parser.add_argument("--wait-time-min", type=int, default=180)
+    parser.add_argument("--wait-time-max", type=int, default=240)
+
+
+def _user_args_to_dict(args) -> dict:
+    return {
+        "student_id": args.student_id,
+        "card_id": args.card_id or "",
+        "entrance_machine_id": args.entrance,
+        "exit_machine_id": args.exit,
+        "entrance_image": args.entrance_image,
+        "exit_image": args.exit_image,
+        "rounds": args.rounds,
+        "wait_time_min": args.wait_time_min,
+        "wait_time_max": args.wait_time_max,
+    }
+
+
+def _require_manual_user_args(args) -> None:
+    missing = []
+    for attr, flag in (
+        ("entrance", "--entrance"),
+        ("exit", "--exit"),
+        ("entrance_image", "--entrance-image"),
+        ("exit_image", "--exit-image"),
+    ):
+        if getattr(args, attr) is None:
+            missing.append(flag)
+    if missing:
+        raise ValueError("非 quick 添加用户时必须提供: " + ", ".join(missing))
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())