AutoGPT-Code-Ability

<p align="center"> <img src="https://github.com/Significant-Gravitas/AutoGPT-Code-Ability/assets/50577581/4fefdc1d-4fba-476a-8456-646428cc05ec" alt="机器人编程"/> </p> ## 简介 AutoGPT释放编程力量，惠及所有人：开源AI降低软件创作门槛！ AutoGPT的编码能力是一个由AI驱动的开源编码助手。其目标是让软件开发对所有人更加accessible，不论技能水平或资源如何。通过生成Python代码（一种流行且非常易用的编程语言），AutoGPT充当虚拟副驾驶，帮助用户构建项目，如现有前端的后端或命令行工具。本README提供了该系统及其组件的概述。 ## 目标受众

编程初学者和新手： 包括学生、业余爱好者或任何对学习编程感兴趣但面临入门障碍的人。该产品旨在让编程变得易于接触和负担得起。

科技/编程领域中的弱势群体： 通过培养包容性的开源社区，该产品似乎致力于吸引弱势群体并赋予他们参与的力量。

经验丰富的开发者/工程师： 在降低初学者门槛的同时，该产品还通过提供AI编程助手来提高生产力，为有经验的开发者带来价值。

开源贡献者： 鼓励贡献者加入，共同贡献代码、知识，并协作推动创新。

注重成本的组织/个人： 通过使软件开发更加经济实惠，它可能吸引小型企业、初创公司或寻求低成本构建应用程序的个人。

设置指南

欢迎使用项目初始设置指南。按照以下简单步骤即可完成所有设置。

步骤1：安装依赖

安装包 首先安装所有必要的依赖项。在终端中运行：

poetry install
poetry shell

此命令安装项目所需的所有Python包依赖。

选择Poetry Python解释器 现在确保你使用的是poetry Python解释器：在VSCode中，按下 Ctrl/Cmd + Shift + P 调出"显示并运行命令"视图然后输入：

> Python: Select Interpreter

并选择Poetry Python解释器。

步骤2：配置环境变量

cp .env.example .env 使用你自己的密钥和设置填写变量 GIT_TOKEN=<你的github令牌> VERBOSE_LOGGING=true 只有在你有权限访问Langsmith时，langchain变量才能工作！如果没有，请将LANGCHAIN_TRACING_V2设置为false

LANGCHAIN_PROJECT
LANGCHAIN_TRACING_V2
LANGCHAIN_API_KEY

步骤3：初始化Docker容器

有两种方式运行容器：

如果你只想运行数据库：

docker compose -f docker-compose.yml up

注意输出中打印的端口。例如：listening on IPv4 address "0.0.0.0", port 5432。

然后运行服务器：

./run serve

运行前端提醒：在frontend/文件夹中运行

poetry run streamlit run chat.py

如果你想同时运行数据库和应用：

docker compose -f docker-compose.full.yml up

然后访问localhost:8501使用前端进行聊天和构建代码库。

步骤4：配置和迁移数据库

在新的终端中，复制.env文件模板：

cp .env.example .env

要设置数据库，我们首先通过环境变量配置DATABASE_URL。只需设置你之前记下的数据库端口（例如5432）。然后，趁此机会更新.env文件，填入你的OpenAI密钥和Github令牌。更新完.env文件后，启动Poetry Shell：

poetry shell

现在使用以下命令迁移数据库架构：

prisma migrate dev --name init

这将使用所需的架构初始化你的数据库。

步骤5：生成Prisma客户端

迁移数据库后，生成Prisma客户端以在应用中与数据库交互：

prisma generate

此命令生成或更新Prisma客户端，确保你的应用能够有效地与数据库通信。

步骤6：填充数据库

通过调整特定端口的数据库URL并运行填充脚本，确保数据库填充了初始数据：

./run populate-db

这将用应用所需的初始数据集填充你的数据库。

步骤7：启动应用

将环境设置为本地并启动服务器：

./run serve

这将启动应用的服务器，使其可用于开发使用。

步骤8：访问文档

在以下地址访问运行中应用的交互式文档：

http://127.0.0.1:8000/docs

演示

https://github.com/Significant-Gravitas/AutoGPT-Code-Ability/assets/50577581/264838a3-6f24-4758-974e-f9cba64a4166 在这里，你会找到有关如何与应用程序交互的详细指南和参考资料。

下一步是什么？

现在你的环境已经设置好了，前往交互流程部分，了解应用程序内部的交互工作原理，进一步探索其功能和特性。

组件

该系统是一个先进的软件开发框架，由多个专门的子代理和组件组成。每个组件在软件开发生命周期中都扮演着至关重要的角色，从构思到部署。除了主要的子代理外，该系统还包括基本的支持组件：通用模块和提示模块。

