# coverage

**Repository Path**: kangjiangbo/coverage

## Basic Information

- **Project Name**: coverage
- **Description**: python代码覆盖率监控
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-02-21
- **Last Updated**: 2023-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Python代码覆盖率接入方法

1. 代码覆盖率库安装， 首先执行 pip uninstall cover
   再执行pip install git+https://gitee.com/lilith-bigdata/coverage.git
2. 若应用启动方式为`flask xxx`需修改为`python`启动，python启动的无需进行修改。
3. 应用启动 `python xxx` 修改为 `cover run xxx`, 此时监控服务启动，并启动一个flask服务，提供API查看代码覆盖率数据。
4. 访问 9000:/coverage/start 此时原项目启动。
5. 代码覆盖率监控服务目前可用的API

   ```
   /coverage  GET 主页 展示下面所有API
   /coverage/start GET 启动所监控的应用
   /coverage/eares GET 重置代码覆盖率数据
   /coverage/save GET 保存当前代码覆盖率数据
   /coverage/report GET 保存当前代码覆盖率数据并生成报告
   /coverage/json GET 保存当前代码覆盖率数据并返回json覆盖率报告
   /coverage/static/index.html 查看当前代码覆盖率报告
   ```
相关配置
在所测覆盖率项目根目录添加 .coveragerc文件
```
[run]
branch = True  #是否测试分支
data_file = abc.cov  #覆盖率数据生成的文件名 可指定路径
```

#### 更新历史

- 2021.10 基本功能完成开发，支持在线查看报告
- 2021.11.19 添加程序中断自动保存功能
- 2021.11.24 添加保存json历史报告功能 统一静态目录文件夹
- 2021 12.3 添加历史报告生成功能