GitHub Sentinel

GitHub Sentinel 是一个开源的工具 AI 代理，专为开发人员和项目经理设计。它会定期（每日/每周）自动从订阅的 GitHub 仓库中检索和汇总更新。主要功能包括订阅管理、更新检索、通知系统和报告生成。

功能

订阅管理
更新检索
通知系统
报告生成

快速开始

1. 安装依赖

首先，安装所需的依赖项：

pip install -r requirements.txt

2. 配置应用

编辑 config.json 文件，以设置您的 GitHub Token、Email 设置（以腾讯企微邮箱为例）、订阅文件和更新设置：

{
    "github_token": "your_github_token",
    "email":  {
        "smtp_server": "smtp.exmail.qq.com",
        "smtp_port": 465,
        "from": "from_email@example.com",
        "password": "your_email_password",
        "to": "to_email@example.com"
    },
    "slack_webhook_url": "your_slack_webhook_url",
    "subscriptions_file": "subscriptions.json",
    "github_progress_frequency_days": 1,
    "github_progress_execution_time":"08:00"
}

出于安全考虑: GitHub Token 和 Email Password 的设置均支持使用环境变量进行配置，以避免明文配置重要信息，如下所示：

# Github
export GITHUB_TOKEN="github_pat_xxx"
# Email
export EMAIL_PASSWORD="password"

3. 如何运行

GitHub Sentinel 支持以下三种运行方式：

A. 作为命令行工具运行

您可以从命令行交互式地运行该应用：

python src/command_tool.py

在此模式下，您可以手动输入命令来管理订阅、检索更新和生成报告。

B. 作为后台服务运行

要将该应用作为后台服务（守护进程）运行，它将根据相关配置定期自动更新。

您可以直接使用守护进程管理脚本 daemon_control.sh 来启动、查询状态、关闭和重启：

启动服务：
```
$ ./daemon_control.sh start
Starting DaemonProcess...
DaemonProcess started.
```
- 这将启动[./src/daemon_process.py]，按照 config.json 中设置的更新频率和时间点定期生成报告，并发送邮件。
- 本次服务日志将保存到 logs/DaemonProcess.log 文件中。同时，历史累计日志也将同步追加到 logs/app.log 日志文件中。

查询服务状态：

$ ./daemon_control.sh status
DaemonProcess is running.

关闭服务：

$ ./daemon_control.sh stop
Stopping DaemonProcess...
DaemonProcess stopped.

重启服务：

$ ./daemon_control.sh restart
Stopping DaemonProcess...
DaemonProcess stopped.
Starting DaemonProcess...
DaemonProcess started.

C. 作为 Gradio 服务器运行

要使用 Gradio 界面运行应用，允许用户通过 Web 界面与该工具交互：

python src/gradio_server.py

这将在您的机器上启动一个 Web 服务器，允许您通过用户友好的界面管理订阅和生成报告。
默认情况下，Gradio 服务器将可在 http://localhost:7860 访问，但如果需要，您可以公开共享它。

kentsekk/GitHubSentinel