Codespeed 技术文档

1. 安装指南

Codespeed 是一个用于监控和分析代码性能的 Web 应用程序。在安装 Codespeed 之前，您需要确保您的系统安装了 Python 2.7 或 3.5 以上版本。

安装依赖项和 Codespeed Django 应用：

pip install codespeed

如果您需要版本控制集成，还需要安装以下额外依赖：

• Subversion 需要 python-svn
• Mercurial 需要 mercurial 包以本地克隆仓库
• git 需要 git 包
• 对于 Github，需要 isodate 包，但不需要 git：pip install isodate

注意：对于 git 或 mercurial 仓库，第一次访问更改视图时，Codespeed 将尝试克隆仓库，这可能需要很长时间，请耐心等待。

• 下载最新稳定版本的 Codespeed，从 github.com/tobami/codespeed/tags 解压并使用 python setup.py install 安装。
• 要开始使用，您可以将 sample_project 目录作为 Django 项目的起点，通过编辑 sample_project/settings.py 进行配置。
• 为了简化操作，您可以使用默认的 sqlite 配置，这将数据保存到名为 data.db 的数据库中。
• 通过在根目录输入以下命令创建数据库：

python manage.py migrate

• 创建管理员用户：

python manage.py createsuperuser

• 为了测试目的，您可以启动开发服务器：

python manage.py runserver 8000

安装完成后，您可以通过访问 http://localhost:8000/ 来使用 Codespeed。

注意：在生产环境中，您应该配置一个真实的 Web 服务器，如 Apache 或 nginx（请参阅 Django 文档）。您还应该修改 sample_project/settings.py 并设置 DEBUG = False。

2. 项目的使用说明

要使用 Codespeed，您需要先进行一些配置：

使用提供的测试数据

如果您想测试 Codespeed，可以使用 testdata.json 固件来获得一个可用的数据集。

./manage.py loaddata codespeed/fixtures/testdata.json

从头开始

在您可以保存（并显示）数据之前，您需要先创建一个环境和默认项目。

• 访问 http://localhost:8000/admin/codespeed/environment/ 创建环境。
• 访问 http://localhost:8000/admin/codespeed/project/ 创建项目。

在 "Track changes" 字段上打勾，并根据需要配置版本控制的有关字段。

注意：只有在 "Track changes" 字段勾选的项目中关联的执行文件才会在更改和时间线视图中显示。

注意：Git 和 Mercurial 需要在本地克隆仓库。这意味着您的 sample_project/repos 目录需要由服务器所有。在典型的 Apache 安装中，您需要运行以下命令：

sudo chown www-data:www-data sample_project/repos

3. 项目 API 使用文档

要保存数据，您需要通过 POST 请求发送到 http://localhost:8000/result/add/。

您可以使用 tools/save_single_result.py 脚本作为参考。在保存大量数据时，建议使用 JSON API：

http://localhost:8000/result/add/json/

一个示例脚本位于 tools/save_multiple_results.py。

注意：如果提供的执行文件、基准、项目或修订版本不存在，它们将被自动创建，包括实际结果条目。唯一不会自动创建的模型是环境。环境必须始终存在，否则数据将不会被保存（这就是为什么在之前的 "Codespeed 配置" 部分将其描述为必要步骤的原因）。

4. 项目安装方式

请遵循以下步骤以安装 Codespeed：

1. 使用 pip 安装 Codespeed 及其依赖项。
2. 下载并解压 Codespeed 的稳定版本。
3. 运行 python setup.py install 来安装 Codespeed。
4. 配置 Django 项目，使用 sample_project/settings.py 文件。
5. 创建数据库、管理员用户并启动开发服务器。

完成这些步骤后，您就可以通过浏览器访问 Codespeed 并开始使用了。