Python PoC to interact with Github

[pdabelf5]

Proof of Concept (PoC) in Python to interact with the Github API to pull out PR's & their labels & titles

• Is there an existing pip library (probably)
• How to authenticate (if needed)
• How to output data

[vepatel]

ref: https://github.com/PyGithub/PyGithub

[mohamadaldawamnah]

i have built an application that would request all PR's and output the data in the format as follow :

enhacment [etc],
miscellaneous [etc],
bug_fixing[
"title": "PR #1034",
"number": 1034,
"url": "https://github.com//pull/1034" },]
i wasnt able to request more then 5000 PR due to permessions being denied so i decided to use the md file that exist in the gihub (CHANGELOG.md)

[pdabelf5]

Have working example of printing all open pull requests from an authenticated github session

import os

# Authentication is defined via github.Auth
from github import Auth, Github

# Authentication using personal access token
GITHUB_TOKEN = os.getenv("GITHUB_TOKEN")
if not GITHUB_TOKEN:
    print("Error: GITHUB_TOKEN not set")
    exit(1)

# using an access token
auth = Auth.Token(GITHUB_TOKEN)

nic_repo = "nginx/kubernetes-ingress"

def paginated_list_contains(list, search_string):
    for item in list:
        if search_string in item.full_name:
            return True
    return False

def get_pull_requests(client, repo_name):
    repo = client.get_repo(repo_name)
    pull_requests = repo.get_pulls(state='open', sort='created', base='main')
    return pull_requests

def main():
    client = Github(auth=auth)

    if paginated_list_contains(client.get_user().get_repos(), nic_repo):
        print(f"User has access to {nic_repo}")
    else:
        print(f"User does not have access to {nic_repo}")

    for pr in get_pull_requests(client, nic_repo):
        print(f"Pull request #{pr.number} - {pr.title}")
        print(f"Created by: {pr.user.login}")
        print(f"URL: {pr.html_url}")
        print(f"Created at: {pr.created_at}")
        print(f"Updated at: {pr.updated_at}")
        print(f"State: {pr.state}")
        print(f"Labels: {[label.name for label in pr.labels]}")
        print("-" * 40)

    client.close()


if __name__ == "__main__":
    main()