我计划为Sphinx文档系统构建一个插件,该插件显示对文档页面做出贡献的人的姓名和Github个人资料链接。
Github在内部拥有此功能。
是否可以通过Github API获取文件贡献者的Github个人资料链接?请注意,提交者的电子邮件是不够的,必须能够将它们映射到Github用户资料链接。还请注意,我不想要所有存储库贡献者 - 只想要个别文件贡献者。
如果这不可能,那么您能提出哪些替代方法(私有API、爬取)来从Github提取此信息?
我计划为Sphinx文档系统构建一个插件,该插件显示对文档页面做出贡献的人的姓名和Github个人资料链接。
Github在内部拥有此功能。
是否可以通过Github API获取文件贡献者的Github个人资料链接?请注意,提交者的电子邮件是不够的,必须能够将它们映射到Github用户资料链接。还请注意,我不想要所有存储库贡献者 - 只想要个别文件贡献者。
如果这不可能,那么您能提出哪些替代方法(私有API、爬取)来从Github提取此信息?
首先,您可以显示给定文件的提交记录:
https://api.github.com/repos/:owner/:repo/commits?path=PATH_TO_FILE
https://api.github.com/repos/git/git/commits?path=README
其次,在作者部分,JSON响应中包含一个名为'html_url
'的url字段,指向GitHub个人资料页面:"author": {
"login": "gitster",
"id": 54884,
"avatar_url": "https://0.gravatar.com/avatar/750680c9dcc7d0be3ca83464a0da49d8?d=https%3A%2F%2Fidenticons.github.com%2Ff8e73a1fe6b3a5565851969c2cb234a7.png",
"gravatar_id": "750680c9dcc7d0be3ca83464a0da49d8",
"url": "https://api.github.com/users/gitster",
"html_url": "https://github.com/gitster", <==========
"followers_url": "https://api.github.com/users/gitster/followers",
"following_url": "https://api.github.com/users/gitster/following{/other_user}",
"gists_url": "https://api.github.com/users/gitster/gists{/gist_id}",
"starred_url": "https://api.github.com/users/gitster/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/gitster/subscriptions",
"organizations_url": "https://api.github.com/users/gitster/orgs",
"repos_url": "https://api.github.com/users/gitster/repos",
"events_url": "https://api.github.com/users/gitster/events{/privacy}",
"received_events_url": "https://api.github.com/users/gitster/received_events",
"type": "User"
},
因此,您不需要在此处爬取任何网页。
这是一个非常简陋的jsfiddle示例,用于说明基于JavaScript提取:
var url = "https://api.github.com/repos/git/git/commits?path=" + filename
$.getJSON(url, function(data) {
var twitterList = $("<ul />");
$.each(data, function(index, item) {
if(item.author) {
$("<li />", {
"text": item.author.html_url
}).appendTo(twitterList);
}
});
{
repository(owner: "torvalds", name: "linux") {
object(expression: "master") {
... on Commit {
history(first: 100, path: "MAINTAINERS") {
nodes {
author {
email
name
user {
email
name
avatarUrl
login
url
}
}
}
}
}
}
}
}
TOKEN=<YOUR_TOKEN>
OWNER=torvalds
REPO=linux
BRANCH=master
FILEPATH=MAINTAINERS
curl -s -H "Authorization: token $TOKEN" \
-H "Content-Type:application/json" \
-d '{
"query": "{repository(owner: \"'"$OWNER"'\", name: \"'"$REPO"'\") {object(expression: \"'"$BRANCH"'\") { ... on Commit { history(first: 100, path: \"'"$FILEPATH"'\") { nodes { author { email name user { email name avatarUrl login url}}}}}}}}"
}' https://api.github.com/graphql | \
jq '[.data.repository.object.history.nodes[].author| {name,email}]|unique'
git log
命令:
git log --format=format:%an path/to/file ver1..ver2 |sort |uniq
.mailmap
)来将电子邮件映射到GitHub用户并不难。 - plaes除非必须直接与GITHUB API交互,否则可以通过克隆存储库并进入克隆目录,然后使用shortlog命令从github日志文件中获取列表来获取贡献者列表。
import os
import commands
cmd = "git shortlog -s -n"
os.chdir("C:\Users\DhruvOhri\Documents\COMP 6411\pygithub3-0.3")
os.system("git clone https://github.com/poise/python.git")
os.chdir("/home/d/d_ohri/Desktop/python")
output = commands.getoutput(cmd)
print(output)
raw_input("press enter to continue")
如果想要使用GITHUB API列出贡献者,还有一种方法,我们可以使用pytgithub3包装器与GITHUB API进行交互,并使用list_contributors获取贡献者列表,如下所示:
from pytgithub3.services.repo import Repo
r = Repo()
r.lis_contributors(user='userid/author',repo='repo name')
for page in r:
for result in page:
print result