base-teams / read.me.md
airsltd's picture
update
1ca84d9

项目目录结构与说明

本项目包含以下主要目录和文件:

.
├── .gitattributes
├── .gitignore
├── ai_quant_agent.txt
├── cline_code_prompt.txt
├── Dockerfile
├── get_weather_agent.txt
├── push.sh
├── read.me.md
├── README copy.md
├── README.md
├── requirements.txt
├── team_framework/
│   ├── __init__.py
│   ├── api_key_manager.py
│   ├── load_agents.py
│   ├── load_team_config.py
│   ├── load_tools.py
│   ├── supabase_cli.py
│   └── team_quant_rows-20250514.sql
└── teams/
    └── base_team/
        ├── __init__.py
        ├── .env.example
        ├── agent.py
        └── tools/
            ├── __init__.py
            ├── get_current_time.py
            └── get_weather.py

文件和目录说明

  • .gitattributes: Git 属性文件,用于定义文件如何被 Git 处理(例如,行尾符)。
  • .gitignore: Git 忽略文件,列出了不应被 Git 跟踪的文件和目录。
  • ai_quant_agent.txt: 可能是与 AI 量化代理相关的文本文件,可能包含配置或提示信息。
  • cline_code_prompt.txt: 可能是用于代码生成的提示文本文件。
  • Dockerfile: Docker 镜像构建文件,定义了如何构建项目的 Docker 镜像。
  • get_weather_agent.txt: 可能是与获取天气代理相关的文本文件,可能包含配置或提示信息。
  • push.sh: Shell 脚本,可能用于构建和推送 Docker 镜像或代码到仓库。
  • read.me.md: 本文件,提供项目的目录结构和说明。
  • README copy.md, README.md: 项目的根 README 文件,通常包含项目的介绍、安装和使用说明。
  • requirements.txt: Python 依赖文件,列出了项目所需的所有 Python 包。
  • team_framework/: 团队框架的核心代码目录。
    • __init__.py: Python 包的初始化文件。
    • api_key_manager.py: 负责管理 API 密钥的模块。
    • load_agents.py: 负责加载代理配置和实现的模块。
    • load_team_config.py: 负责加载团队配置的模块。
    • load_tools.py: 负责加载工具的模块。
    • supabase_cli.py: 与 Supabase 命令行接口交互相关的模块。
    • team_quant_rows-20250514.sql: SQL 文件,可能包含数据库模式定义或初始数据,日期后缀表示可能是某个时间点的快照或迁移。
  • teams/: 存放不同团队配置和代码的目录。
    • base_team/: 基础团队的配置和代码目录。核心必须包括三个文件:init.py、.env、agent.py
      • __init__.py: Python 包的初始化文件。
      • .env: 环境变量文件,当前团队所需的配置项。
      • .env.example: 环境变量示例文件,说明了运行此团队所需的配置项。
      • agent.py: 基础团队的代理逻辑实现。
      • tools/: (可选)基础团队使用的工具模块目录。【强烈建议选用成熟的MCP、或者自定义开发MCP,并使用MCP进行调用】
        • __init__.py: Python 包的初始化文件。
        • get_current_time.py: 获取当前时间的工具实现。
        • get_weather.py: 获取天气的工具实现。