Orbitin/AGENTS.md

AGENTS.md

This file provides guidance to agents when working with code in this repository.

项目概述

Python 工具，用于从 Confluence API 获取 HTML 并提取保留布局的文本。

项目结构

OrbitIn/
├── src/                    # 代码模块目录
│   ├── __init__.py         # 包初始化
│   ├── confluence.py       # Confluence API 客户端
│   ├── extractor.py        # HTML 文本提取器
│   ├── parser.py           # 日志解析器
│   └── database.py         # SQLite3 数据库操作
├── data/                   # 数据目录
│   └── daily_logs.db       # SQLite3 数据库文件
├── fetch_and_process.py    # CLI 入口
├── AGENTS.md               # AI助手文档
└── layout_output.txt       # 缓存的布局文本

核心模块

ConfluenceClient

• fetch_content(content_id, expand) - 获取页面内容
• get_html(content_id) - 获取 HTML 字符串

HTMLTextExtractor

• extract(html) - 从 HTML 提取保留布局的文本
• 使用 html.parser（非 lxml）
• 移除带 ac:name 属性的 Confluence 宏元素
• 表格格式化使用 ljust() 列对齐

HandoverLogParser

• parse(text) - 解析日志文本，返回 ShipLog 列表
• ShipLog 数据类：date, shift, ship_name, teu, efficiency, vehicles

DailyLogsDatabase

• insert(log) - 插入单条记录
• insert_many(logs) - 批量插入
• query_by_date(date) - 按日期查询
• query_by_ship(ship_name) - 按船名查询
• query_all(limit) - 查询所有
• get_stats() - 获取统计信息

DailyReportGenerator

• generate_report(date) - 生成日报
• print_report(date) - 打印日报

文本格式约定

• 列表前缀：• 用于 ul，数字+点用于 ol
• 粗体使用 **text**，斜体使用 *text*
• 水平线使用 ─ (U+2500) 字符
• 链接渲染为 text (url)

命令

# 默认：获取、提取、解析并保存到数据库
python3 main.py

# 仅获取HTML并提取文本（保存到debug目录）
python3 main.py fetch

# 获取并保存带时间戳的debug文件
python3 main.py fetch-debug

# 生成日报
python3 main.py report 2025-12-28

# 解析测试
python3 main.py parse-test

# 添加未统计数据
python3 main.py --unaccounted 118 --month 2025-12