Python Package PyGithub: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 30: Line 30:
=Programming Model=
=Programming Model=
==Repository==
==Repository==
{{External|https://docs.github.com/en/rest/repos}}
{{External|https://pygithub.readthedocs.io/en/latest/examples/Repository.html}}
===Get a Repository===
===Get a Repository===
<syntaxhighlight lang='py'>
<syntaxhighlight lang='py'>
Line 36: Line 36:
repo = github.get_repo('some-owner/some-repo')
repo = github.get_repo('some-owner/some-repo')
</syntaxhighlight>
</syntaxhighlight>
==Issues==
==Issues==
{{External|https://pygithub.readthedocs.io/en/latest/examples/Issue.html}}
{{External|https://pygithub.readthedocs.io/en/latest/examples/Issue.html}}

Revision as of 00:49, 28 October 2022

External

Internal

Overview

A package used to interact with GitHub APIs.

Example

import os
from github import Github
from urllib3 import Retry


def access_github():
    # github = Github('user', 'password')
    github_pat = os.environ.get('GITHUB_PAT')
    if not github_pat:
        raise ValueError("'GITHUB_PAT' not setup")
    base_url = 'https://github.com'
    api_endpoint = 'api/v3'
    status_forcelist = [403, 500, 502, 504]  # retry 403s, 5XX from GitHub
    retry = Retry(total=10, backoff_factor=0.2, raise_on_status=True, status_forcelist=status_forcelist)
    github = Github(base_url=f'{base_url}/{api_endpoint}', login_or_token=github_pat, retry=retry, per_page=100)

    for repo in github.get_user().get_repos():
        print(repo.name)

Programming Model

Repository

https://pygithub.readthedocs.io/en/latest/examples/Repository.html

Get a Repository

github = Github(...)
repo = github.get_repo('some-owner/some-repo')

Issues

https://pygithub.readthedocs.io/en/latest/examples/Issue.html