Django-Jenkins 项目技术文档

1. 安装指南

从 PyPI 安装

pip install django-jenkins

通过下载源码安装

python setup.py install

使用最新 Git 版本

pip install -e git+git://github.com/kmmbvnr/django-jenkins.git#egg=django-jenkins
pip install coverage

对于 Python 3 用户，该库开箱即用。

2. 项目使用说明

将 django_jenkins 添加到你的 INSTALLED_APPS 列表中。

在 Jenkins 中配置运行以下命令：

./manage.py jenkins --enable-coverage

这将创建一个包含 JUnit XML、Coverage 和 Pylint 报告的 reports/ 目录。

更多细节，请参阅通用教程。

3. 项目API使用文档

以下是与 django-jenkins 相关的设置和任务：

设置

• PROJECT_APPS

  如果存在，应为一个列表/元组，包含 Jenkins 要运行的 Django 应用。测试、报告和覆盖率仅为此列表中的应用生成。

• JENKINS_TASKS

  ./manage.py jenkins 命令执行的 Jenkins 报告者列表。

  默认值：

  JENKINS_TASKS = ()
  

• JENKINS_TEST_RUNNER

  用于启动 jenkins 命令的测试套件的类的名称。该类应继承自 django_jenkins.runner.CITestSuiteRunner。

报告者

以下是预构建的与 django-jenkins 相关的报告者：

• django_jenkins.tasks.run_pylint

  在选定的 Django 应用上运行 Pylint。

  特定于任务的设置：PYLINT_RCFILE

• django_jenkins.tasks.run_pep8

  在选定的 Django 应用上运行 pep8 工具。为 Jenkins 创建 Pylint 兼容报告。

  你需要安装 pep8 python 包（版本 >=1.3）来运行此任务。

  特定于任务的设置：PEP8_RCFILE

• django_jenkins.tasks.run_pyflakes

  在选定的 Django 应用上运行 Pyflakes 工具。为 Jenkins 创建 Pylint 兼容报告。

  你需要安装 Pyflakes python 包来运行此任务。

• django_jenkins.tasks.run_flake8

  在选定的 Django 应用上运行 flake8 工具。为 Jenkins 创建 pep8 兼容报告。

  你需要安装 flake8 python 包来运行此任务。

4. 项目安装方式

请参考上述安装指南部分。