> ## Documentation Index
> Fetch the complete documentation index at: https://cndoc-langchain.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Gitlab 工具包集成
> 使用 LangChain Python 与 Gitlab 工具包集成。
`GitLab` 工具包包含使 LLM 代理能够与 Gitlab 仓库交互的工具。
该工具是 [python-gitlab](https://github.com/python-gitlab/python-gitlab) 库的封装。
## 快速开始
1. 安装 python-gitlab 库
2. 创建 GitLab 个人访问令牌
3. 设置环境变量
4. 使用 `toolkit.get_tools()` 将工具传递给您的代理
以下将详细解释每个步骤。
1. **获取议题** - 从仓库获取议题。
2. **获取议题详情** - 获取特定议题的详细信息。
3. **评论议题** - 在特定议题上发布评论。
4. **创建合并请求** - 从机器人的工作分支创建合并请求到基础分支。
5. **创建文件** - 在仓库中创建新文件。
6. **读取文件** - 从仓库读取文件。
7. **更新文件** - 更新仓库中的文件。
8. **删除文件** - 从仓库中删除文件。
## 设置
### 1. 安装 `python-gitlab` 库
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
pip install -qU python-gitlab langchain-community
```
### 2. 创建 GitLab 个人访问令牌
[按照此处的说明](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html)创建 GitLab 个人访问令牌。确保您的应用具有以下仓库权限：
* read\_api
* read\_repository
* write\_repository
### 3. 设置环境变量
在初始化代理之前，需要设置以下环境变量：
* **GITLAB\_URL** - 托管 GitLab 的 URL。默认为 "[gitlab.com](https://gitlab.com)"。
* **GITLAB\_PERSONAL\_ACCESS\_TOKEN** - 您在上一步创建的个人访问令牌
* **GITLAB\_REPOSITORY** - 您希望机器人操作的 GitLab 仓库名称。必须遵循格式 \{username}/\{repo-name}。
* **GITLAB\_BRANCH** - 机器人将进行提交的分支。默认为 'main'。
* **GITLAB\_BASE\_BRANCH** - 您仓库的基础分支，通常是 'main' 或 'master'。合并请求将基于此分支。默认为 'main'。
## 示例：简单代理
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import os
from langchain.agents import create_agent
from langchain_community.agent_toolkits.gitlab.toolkit import GitLabToolkit
from langchain_community.utilities.gitlab import GitLabAPIWrapper
from langchain_openai import OpenAI
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
# 使用 os.environ 设置环境变量
os.environ["GITLAB_URL"] = "https://gitlab.example.org"
os.environ["GITLAB_PERSONAL_ACCESS_TOKEN"] = ""
os.environ["GITLAB_REPOSITORY"] = "username/repo-name"
os.environ["GITLAB_BRANCH"] = "bot-branch-name"
os.environ["GITLAB_BASE_BRANCH"] = "main"
# 此示例还需要一个 OpenAI API 密钥
os.environ["OPENAI_API_KEY"] = ""
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
llm = OpenAI(temperature=0)
gitlab = GitLabAPIWrapper()
toolkit = GitLabToolkit.from_gitlab_api_wrapper(gitlab)
agent = create_agent(
model=llm,
tools=toolkit.get_tools(),
verbose=True,
)
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
agent.invoke(
{
"input": "你具备谷歌首席工程师的软件工程能力。你的任务是完成 Gitlab 仓库上的议题。请查看开放议题，并通过创建解决议题的合并请求来完成它们。"
}
)
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
> 进入新的 AgentExecutor 链...
我需要查看开放议题并弄清楚如何解决它们。
操作：获取议题
操作输入：N/A
观察：找到 1 个议题：
[{'title': '添加井字棋游戏', 'number': 15}]
思考：我需要查看此议题的详细信息以弄清楚如何解决它。
操作：获取议题详情
操作输入：15
观察：{"title": "添加井字棋游戏", "body": "使用 HTML、CSS 和 JavaScript 创建一个井字棋游戏。创建一个名为 game.html 的新文件并将代码存储在那里。", "comments": "[]"}
思考：我需要创建 game.html 文件并添加代码。
操作：创建文件
操作输入：game.html
测试内容
观察：已创建文件 game.html
思考：我需要将代码添加到 game.html 文件中。
操作：更新文件
操作输入：game.html
旧 <<<<
测试内容
>>>> 旧
新 <<<<
井字棋
井字棋
>>>> 新
观察：已更新文件 game.html
思考：我需要创建一个合并请求来提交我的更改。
操作：创建合并请求
操作输入：添加井字棋游戏
添加了井字棋游戏，关闭议题 #15
观察：成功创建合并请求编号 12
思考：我现在知道最终答案了。
最终答案：我已创建编号为 12 的合并请求，解决了议题 15。
> 链结束。
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
'我已创建编号为 12 的合并请求，解决了议题 15。'
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
```
***
[将这些文档](/use-these-docs)通过 MCP 连接到 Claude、VSCode 等，以获取实时答案。
[在 GitHub 上编辑此页面](https://github.com/langchain-ai/docs/edit/main/src/oss/python/integrations/tools/gitlab.mdx) 或 [提交问题](https://github.com/langchain-ai/docs/issues/new/choose)。