公司研究助手项目启动与配置教程

1. 项目目录结构及介绍

公司研究助手项目的目录结构如下所示：

company-research-agent/
├── bin/                       # 存放项目启动脚本
├── config/                    # 配置文件目录
│   └── config.json            # 项目配置文件
├── doc/                       # 项目文档目录
├── lib/                       # 存放项目核心代码
│   ├── __init__.py
│   └── research_agent.py      # 研究助手核心逻辑
├── logs/                      # 日志文件目录
├── requirements.txt           # 项目依赖列表
├── scripts/                   # 存放辅助脚本
└── tests/                     # 测试代码目录

• bin/: 包含用于启动项目的脚本。
• config/: 包含项目配置文件。
• doc/: 存放与项目相关的文档。
• lib/: 包含项目的核心代码，research_agent.py 是实现研究助手功能的主体文件。
• logs/: 项目的日志文件存放位置。
• requirements.txt: 列出了项目运行所依赖的Python库。
• scripts/: 存放一些辅助性的脚本文件。
• tests/: 包含对项目代码进行测试的代码。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，通常是一个名为 start.sh 的shell脚本。以下是启动文件的基本内容：

#!/bin/bash

# 进入项目目录
cd "$(dirname "$0")/.."

# 检查环境依赖
python -m pip install -r requirements.txt

# 启动项目
python lib/research_agent.py

该脚本首先会切换到项目的根目录，然后检查项目依赖，并使用Python解释器启动 research_agent.py 文件。

3. 项目的配置文件介绍

项目的配置文件为 config/config.json，该文件包含了项目运行时需要的配置信息。配置文件的内容可能如下：

{
  "api_key": "YOUR_API_KEY_HERE",
  "search_terms": ["公司A", "公司B"],
  "log_level": "INFO"
}

• api_key: 用于API调用的密钥，需要替换为有效的API密钥。
• search_terms: 一个数组，包含了需要研究的目标公司名称。
• log_level: 设置日志的详细程度，常见的有 DEBUG, INFO, WARNING, ERROR, CRITICAL。

请确保在使用项目前正确配置以上信息。