langchain/docs/extras/integrations/toolkits/github.ipynb

GitHub

This notebook goes over how to use the GitHub tool. The GitHub tool allows agents to interact with a given GitHub repository. It implements CRUD operations for modifying files and can read/comment on Issues. The tool wraps the PyGitHub library.

In order to interact with the GitHub API you must create a GitHub app. Next, you must set the following environment variables:

GITHUB_APP_ID
GITHUB_APP_PRIVATE_KEY
GITHUB_REPOSITORY
GITHUB_BRANCH

In [ ]:

%pip install pygithub

In [2]:

import os
from langchain.agents import AgentType
from langchain.agents import initialize_agent
from langchain.agents.agent_toolkits.github.toolkit import GitHubToolkit
from langchain.llms import OpenAI
from langchain.utilities.github import GitHubAPIWrapper

In [3]:

os.environ["GITHUB_APP_ID"] = "your-github-app-id"
os.environ["GITHUB_APP_PRIVATE_KEY"] = "/path/to/your/private/key"
os.environ["GITHUB_REPOSITORY"] = "user/repo"
os.environ["GITHUB_BRANCH"] = "branch-name"
os.environ["OPENAI_API_KEY"] = "your-openai-api-key"

In [4]:

llm = OpenAI(temperature=0)
github = GitHubAPIWrapper()
toolkit = GitHubToolkit.from_github_api_wrapper(github)
agent = initialize_agent(
    toolkit.get_tools(), llm, agent=AgentType.ZERO_SHOT_REACT_DESCRIPTION, verbose=True
)

In [5]:

agent.run(
    "You have the software engineering capabilities of a Google Principle engineer. You are tasked with completing issues on a github repository. Please look at the existing issues and complete them."
)

Out [5]:

> Entering new AgentExecutor chain...
 I need to figure out what issues need to be completed and how to complete them.
Action: Get Issues
Action Input: N/A
Observation: Found 1 issues:
[{'title': 'Change the main script to print Hello AI!', 'number': 1}]
Thought: I need to get more information about this issue.
Action: Get Issue
Action Input: 1
Observation: {'title': 'Change the main script to print Hello AI!', 'body': None, 'comments': '[]'}
Thought: I need to update the main script to print Hello AI!
Action: Update File
Action Input: main.py
OLD <<<<
print("Hello World!")
>>>> OLD
NEW <<<<
print("Hello AI!")
>>>> NEW
Observation: File content was not updated because the old content was not found. It may be helpful to use the read_file action to get the current file contents.
Thought: I need to read the current file contents.
Action: Read File
Action Input: main.py
Observation: print("Hello world!")

Thought: I need to update the main script to print Hello AI!
Action: Update File
Action Input: main.py
OLD <<<<
print("Hello world!")
>>>> OLD
NEW <<<<
print("Hello AI!")
>>>> NEW
Observation: Updated file main.py
Thought: I now know the final answer
Final Answer: The main script has been updated to print "Hello AI!"

> Finished chain.

'The main script has been updated to print "Hello AI!"'