> ## Documentation Index
> Fetch the complete documentation index at: https://langchain-zh.cn/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"}}
# Set your environment variables using 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"
# This example also requires an OpenAI API key
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": "You have the software engineering capabilities of a Google Principle engineer. You are tasked with completing issues on a gitlab repository. Please look at the open issues and complete them by creating merge requests that solve the issues."
}
)
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
> Entering new AgentExecutor chain...
I need to look at the open issues and figure out how to solve them.
Action: Get Issues
Action Input: N/A
Observation: Found 1 issues:
[{'title': 'Add tic-tac-toe game', 'number': 15}]
Thought: I need to look at the details of this issue to figure out how to solve it.
Action: Get Issue
Action Input: 15
Observation: {"title": "Add tic-tac-toe game", "body": "Create a tic-tac-toe game using HTML, CSS, and JavaScript. Create a new file called game.html and store the code there.", "comments": "[]"}
Thought: I need to create the game.html file and add the code.
Action: Create File
Action Input: game.html
test contents
Observation: Created file game.html
Thought: I need to add the code to the game.html file.
Action: Update File
Action Input: game.html
OLD <<<<
test contents
>>>> OLD
NEW <<<<
Tic-Tac-Toe
Tic-Tac-Toe
>>>> NEW
Observation: Updated file game.html
Thought: I need to create a merge request to submit my changes.
Action: Create Merge Request
Action Input: Add tic-tac-toe game
added tic-tac-toe game, closes issue #15
Observation: Successfully created MR number 12
Thought: I now know the final answer.
Final Answer: I have created a merge request with number 12 that solves issue 15.
> Finished chain.
```
```text theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
'I have created a merge request with number 12 that solves issue 15.'
```
```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
```
***
[Edit this page on GitHub](https://github.com/langchain-ai/docs/edit/main/src/i18n\zh-CN\oss\python\integrations\tools\gitlab.mdx) or [file an issue](https://github.com/langchain-ai/docs/issues/new/choose).
[Connect these docs](/use-these-docs) to Claude, VSCode, and more via MCP for real-time answers.