JCCI项目使用教程

1. 项目的目录结构及介绍

JCCI项目是一个用于分析Java代码提交影响的工具，其目录结构如下：

• src/: 源代码目录，包含了项目的所有Python源文件。
  • jcci/: JCCI库的主要代码，包括分析器和相关工具。
• .github/: 存放GitHub特定文件的目录，例如工作流文件等。
• images/: 存放项目相关图像文件的目录。
• LICENSE: Apache-2.0 许可证文件。
• README.en.md: 项目的英文说明文档。
• README.md: 项目的中文说明文档。
• README.pypi.md: 项目在PyPI上的说明文档。
• jcci-result.html: 用来展示分析结果的HTML文件。
• pyproject.toml: 包含项目信息和依赖的配置文件。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

项目的主要启动和配置是通过Python脚本实现的。以下是主要的启动文件及其作用：

• jcci.py: JCCI库的主模块文件，包含了JCCI类的定义，用于执行代码分析任务。
• analyze.py: 包含了执行代码分析的核心方法，如analyze_two_commit等。
• config.py: 项目配置文件，可能包含一些默认设置和参数。

在具体使用时，用户需要根据需要创建一个新的Python文件，并在该文件中引入JCCI模块的相关类和方法。

例如：

from path.to.jcci.src.jcci.analyze import JCCI

# 配置并启动分析
commit_analyze = JCCI('[e-mail]', 'username1')
commit_analyze.analyze_two_commit('master', 'commit_id1', 'commit_id2')

3. 项目的配置文件介绍

项目的配置文件主要包括：

• pyproject.toml: 这个文件包含了项目的基本信息和依赖管理。例如，指定了项目名称、版本、作者、依赖的Python包等信息。

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[tool.setuptools]
packages = find:
python-requires = ">=3.9"

• requirements.txt: 列出了项目运行所需的Python包依赖，例如：

javalang
unidiff

用户在使用前需要确保已经安装了所有依赖项。如果尚未安装，可以使用以下命令安装：

pip install -r requirements.txt

通过以上介绍，用户可以对JCCI项目的基本结构和使用有一个初步的了解。在具体使用时，建议用户详细阅读项目的README.md文件，以获取更全面和详细的使用指南。