如何使用 Python 检索 Github 存储库数据

来自:互联网
时间:2024-09-30
阅读:

如何使用 Python 检索 Github 存储库数据

您的组织是否拥有太多 github 存储库,并且您需要一种简单的方法来总结和记录每个存储库的内容以用于报告、仪表板或审计目的?下面是一个使用 github api 完成该操作的快速脚本。

功能:

  1. get_repo_info(所有者,回购)

    • 获取 github 存储库所有者的用户名 (owner) 和存储库名称 (repo)。
    • 向 github 的 api 发送请求以获取存储库信息。
    • 如果成功,则以 json 对象的形式返回存储库的信息,如果出现错误,则返回 none。
  2. get_collaborators(collaborators_url):

    • 获取存储库协作者列表的 url。
    • 发送请求以获取协作者列表。
    • 返回协作者用户名列表,如果发生错误则返回空列表。
  3. get_languages(languages_url):

    • 获取存储库语言数据的 url。
    • 发送请求以检索存储库中使用的编程语言。
    • 返回语言列表,如果出现错误,则返回空列表。
  4. get_open_issues(所有者,回购)

    • 获取存储库所有者的用户名 (owner) 和存储库名称 (repo)。
    • 发送请求以检索存储库中未解决问题的列表。
    • 以 json 格式返回未解决的问题,或者如果出现问题则打印错误消息。
  5. get_repo_data(repo_url):

    • 获取存储库 url,解析它以获取所有者和存储库值,然后调用其他函数来收集有关存储库的各种信息。
    • 编译存储库信息,包括其名称、所有者、可见性、协作者、语言、未解决的问题和最后的活动,并以结构化格式(字典)返回。
import json
import requests
from pymongo import MongoClient

# MongoDB setup (replace with your actual connection detAIls)
client = MongoClient("mongodb://localhost:27017/")
db = client["github_repos"]  # Database name
collection = db["repos"]     # Collection name

def get_repo_info(owner, repo):
    url = f"https://api.github.com/repos/{owner}/{repo}"
    headers = {"Accept": "application/vnd.github+json"}
    response = requests.get(url, headers=headers)
    if response.status_code == 200:
        return response.json()
    else:
        print(f"Error: {response.status_code}")
        return None

def get_collaborators(collaborators_url):
    response = requests.get(collaborators_url)
    if response.status_code == 200:
        return [collaborator["login"] for collaborator in response.json()]
    else:
        return []

def get_languages(languages_url):
    response = requests.get(languages_url)
    if response.status_code == 200:
        return list(response.json().keys())
    else:
        return []

def get_open_issues(owner, repo):
    url = f"https://api.github.com/repos/{owner}/{repo}/issues?state=open"
    headers = {"Accept": "application/vnd.github+json"}
    response = requests.get(url, headers=headers)
    if response.status_code == 200:
        return response.json()
    else:
        print(f"Error: {response.status_code}")
        return []

def get_repo_data(repo_url):
    owner, repo = repo_url.split("/")[-2:]
    repo_info = get_repo_info(owner, repo)

    if repo_info:
        data = {
            "Github URL": repo_url,
            "Project name": repo_info["name"],
            "Project owner": repo_info["owner"]["login"],
            "List users with access": get_collaborators(repo_info["collaborators_url"].split("{")[0]),  # remove template part of URL
            "Programming languages used": get_languages(repo_info["languages_url"]),
            "Security/visibility level": repo_info["visibility"],
            "Summary": repo_info["description"],
            "Last maintained": repo_info["pushed_at"],
            "Last release": repo_info["default_branch"],
            "Open issues": get_open_issues(owner, repo),
        }

        # Insert the data into MongoDB
        collection.insert_one(data)
        print("Data inserted into MongoDB successfully.")

        return data
    else:
        return None

# Example usage
repo_url = "https://github.com/URL"
repo_data = get_repo_data(repo_url)

if repo_data:
    print(json.dumps(repo_data, indent=4))

以上就是如何使用 Python 检索 Github 存储库数据的详细内容。

返回顶部
顶部