更新README和AGENTS文档

This commit is contained in:
2025-12-29 02:56:50 +08:00
parent 4d2f9302ff
commit bf2ee14332
2 changed files with 89 additions and 29 deletions

View File

@@ -4,11 +4,13 @@
## 功能特性
- 📥 从 Confluence 获取交接班日志 HTML
- 📄 提取保留布局的文本内容
- 🗄️ SQLite3 数据库存储
- 📊 生成日报和月度统计
- 📈 支持未统计数据手动录入
- 从 Confluence 获取交接班日志 HTML
- 提取保留布局的文本内容
- SQLite3 数据库存储
- 生成日报和月度统计
- 支持未统计数据手动录入
- 支持二次靠泊记录合并
- GUI 图形界面(可选)
## 项目结构
@@ -17,6 +19,8 @@ OrbitIn/
├── main.py # CLI 入口
├── README.md # 项目说明
├── AGENTS.md # AI助手开发文档
├── .env # 环境配置(敏感信息)
├── .env.example # 环境配置示例
├── layout_output.txt # 缓存的布局文本
├── debug/ # 调试输出目录
│ └── layout_output_*.txt # 带时间戳的调试文件
@@ -28,7 +32,8 @@ OrbitIn/
├── extractor.py # HTML 文本提取器
├── parser.py # 日志解析器
├── database.py # 数据库操作
── report.py # 报表生成器
── report.py # 报表生成器
└── gui.py # GUI 图形界面
```
## 快速开始
@@ -36,7 +41,7 @@ OrbitIn/
### 安装依赖
```bash
python3 -m pip install requests beautifulsoup4 python-dotenv
pip install requests beautifulsoup4 python-dotenv
```
### 配置 Confluence
@@ -54,8 +59,10 @@ CONFLUENCE_CONTENT_ID=155764524
### 使用方法
#### 命令行方式
```bash
# 默认:获取HTML、提取、解析并保存到数据库
# 默认:获取、提取、解析并保存到数据库
python3 main.py
# 仅获取HTML并提取文本保存到debug目录
@@ -67,7 +74,7 @@ python3 main.py fetch-debug
# 生成日报(指定日期)
python3 main.py report 2025-12-28
# 生成日日报
# 生成日日报
python3 main.py report-today
# 解析测试使用已有的layout_output.txt
@@ -80,6 +87,21 @@ python3 main.py --unaccounted 118 --month 2025-12
python3 main.py --help
```
#### GUI 方式
```bash
python3 src/gui.py
```
GUI 功能:
- 获取并处理数据
- 获取 (Debug模式)
- 生成日报
- 昨日日报(自动获取前一天数据)
- 添加未统计数据
- 数据库统计(显示当月每艘船的作业量)
- 日报内容可复制
## 数据格式
### 日报表 (daily_handover_logs)
@@ -89,7 +111,7 @@ python3 main.py --help
| id | INTEGER | 主键 |
| date | TEXT | 日期 YYYY-MM-DD |
| shift | TEXT | 班次 (白班/夜班) |
| ship_name | TEXT | 船名 |
| ship_name | TEXT | 船名(不含船号前缀) |
| teu | INTEGER | 作业量 TEU |
| efficiency | REAL | 效率 |
| vehicles | INTEGER | 上场车辆数 |
@@ -105,27 +127,33 @@ python3 main.py --help
| note | TEXT | 备注 |
| created_at | TEXT | 创建时间 |
## 文本格式约定
## 特性说明
- 列表前缀:`•` 用于 `ul`,数字+点用于 `ol`
- 粗体使用 `**text**`,斜体使用 `*text*`
- 水平线使用 `─` (U+2500) 字符
- 链接渲染为 `text (url)`
### 二次靠泊合并
解析时会自动合并同一天的二次靠泊记录:
- 夜班 学友洋山: 273TEU
- 夜班 学友洋山(二次靠泊): 14TEU
- 合并后: 夜班 学友洋山: 287TEU
### 未统计数据
可以在数据库统计中查看当月每艘船的作业量总计,便于跟踪船舶运营情况。
## 示例输出
```
日期12/28
船名:246#学友洋山
船名:学友洋山
作业量246TEU
当日实际作业量246TEU
当月计划作业量8400TEU (用天数*300TEU)
当月未统计数据118TEU
当月实际作业量12750TEU
当月完成比例151.79%
当月实际作业量12632TEU
当月完成比例150.38%
12/29 白班人员:
12/29 夜班人员:
@@ -138,6 +166,7 @@ python3 main.py --help
- SQLite3
- Requests (HTTP 客户端)
- HTMLParser (标准库)
- tkinter (GUI可选)
## License