PyGithub

Warnings

• breaking In v2.0, the login_or_token, password, and jwt parameters on Github() were removed. Authentication must use Auth objects.
  Fix: Replace Github(login_or_token='TOKEN') with Github(auth=Auth.Token('TOKEN')).
• breaking The import module name is 'github', not 'pygithub'. Using 'import pygithub' raises ModuleNotFoundError.
  Fix: Use 'from github import Github' not 'import pygithub'.
• gotcha PaginatedList objects are lazily loaded. Iterating over get_issues(), get_pulls(), etc. makes one API call per page (default 30 items). Large repos can exhaust rate limits quickly.
  Fix: Use totalCount before iterating, slice results, or check g.get_rate_limit() to monitor usage.
• gotcha Github objects hold a requests Session. Failing to call g.close() or use a context manager leaks connections.
  Fix: Use 'with Github(auth=auth) as g:' or explicitly call g.close() when done.
• gotcha GitHub API rate limit is 5000 requests/hour for authenticated users, 60/hour for unauthenticated. PyGithub does not auto-retry on 403 rate limit errors.
  Fix: Check g.get_rate_limit().core.remaining and implement retry logic or use retry_after from the RateLimitExceededException.
• deprecated GithubIntegration constructor parameters changed in v2.0. The old positional (integration_id, private_key) signature is removed.
  Fix: Use GithubIntegration(auth=Auth.AppAuth(app_id, private_key)) instead of positional arguments.

Install

• pip install PyGithub Python

Imports

• Github

  from github import Github

  The package name on PyPI is PyGithub but the import module is 'github', not 'pygithub'.
• Auth

  from github import Auth

  Since v2.0 the login_or_token parameter is removed. Use Auth.Token() objects instead.
• GithubIntegration

  from github import GithubIntegration

  Used for GitHub App authentication. Requires the [integrations] extra.

Quickstart

Minimal example: authenticate with a personal access token and list repository info and issues.

import os
from github import Github, Auth

token = os.environ.get('GITHUB_TOKEN', '')
auth = Auth.Token(token)
g = Github(auth=auth)

repo = g.get_repo('PyGithub/PyGithub')
print(f'Repo: {repo.full_name}')
print(f'Stars: {repo.stargazers_count}')

# List open issues
for issue in repo.get_issues(state='open')[:5]:
    print(f'  #{issue.number}: {issue.title}')

g.close()