需求（产品负责人）：此组件在理解和定义产品需求方面至关重要。它充当客户需求与技术团队之间的桥梁，确保开发的软件完全符合客户的愿景。
架构师（解决方案架构师）：负责设计应用程序的整体架构。该组件将应用程序分解为可管理的模块，并编写指导开发过程的模板。
开发者：实际编码的组件。利用架构师提供的模板和指南，开发者子代理负责编写应用程序的各个功能和部分。
部署代理：软件开发过程的最后阶段，此组件负责编译、打包和部署完成的应用程序，确保其成功部署到指定环境。
通用模块：在开发的所有阶段都使用的基础组件。它提供共享功能和资源，如设计、架构、编码和交付模块所需的库和工具。该模块确保开发过程的一致性和效率。
提示：该组件与链式模块密切合作，生成和管理与LLM交互的提示。它包含所有提示模板，使我们能够轻松迭代提示设计，而无需修改代码。

以下是说明AutoGPT编码能力结构及其组件之间交互的图表：

erDiagram
CODEX ||--o{ REQUIREMENTS : 包含
CODEX ||--o{ ARCHITECT : 包含
CODEX ||--o{ DEVELOPER : 包含
CODEX ||--o{ DEPLOY : 包含
REQUIREMENTS ||--|| COMMON-MODULE : 使用
ARCHITECT ||--|| COMMON-MODULE : 使用
DEVELOPER ||--|| COMMON-MODULE : 使用
DEPLOY ||--|| COMMON-MODULE : 使用
REQUIREMENTS ||--|| ARCHITECT : "为其定义需求"
ARCHITECT ||--|| DEVELOPER : "为其设计解决方案"
DEVELOPER ||--|| DEPLOY : "为其开发代码"
DEPLOY ||--o{ CODEX : "部署应用程序到"

CODEX {
string 名称
}
REQUIREMENTS {
string 角色 "产品负责人"
}
ARCHITECT {
string 角色 "解决方案架构师"
}
DEVELOPER {
string 角色 "初级开发者"
}
DEPLOY {
string 角色 "构建工程师"
}
COMMON-MODULE {
string 功能
}

交互流程

以下是预期的用户交互工作流程：


sequenceDiagram
actor 用户
participant API as Codex API
participant Codex


用户->>API: 请求一个应用
API->>用户: 返回应用ID
alt 需求开发
用户->>API: 请求应用ID的应用规格
API->>+Codex: 运行需求流程
Codex-->>-用户: 返回应用规格ID
用户->>API: 修改应用规格元素
API->>用户: 返回新的应用规格ID
end

用户->>API: 请求开发应用规格ID
API->>+Codex: 运行架构师和开发流程

Codex->>-用户: 返回已开发的应用ID

用户->>API: 请求部署已开发的应用ID
Note right of API: 当我们添加部署流程时

API->>+Codex: 运行部署流程
Codex-->>-用户: 返回部署详情（id、url等）


用户->>API: 请求已开发应用ID的代码
Note right of API: 在测试阶段

API->>+Codex: 运行打包流程

Codex-->>-用户: 返回Github仓库链接（或如果在本地运行，可以切换为压缩文件）

工作流程

需求分析：设计子代理与客户交互，收集并定义产品需求。
架构设计：架构师子代理根据需求制定解决方案架构，将应用程序分解为更小、可管理的模块，并创建模板。
开发：开发者子代理使用模板和架构指南为应用程序的每个模块编写实际代码。
部署：一旦编码完成，部署子代理接管，负责打包、编译并将应用程序部署到指定环境。

sequenceDiagram
participant 用户
participant 需求
participant 架构师
participant 开发者
participant 部署

用户->>+需求: 请求
需求->>用户: 初步需求
用户->>+需求: 反馈/修正
需求->>+架构师: 完善后的需求
架构师->>+开发者: 架构和模板
loop 开发迭代
开发者->>+架构师: 请求澄清
架构师->>+开发者: 补充细节
end
开发者->>+部署: 完成的代码
部署->>+用户: 部署到生产环境

数据库架构

<p align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/25ddb366-698e-4736-a73c-1383187a5a0b.png" alt="架构的Mermaid图表" style="border-radius: 50px;" width="600"> </p> 该架构围绕几个关键模型展开： - CodeGraph：以图的形式表示代码的逻辑和结构，与函数定义和数据库架构相关联。 - FunctionDefinition：定义单个函数，包括输入/输出类型等详细信息，与特定的CodeGraph相关联。 - CompiledRoute：将CodeGraph转换为可执行路由，是应用程序运行时的重要组成部分。 - Application：聚合实体，将多个CompiledRoute组合成一个完整的应用程序。 - Functions和Package：详细说明应用程序内的可执行元素和依赖项。 - DatabaseSchema和DatabaseTable：管理生成代码中的数据库交互，促进数据驱动的功能。这个架构对于自动化代码生成至关重要，从在CodeGraph中定义逻辑到最终的应用程序组装，提高了我们应用程序的效率和可扩展性。 ```mermaid erDiagram

Application ||--o{ CompiledRoute : "compiledRoutes" CompiledRoute ||--o{ Functions : "functions" CompiledRoute ||--o{ Application : "applications" CompiledRoute }o--|| CodeGraph : "codeGraph" CodeGraph ||--o{ FunctionDefinition : "functionDefs" CodeGraph ||--o{ CompiledRoute : "compiledRoute" CodeGraph }o--|| DatabaseSchema : "databaseSchema" FunctionDefinition }o--|| CodeGraph : "codeGraph" FunctionDefinition }o--|| Functions : "function" Functions ||--o{ FunctionDefinition : "functionDefs" Functions ||--o{ Package : "packages" Functions ||--o{ CompiledRoute : "compiledRoutes" Package ||--o{ Functions : "functions" DatabaseSchema ||--o{ DatabaseTable : "tables" DatabaseSchema ||--o{ CodeGraph : "codeGraphs" DatabaseTable ||--o{ DatabaseSchema : "schemas" DatabaseTable }o--o{ DatabaseTable : "relatedFromTables" DatabaseTable }o--o{ DatabaseTable : "relatedToTables"

Application { int id PK "主键" datetime createdAt "创建日期" string name "应用名称" string description "描述" }

CompiledRoute { int id PK "主键" datetime createdAt "创建日期" string embedding "嵌入（不支持）" string description "描述" string code "代码" int codeGraphId FK "外键到CodeGraph" }

CodeGraph { int id PK "主键" datetime createdAt "创建日期" string function_name "函数名" string api_route "API路由" string graph "图形表示" int databaseSchemaId FK "外键到DatabaseSchema" }

FunctionDefinition { int id PK "主键" datetime createdAt "创建日期" string name "函数名" string description "描述" string input_type "输入类型" string return_type "返回类型" int codeGraphId FK "外键到CodeGraph" string functionId FK "外键到Functions" }

Functions { string id PK "主键" datetime createdAt "创建日期" string embedding "嵌入（不支持）" string name "函数名" string description "描述" string input_type "输入类型" string return_type "返回类型" string code "代码" }

Package { string id PK "主键" datetime createdAt "创建日期" string packageName "包名" string version "版本" string specifier "说明符" }

DatabaseSchema { int id PK "主键" datetime createdAt "创建日期" string embedding "嵌入（不支持）" string description "描述" }

DatabaseTable { int id PK "主键" datetime createdAt "创建日期" string embedding "嵌入（不支持）" string description "描述" string definition "定义" }

## 常用命令
> docker buildx build --platform linux/amd64 -t gcr.io/agpt-dev/mvp/codegen . --push
## Prisma 与 Python：快速设置和使用指南

Prisma 是一个开源数据库工具包，简化了数据库访问和管理。尽管 Prisma 传统上与 JavaScript 和 TypeScript 相关联，但它也可以与 Python 项目集成。README 的这一部分为在 Python 环境中设置 Prisma、应用迁移以及其他有用的提示提供了一个快速参考。

### 1. 设置 Prisma

#### 前提条件：
- 安装 Node.js（用于 Prisma CLI）
- 设置 Python 环境

#### 步骤：
1. **安装 Prisma CLI**：
- 使用 npm 全局安装 Prisma：
```bash
npm install -g prisma

在项目中初始化 Prisma：

导航到 Python 项目目录并初始化 Prisma：

prisma init

此命令会创建一个新的 prisma 目录，其中包含默认的 schema.prisma 文件。

配置数据库：

在 schema.prisma 中，配置 datasource 块以指向您的数据库。例如，对于 PostgreSQL：

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

将 DATABASE_URL 替换为您的数据库连接字符串。

2. 定义数据模型

在 schema.prisma 文件中定义您的数据模型。例如：

model User {
  id    Int     @id @default(autoincrement())
  name  String
  email String  @unique
}

3. 迁移

创建迁移：

定义模型后，创建迁移以更新数据库架构：

prisma migrate dev --name init

此命令会在 prisma/migrations 目录中创建 SQL 文件。

应用迁移：

应用迁移以更新数据库架构：

prisma migrate deploy

将迁移标记为本地已解决（用于热修复）

prisma migrate resolve --applied "<migration-name>"

4. 生成 Prisma 客户端

生成 Prisma 客户端以与数据库交互：

prisma generate

5. 在 Python 中使用 Prisma

由于 Prisma 客户端原生适用于 JavaScript/TypeScript，在 Python 中使用它需要一个变通方法。您可以通过子进程执行 Prisma 客户端。例如：

import subprocess
import json

def run_prisma_command(command):
    result = subprocess.run(["npx", "prisma", *command], capture_output=True)
    return json.loads(result.stdout)

users = run_prisma_command(["query", "user", "--all"])
print(users)