Skip to main content
Open In ColabOpen on GitHub

GitHub

本笔记本展示了如何加载GitHub上给定存储库的问题和拉取请求（PR）。还展示了如何加载GitHub上给定存储库的 GitHub 文件。我们将以 LangChain Python 存储库为例。

设置访问令牌​

要访问 GitHub API，您需要一个个人访问令牌 - 您可以在此处设置您的令牌：https://github.com/settings/tokens?type=beta。您可以将此令牌设置为环境变量 GITHUB_PERSONAL_ACCESS_TOKEN，它将自动被加载；或者您可以在初始化时直接将其作为名为 access_token 的参数传入。

# If you haven't set your access token as an environment variable, pass it in here.
from getpass import getpass

ACCESS_TOKEN = getpass()

加载问题和拉取请求​

from langchain_community.document_loaders import GitHubIssuesLoader
API 参考：GitHubIssuesLoader
loader = GitHubIssuesLoader(
    repo="langchain-ai/langchain",
    access_token=ACCESS_TOKEN,  # delete/comment out this argument if you've set the access token as an env var.
    creator="UmerHA",
)

让我们加载由"UmerHA"创建的所有问题和拉取请求。

以下是您可以使用的所有筛选器列表：

  • include_prs
  • 里程碑
  • 状态
  • 受让人
  • 创建者
  • 提及
  • 标签
  • 排序
  • 方向
  • 自从

更多信息，请参阅 https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28#list-repository-issues。

docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)

仅加载问题​

默认情况下，GitHub API 会将拉取请求也视为问题。若仅获取“纯粹”的问题（即不包含拉取请求），请使用 include_prs=False

loader = GitHubIssuesLoader(
    repo="langchain-ai/langchain",
    access_token=ACCESS_TOKEN,  # delete/comment out this argument if you've set the access token as an env var.
    creator="UmerHA",
    include_prs=False,
)
docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)

加载 Github 文件内容

对于以下代码，加载仓库 langchain-ai/langchain 中的所有 markdown 文件

from langchain_community.document_loaders import GithubFileLoader
API 参考：GithubFileLoader
loader = GithubFileLoader(
    repo="langchain-ai/langchain",  # the repo name
    branch="master",  # the branch name
    access_token=ACCESS_TOKEN,
    github_api_url="https://api.github.com",
    file_filter=lambda file_path: file_path.endswith(
        ".md"
    ),  # load all markdowns files.
)
documents = loader.load()

某文档的示例输出：

document.metadata: 
    {
      "path": "README.md",
      "sha": "82f1c4ea88ecf8d2dfsfx06a700e84be4",
      "source": "https://github.com/langchain-ai/langchain/blob/master/README.md"
    }
document.content:
    mock content