# collect_report

**Repository Path**: zhycarge/collect_report

## Basic Information

- **Project Name**: collect_report
- **Description**: 收集实验报告小工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-15
- **Last Updated**: 2023-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 使用说明书



在此处编写该系统的使用说明书，以下从各个模块对其进行使用展示。

仅测试126邮箱能够正常使用

# 程序配置

**请在使用之前配置好配置文件！**

```ini
# 以下内容为邮箱配置
[email]
# 用户名
email_user = 123@126.com
# 密码
password = 123
# 端口号
smtp_port = 465
# IMAP地址
imap = imap.126.com
# SMTP地址
smtp = smtp.126.com

# 以下内容为系统设置
[setting]
# 报告保存位置(默认是当前目录)
report_download = ./邮件信息/
# 实验报告汇总表保存位置(默认是当前目录)
csv_saved = ./
# 数据库存放位置
database_path = ./report.db
# 日志等级【可选DEBUG、INFO,详情见loguru的level规范】
level = INFO
```

如果将日志等级改为DEBUG，则会自动在当前目录下创建一个`runs.log`的日志文件，会自动存储`loguru`输出的日志信息，并进行保存，具体实现代码为[点我查看](https://gitee.com/zhycarge/collect_report/blob/master/main.py#L425-426)

请将配置文件以及指定的数据库文件以同一目录进行存储，如下所示：

![image-20230625102837180](./assets/image-20230625102837180.png)

便完成该项目的基础配置



# 运行方式

运行方式有如下两种：

- 通过点击exe程序进行运行
- 通过在命令行进行传参运行
  - 如：`./main.exe --runs 0`

为方便使用，推荐选择点击程序运行



# 功能设置

功能设置为如下几种：

```bash
【0】nomal 收取整个实验报告邮件
【1】show_reports 展示数据库中的所有报告信息
【2】change_report 更改数据库中的报告信息（需额外提供参数）
【3】get_info 获取指定报告的收集情况（需额外提供信息）
【4】add_reports 添加报告信息（需额外提供信息）
【5】update 检查程序是否需要更新（需额外提供信息）
【6】delete_report 删除指定报告（需额外提供信息）
```

在使用过程中根据指定需求进行选择前面数字输入即可，以下是详细说明：

## 功能0 收取整个实验报告

### 功能介绍

该功能为项目核心功能，通过之前配置的密钥能够访问整个邮箱，遍历符合要求的邮件，并对邮件信息进行下载，并将报告按照指定要求进行归类

### 使用方法

在配置好文件之后，运行方式直接输入0即可

学生需要将报告按照指定要求打包成zip格式压缩包上传到附件即可，指定要求[点击我下载](https://gitee.com/zhycarge/collect_report/blob/master/assets/%E6%8F%90%E4%BA%A4%E6%8A%A5%E5%91%8A%E6%96%87%E4%BB%B6%E7%A4%BA%E4%BE%8B.zip)



## 功能1 展示数据库中的所有报告信息

### 功能介绍

通过获取数据库信息，能够展示数据库中所有收集中、已收集完成的报告信息

### 使用方法

在配置好文件之后，运行方式直接输入1即可



## 功能2 更改数据库中的报告信息

### 功能介绍

通过输入相关信息，更改报告的收集情况

### 使用方法

在配置好文件之后，运行方式直接输入2，如果未传入指定参数，则需要额外输入具体参数，如报告编号、报告名称、报告收集状态

**请注意：报告编号为一开始创建所设置，无法进行更改，并且在输入信息时若对此项信息不需要更改请保持原本内容进行输入，不要不进行输入**



## 功能3 获取指定报告的收集情况

### 功能介绍

通过输入相关信息，获取整个报告的收集情况

### 使用方法

在配置好文件之后，运行方式直接输入3，如果未传入指定参数，则需要额外输入具体参数，如报告编号

程序会获取所有提交信息并生成csv文件方便进一步操作

*若无人提交报告则会弹出提示信息，并不会生成csv文件*



## 功能4 添加报告信息

### 功能介绍

通过输入相关信息，添加新的报告

### 使用方法

在配置好文件之后，运行方式直接输入4，如果未传入指定参数，则需要额外输入具体参数，如报告编号、报告名称、报告收集状态

程序会根据所填写的信息进行添加收集报告

**请注意：若存在两个一样名字并同时收集的报告，则会在创建过程中进行提醒，请做好区分**



## 功能5 程序更新

### 功能介绍

检查更新程序，不知道会不会有人对程序进一步维护，如果有会自动维护和更新

### 使用方法

在配置好文件之后，运行方式直接输入5



## 功能6 删除指定报告

### 功能介绍

通过输入相关信息，删除指定报告

### 使用方法

在配置好文件之后，运行方式直接输入6，如果未传入指定参数，则需要额外输入具体参数，如报告编号

并进行再次确定(如确定则输入大写或小写的‘y’即可)


**请注意：删除过程无法更改！请确保删除前将已需要存储的信息做好保存，防止数据丢失！！！！**