GitGot 开源项目使用教程

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

GitGot 项目的目录结构如下：

GitGot/
├── Dockerfile
├── LICENSE
├── README.md
├── example_usage.png
├── gitgot-docker.sh
├── gitgot.py
├── logo.png
├── requirements.txt
└── checks/
    └── default_list

目录结构介绍

• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目的许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目的主文档，包含项目介绍、使用方法等。
• example_usage.png: 示例使用截图。
• gitgot-docker.sh: 用于启动 Docker 版本的 GitGot 脚本。
• gitgot.py: 项目的主启动文件。
• logo.png: 项目的 logo 图片。
• requirements.txt: 项目依赖的 Python 包列表。
• checks/: 包含默认的正则表达式列表文件。

2. 项目的启动文件介绍

项目的启动文件是 gitgot.py。该文件是 GitGot 工具的主入口，负责处理用户输入的查询，并与 GitHub 搜索 API 进行交互。

启动文件功能

• 接收用户输入的查询参数。
• 调用 GitHub 搜索 API 进行数据查询。
• 处理用户反馈，更新搜索结果。
• 支持多种查询模式和自定义正则表达式。

3. 项目的配置文件介绍

GitGot 项目没有显式的配置文件，但可以通过以下方式进行配置：

配置 GitHub 访问令牌

在 gitgot.py 文件中设置 GitHub 访问令牌：

ACCESS_TOKEN = "<NO-PERMISSION-GITHUB-TOKEN-HERE>"

或者通过环境变量设置：

export GITHUB_ACCESS_TOKEN="<NO-PERMISSION-GITHUB-TOKEN-HERE>"

自定义正则表达式列表

可以通过命令行参数指定自定义的正则表达式列表文件：

./gitgot.py -q example.com -f checks/default_list

日志文件位置

默认的日志文件位置是 /logs/<query>.log，可以通过命令行参数指定自定义的日志文件位置：

./gitgot.py -q example.com -o example1.log

通过以上配置，用户可以根据自己的需求定制 GitGot 工具的行为。