Hawkeye 开源项目使用教程

1. 项目目录结构及介绍

hawkeye/
├── bin/
│   └── hawkeye
├── config/
│   ├── config.json
│   └── logging.conf
├── lib/
│   ├── core/
│   └── utils/
├── README.md
└── requirements.txt

目录结构说明

• bin/: 存放可执行文件，如 hawkeye 启动脚本。
• config/: 存放项目的配置文件，如 config.json 和 logging.conf。
• lib/: 存放项目的核心代码和工具类，分为 core/ 和 utils/ 两个子目录。
• README.md: 项目的说明文档。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目启动文件介绍

bin/hawkeye

bin/hawkeye 是项目的启动脚本，负责初始化环境并启动主程序。启动脚本通常包含以下内容：

#!/usr/bin/env python3

import sys
from lib.core.main import run

if __name__ == "__main__":
    sys.exit(run())

启动流程

1. 环境初始化: 脚本首先导入必要的模块和配置。
2. 主程序启动: 调用 lib.core.main 模块中的 run() 函数启动主程序。

3. 项目配置文件介绍

config/config.json

config/config.json 是项目的主要配置文件，包含项目的各项配置参数。示例如下：

{
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "password"
    },
    "logging": {
        "level": "INFO",
        "file": "hawkeye.log"
    }
}

配置项说明

• database: 数据库连接配置，包括主机地址、端口、用户名和密码。
• logging: 日志配置，包括日志级别和日志文件路径。

config/logging.conf

config/logging.conf 是日志配置文件，用于配置日志的输出格式和级别。示例如下：

[loggers]
keys=root

[handlers]
keys=consoleHandler,fileHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=INFO
handlers=consoleHandler,fileHandler

[handler_consoleHandler]
class=StreamHandler
level=INFO
formatter=simpleFormatter
args=(sys.stdout,)

[handler_fileHandler]
class=FileHandler
level=DEBUG
formatter=simpleFormatter
args=('hawkeye.log', 'a')

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
datefmt=

配置项说明

• loggers: 定义日志记录器，如 root。
• handlers: 定义日志处理器，如 consoleHandler 和 fileHandler。
• formatters: 定义日志格式化器，如 simpleFormatter。
• logger_root: 根日志记录器的配置，包括日志级别和处理器。
• handler_consoleHandler: 控制台日志处理器的配置。
• handler_fileHandler: 文件日志处理器的配置。
• formatter_simpleFormatter: 日志格式化器的配置。

通过以上配置，可以灵活地控制项目的日志输出和存储。