Harpoon 开源项目使用教程

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

harpoon/
├── README.md
├── bin/
│   └── harpoon.py
├── config/
│   └── settings.yaml
├── docs/
│   └── usage.md
├── src/
│   ├── core/
│   │   └── main.py
│   └── utils/
│       └── helpers.py
└── tests/
    └── test_main.py

• README.md: 项目介绍文件。
• bin/: 存放可执行文件的目录。
• config/: 存放配置文件的目录。
• docs/: 存放文档文件的目录。
• src/: 源代码目录，包含核心模块和工具模块。
• tests/: 测试代码目录。

2. 项目的启动文件介绍

bin/harpoon.py 是项目的启动文件。它负责初始化项目并调用核心模块中的主要功能。

#!/usr/bin/env python
import sys
from src.core.main import run

if __name__ == "__main__":
    run()

3. 项目的配置文件介绍

config/settings.yaml 是项目的配置文件。它包含了项目运行所需的各种配置参数。

database:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"
  name: "harpoon_db"

logging:
  level: "INFO"
  file: "harpoon.log"

• database: 数据库连接配置。
• logging: 日志配置。

以上是 Harpoon 开源项目的基本使用教程，希望对您有所帮助。