Accessing Issues on GitHub Enterprise using PyGitHub

PyGitHub.md

How to Access Issues on GitHub Enterprise

Setup

1. Install PyGitHub

pip install PyGitHub

You may want to use pip3 instead of pip.

2. Get personal access token

• Log into GitHub Enterprise on your browser
• Open Settings -> Developer settings -> Personal access tokens
• Create a new access token
  • Grant repo scope
  • Treat your access token as your password.

Examples

1. Access your repository

from github import Github
g = Github(base_url="https://{YOUR_HOSTNAME}/api/v3", login_or_token=YOUR_ACCESS_TOKEN)
repo = g.get_repo("{YOUR_ORGANIZATION}/{YOUR_REPO}")

2. Get issues

• Open issues repo.get_issues()
• All issues repo.get_issues(state='all')
• Specific issue repo.get_issue(number=ISSUE_NUMBER)

Print some issue information.

issue = repo.get_issue(number=123)
print(f"{issue.number}, {issue.state}, {issue.title}, {issue.assignee}, {issue.milestone}")

3. Update issue description

issue = repo.get_issue(number=123)
issue.edit(body=NEW_DESCRIPTION)

Reference:

• PyGitHub https://pygithub.readthedocs.io/en/latest/introduction.html
• Issue Examples https://pygithub.readthedocs.io/en/latest/examples/Issue.html
• Issue https://pygithub.readthedocs.io/en/latest/github_objects/Issue.html