Skip to content

changes.rst

Latest commit

 

History

History
2208 lines (1732 loc) · 195 KB

changes.rst

File metadata and controls

2208 lines (1732 loc) · 195 KB

Change log

Stable versions

Version 2.9.1 (April 14, 2026)

Bug Fixes

Version 2.9.0 (March 22, 2026)

Notable changes

Lazy PyGithub objects

The notion of lazy objects has been added to some PyGithub classes in version 2.6.0. This release now makes all CompletableGithubObjects optionally lazy (if useful). See #3403 for a complete list.

In lazy mode, getting a PyGithub object does not send a request to the GitHub API. Only accessing methods and properties sends the necessary requests to the GitHub API:

# Use lazy mode
g = Github(auth=auth, lazy=True)

# these method calls do not send requests to the GitHub API
user = g.get_user("PyGithub")    # get the user
repo = user.get_repo("PyGithub") # get the user's repo
pull = repo.get_pull(3403)       # get a known pull request
issue = pull.as_issue()          # turn the pull request into an issue

# these method and property calls send requests to Github API
issue.create_reaction("rocket")  # create a reaction
created = repo.created_at        # get property of lazy object repo

# once a lazy object has been fetched, all properties are available (no more requests)
licence = repo.license

All PyGithub classes that implement CompletableGithubObject support lazy mode (if useful). This is only useful for classes that have methods creating, changing, or getting objects.

By default, PyGithub objects are not lazy.

PyGithub objects with a paginated property

The GitHub API has the "feature" of paginated properties. Some objects returned by the API have a property that allows for pagination. Fetching subsequent pages of that property means fetching the entire object (with all other properties) and the specified page of the paginated property. Iterating over the paginated property means fetching all other properties multiple times. Fortunately, the allowed size of each page (per_page is usually 300, in contrast to the "usual" per_page maximum of 100).

Objects with paginated properties:

  • Commit.files
  • Comparison.commits
  • EnterpriseConsumedLicenses.users

This PR makes iterating those paginated properties use the configured per_page setting.

It further allows to specify an individual per_page when either retrieving such objects, or fetching paginated properties.

See :ref:`Classes with paginated properties <utilities-classes-with-paginated-properties>` for details.

Drop Python 3.8 support due to End-of-Life

Python 3.8 reached its end-of-life September 6, 2024. Support has been removed with this release.

Deprecations

  • Method delete of Reaction is deprecated, use IssueComment.delete_reaction, PullRequestComment.delete_reaction, CommitComment.delete_reaction or Issue.delete_reaction instead.
  • Method Issue.assignee and parameter Issue.edit(assignee=…) are deprecated, use Issue.assignees and Issue.edit(assignees=…) instead.
  • Method Organization.edit_hook is deprecated, use Organization.get_hook(id).edit(…) instead. If you need to avoid Organization.get_hook(id) to fetch the Hook object from Github API, use a lazy Github instance:
Github(…, lazy=True).get_organization(…).get_hook(id).edit(…)
  • Methods Team.add_to_members and Team.remove_from_members are deprecated, use Team.add_membership or Team.remove_membership instead.

New Features

  • Consider per-page settings when iterating paginated properties (#3377) (b1a9b7e2a)
  • Add Secret Scanning Alerts and Improve Code Scan Alerts (#3307) (646190988)

Improvements

Bug Fixes

  • Fix PaginatedList.totalCount returning 0 with GitHub deprecation notices (#3382) (c4ec16a18)
  • Use default type if known type is not supported (#3365) (f5f9756a1)

Maintenance

Version 2.8.1 (September 02, 2025)

Bug Fixes

  • Use default type if known type is not supported (#3365) (40506415)

Version 2.8.0 (September 02, 2025)

New Features

Improvements

  • Fix connection pooling to improve connection performance (#3289)
  • Add Repository.get_automated_security_fixes method (#3303) (22048d83)
  • Sync Issue class with API spec (#3338) (62da467a)
  • Return more union classes like NamedUser | Organization | Enterprise (#3224) (aea64148)
  • Sync Enterprise class with API spec (#3342) (01bb5ab1)
  • Sync GitReleaseAsset class with API spec (#3343) (74449fed)
  • Sync many class with OpenAPI spec (#3344)
  • Point deprecation warnings to the caller code rather than inner class (#3275) (99bb5270)
  • Allow for repo strings in all Team repo methods (#3356) (3234a21f)

Bug Fixes

  • Fix API path of Repository.get_git_ref (#2992) (a6965031)
  • Rework redirection URL allowance check (#3329) (065b1319)
  • Fix GitRelease.name, deprecate GitRelease.title (#3346) (fb51957f)
  • Remove "COMMENT" as the default event for create_review (#3078) (8494da5c)
  • Add support for public release assets (#3339) (abad296e)
  • Fix GitHub breaking API change of maintainers in Organization.create_team (#3291) (17bc4df4)

Maintenance

Version 2.7.0 (July 31, 2025)

Breaking Changes

  • Method Github.get_rate_limit() now returns RateLimitOverview rather than RateLimit (#3205) (56ee057a).

    Code like

    gh.get_rate_limit().core.remaining

    should be replaced with

    gh.get_rate_limit().resources.core.remaining

  • Method GitTag.verification now returns GitCommitVerification rather than dict[str, Any] (#3226) (850932cc).

    Code like

    tag.verification["reason"]
tag.verification.get("reason")

    should be replaced with

    tag.verification.reason

Deprecations

  • Methods dismissal_users and dismissal_teams of RequiredPullRequestReviews are deprecated, use dismissal_restrictions.users and dismissal_restrictions.teams instead.

New Features

Improvement

Bug Fixes

  • Fix broken pickle support for Auth classes (#3211) (a1f328df)
  • Remove schema from Deployment, remove message attribute (#3223) (e91713e9)
  • Fix incorrect deprecated import (#3225) (a2071d70)
  • Add CodeSecurityConfigRepository returned by get_repos_for_code_security_config (#3219) (dbb32eed)
  • Fix Branch.get_required_status_checks return type (#3235) (66a3cc1c)
  • Adds multi_select and true_false options to CustomProperty.value_type (#3173) (f51a3f48)
  • Fix url encoding of strings with slashes in URLs (#3263) (da73fc8a)
  • Fix side-effect when removing Authorization key from headers (#3313) (0378ccee)
  • Make TimingData.run_duration_ms optional (#3268) (131949b3)
  • Normalize App ID to String & Enhance JWT Issuer Verification (#3272) (01196d67)
  • Add delete_self_hosted_runner to Organization (#3306)

Dependencies

Maintenance

Version 2.6.0 (February 15, 2025)

Breaking Changes

  • Rework Views and Clones (#3168) (f7d52249):

    View and clones traffic information returned by Repository.get_views_traffic and Repository.get_clones_traffic now return proper PyGithub objects, instead of a dict, with all information that used to be provided by the dict:

    Code like

    repo.get_views_traffic().["views"].timestamp
repo.get_clones_traffic().["clones"].timestamp

    should be replaced with

    repo.get_views_traffic().views.timestamp
repo.get_clones_traffic().clones.timestamp

  • Add GitCommitVerification class (#3028) (822e6d71):

    Changes the return value of GitTag.verification and GitCommit.verification from dict to GitCommitVerification.

    Code like

    tag.verification["reason"]
commit.verification["reason"]

    should be replaced with

    tag.verification.reason
commit.verification.reason

  • Property AppAuth.private_key has been removed (#3065) (36697b22)

  • Fix typos (#3086) (a50ae51b):

    Property OrganizationCustomProperty.respository_id renamed to OrganizationCustomProperty.repository_id.

New Features

Improvements

Bug Fixes

  • Patch httpretty socket for latest urllib3 release (#3102) (81f8f05b)
  • Fix API break when contents not found (#3181) (d90323fa)
  • Change start_side argument of PullRequest.create_review_comment from int to str (#3170) (f814de7d)
  • Create Review Request - transform string params to a list (#3099) (8aef11c0)
  • Fix Repository.get_contents redirection (#3183) (193f6991)

Others

Maintenance

  • Sort attributes and properties in GitHub classes (#3105) (f3986b57)
  • Preparations for maintaining Github classes by code (#3106) (842a1b02)
  • Annotate Github classes with API schemas (#3107) (d092f478)
  • Make Pickle test use recorded data (#3137) (1990eb92)
  • Add tests for file and stream downloads (#3182) (d483fe25)
  • Use responses instead of httpretty in tests (#3087) (9b293d44)
  • [CI] Publish test results (#3195)
  • Link Commit to correct upstream documentation (#2936) (4d307a7c)
  • Replace release drafter with Github release note generation (#3196) (6f9a2983)
  • Add maintenance label to release.yml (#3197) (cab8d078)

Version 2.5.0 (November 06, 2024)

Breaking Changes

  • Parameters of method github.Requester.Requester.graphql_named_mutation have been renamed:
    • Parameter variables renamed to mutation_input
    • Parameter output renamed to output_schema
    • Default value of parameter output has been removed

New features

Improvements

Bug Fixes

  • Fix requesting urls containing parameters with parameters dict (#2929) (e1d67ada)
  • PullRequest.delete_branch: fix the remaining pull requests check (#3063) (72fa6278)

Maintenance

Version 2.4.0 (August 26, 2024)

Breaking Changes

  • The github.Commit.Commit class provides a files property that used to return a list[github.File.File], which has now been changed to PaginatedList[github.File.File]. This breaks user code that assumes a list:
files = repo.get_commit("7266e812ed2976ea36a4303edecfe5d75522343f").files
no_of_files = len(files)

This will raise a TypeError: object of type 'PaginatedList' has no len(), as the returned PaginatedList does not support the len() method. Use the totalCount property instead:

files = repo.get_commit("7266e812ed2976ea36a4303edecfe5d75522343f").files
no_of_files = files.totalCount
  • Removed support for Python 3.7.

New features

Improvements

  • Add has_discussions to AuthenticatedUser and Repository classes (#3020) (75224167)
  • Update more SecurityAndAnalysis attributes (#3025) (fa168279)
  • Implement support for re-running only failed workflow jobs. (#2983) (23e87563)
  • Add possibility to mark a thread/notification as done (#2985) (5ba24379)
  • Add "pull_request_review_id" to PullRequestComment object (#3000) (6a59cf82)
  • Add minimize and unminimize functions for IssueComment class (#3005) (09c4f58e)
  • Support Organization/Repository custom properties (#2968) (c5e6b702)
  • Add dict type to add_attribute script (#2977) (2a04f9cc)
  • Allow for deleting and restoring branch associated with PR (#1784) (4ba1e412)
  • Add "archived_at" to Organization object. (#2974) (cc766a6f)
  • Adds Security & Analysis To Repository (#2960) (f22af54d)
  • Add added_by and last_used attributes to RepositoryKey (#2952) (5dffa64d)
  • Add make_latest to GitRelease.update_release (#2888) (60136105)
  • Make Commit.files return PaginatedList (#2939) (fa885f00)

Bug Fixes

Maintenance

  • Remove support for Python 3.7 (#2975, #3008) (d0e05072, 6d60b754)
  • docs: add missing code-block (#2982) (c93e73e2)
  • Update README.md (#2961) (5d9f90d2)
  • CI: Fix test success job (#3010) (61d37dce)

Version 2.3.0 (March 21, 2024)

New features

  • Support OAuth for enterprise (#2780) (e4106e00)
  • Support creation of Dependabot Organization and Repository Secrets (#2874) (0784f835)

Improvements

  • Create release with optional name and message when generate_release_notes is true (#2868) (d65fc30d)
  • Add missing attributes to WorkflowJob (#2921) (9e092458)
  • Add created and check_suite_id filter for Repository WorkflowRuns (#2891) (c788985c)
  • Assert requester argument type in Auth (#2912) (0b8435fc)

Bug Fixes

  • Revert having allowed values for add_to_collaborators (#2905) (b542438e)

Maintenance

Version 2.2.0 (January 28, 2024)

Breaking Changes

  • The github.Comparison.Comparison instance returned by Repository.compare provides a commits property that used to return a list[github.Commit.Commit], which has now been changed to PaginatedList[github.Commit.Commit]. This breaks user code that assumes a list:
commits = repo.compare("v0.6", "v0.7").commits
no_of_commits = len(commits)

This will raise a TypeError: object of type 'PaginatedList' has no len(), as the returned PaginatedList does not support the len() method. Use the totalCount property instead:

commits = repo.compare("v0.6", "v0.7").commits
no_of_commits = commits.totalCount

New features

  • Add support to call GraphQL API

Improvements

  • Add parent_team_id, maintainers and notification_setting for creating and updating teams. (#2863) (49d07d16)
  • Add support for issue reactions summary (#2866) (cc4c5269)
  • Support for DependabotAlert APIs (#2879) (14af7051)
  • Derive GraphQL URL from base_url (#2880) (d0caa3c3)
  • Make Repository.compare().commits return paginated list (#2882) (2d284d1e)
  • Add missing branch protection fields (#2873) (e47c153b)
  • Add include_all_branches to create_repo_from_template of AuthenticatedUser and Organization (#2871) (34c4642e)
  • Add and update organisation dependabot secrets (#2316) (603896f4)
  • Add missing params to Organization.create_repo (#2700) (9c61a2a4)
  • Update allowed values for Repository collaborator permissions (#1996) (b5b66da8)
  • Support editing PullRequestReview (#2851) (b1c4c561)
  • Update attributes after calling PullRequestReview.dismiss (#2854) (6f3d714c)
  • Add request_cve on RepositoryAdvisories (#2855) (41b617b7)
  • Filter collaborators of a repository by permissions (#2792) (702c127a)
  • Set pull request to auto merge via GraphQL API (#2816) (232df79a)
  • Support Environment Variables and Secrets (#2848) (7df97398)
  • Update workflow.get_runs & pullrequest.add_to_assignees function signature (#2799) (26eedbb0)
  • Add GithubObject.last_modified_datetime to have last_modified as a datetime (#2772) (e7ce8189)
  • Add support for global advisories and unify some shared logic with repository advisories (#2702) (c8b4fcbe)
  • Add internal as valid Repository visibility value (#2806) (d4a5a40f)
  • Add support for issue comments reactions summary (#2813) (67397491)

Bug Fixes

Maintenance

Version 2.1.1 (September 29, 2023)

Bug Fixes

Maintenance

  • Fix pypi-release workflow, allow for manual run (#2771) (035c88f1)

Version 2.1.0 (September 29, 2023)

Important

Request throttling

This release introduces a default throttling mechanism to mitigate secondary rate limit errors and comply with Github's best practices: https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits

The default throttling of 1 second between writes and 0.25 second between any requests can be configured for github.Github and github.GithubIntegration:

g = github.Github(seconds_between_requests=0.25, seconds_between_writes=1)

Set these parameters to None to disable throttling and restore earlier behavior.

Request retry

This release introduces a default retry mechanism to retry retry-able 403 responses (primary and secondary rate limit errors only) and any 5xx response.

Class github.GithubRetry implements this behavior, and can be configured via the retry argument of github.Github and github.GithubIntegration. Retry behavior is configured similar to urllib3.Retry: https://urllib3.readthedocs.io/en/stable/reference/urllib3.util.html

g = github.Github(retry=github.GithubRetry())

Set this parameter to None to disable retry mechanism and restore earlier behaviour.

Breaking Changes

Timestamps

Any timestamps returned by this library are datetime with timezone information, usually UTC. Before this release, timestamps used to be naive datetime instances without timezone. Comparing (other than ==) these timestamps with naive datetime instances used to work but will now break. Add a timezone information to your datetime instances before comparison:

if g.get_repo("PyGithub/PyGithub").created_at < datetime(2012, 2, 26, tzinfo=timezone.utc):
    ...

Netrc authentication

A Netrc file (e.g. ~/.netrc) does not override PyGithub authentication, anymore. If you require authentication through Netrc, then this is a breaking change. Use a github.Auth.NetrcAuth instance to use Netrc credentials:

>>> auth = Auth.NetrcAuth()
>>> g = Github(auth=auth)
>>> g.get_user().login
'login'

Repository.create_pull

Merged overloaded create_pull methods

def create_pull(self, issue, base, head)
def create_pull(self, title, body, base, head, maintainer_can_modify=NotSet, draft=False)

into

def create_pull(self, base, head, *, title=NotSet, body=NotSet, maintainer_can_modify=NotSet, draft=NotSet, issue=NotSet)

Please update your usage of Repository.create_pull accordingly.

New features

Improvements

Bug Fixes

  • Fix Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a)
  • Fix required_conversation_resolution assertion (#2715) (54f22267)
  • Fix assertion creating pull request review comment (#2641) (2fa568b6)
  • Safely coerce responseHeaders to int (#2697) (adbfce92)
  • Fix assertion for subject_type in creating pull request review comment (#2642) (4933459e)
  • Use timezone-aware reset datetime in GithubRetry.py (#2610) (950a6949)
  • Fix Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a)

Maintenance

Version 1.59.1 (July 03, 2023)

Bug Fixes

Version 1.59.0 (June 22, 2023)

Important

This release introduces new way of authentication. All authentication-related arguments github.Github(login_or_token=…, password=…, jwt=…, app_auth=…) and github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…) are replaced by a single auth=… argument. Module github.Auth provides classes for all supported ways of authentication: Login, Token, AppAuth, AppAuthToken, AppInstallationAuth, AppUserAuth. Old arguments are deprecated but continue to work. They are scheduled for removal for version 2.0 release.

This project has decided to move all typing information from .pyi files into the respective .py source files. This will happen gradually over time.

Breaking Changes

  • The position argument in github.PullRequest.create_review_comment(position=…) has been renamed to line. This breaks user code that calls create_review_comment with keyword argument position. Call with line=… instead. Calling this method with positional arguments is not breaking.
  • The jwt_expiry, jwt_issued_at and jwt_algorithm arguments in github.GithubIntegration() have changed their position. User code calling github.GithubIntegration(…) with these arguments as positional arguments breaks. Please use keyword arguments: github.GithubIntegration(…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…).
  • The since argument in github.PullRequest.get_review_comments(…) has changed position.`` User code calling github.PullRequest.get_review_comments(…) with this argument as positional argument breaks. Please use keyword argument: github.PullRequest.get_review_comments(since=…).

Deprecation

  • The use of github.Github(login_or_token=…) is deprecated, use github.Github(auth=github.Auth.Login(…)) or github.Github(auth=github.Auth.Token(…)) instead.
  • The use of github.Github(password=…) is deprecated, use github.Github(auth=github.Auth.Login(…)) instead.
  • The use of github.Github(jwt=…) is deprecated, use github.Github(auth=github.AppAuth(…)) or github.Github(auth=github.AppAuthToken(…)) instead.
  • The use of github.Github(app_auth=…) is deprecated, use github.Github(auth=github.Auth.AppInstallationAuth(…)) instead.
  • The use of github.GithubIntegration(integration_id=…, private_key=…, jwt_expiry=…, jwt_issued_at=…, jwt_algorithm=…) is deprecated, use github.GithubIntegration(auth=github.Auth.AppAuth(…)) instead.
  • The use of github.GithubIntegration.create_jwt is deprecated, use github.Github(auth=github.Auth.AppAuth), github.Auth.AppAuth.token or github.Auth.AppAuth.create_jwt(expiration) instead.
  • The use of AppAuthentication is deprecated, use github.Auth.AppInstallationAuth instead.
  • The use of github.Github.get_app() without providing argument slug is deprecated, use github.GithubIntegration(auth=github.Auth.AppAuth(…)).get_app().

Bug Fixes

  • Test and fix UTC issue with AppInstallationAuth (#2561) (ff3b80f8)
  • Make Requester.__createException robust against missing message and body (#2159) (7be3f763)
  • Fix auth issues with Installation.get_repos (#2547) (64075120)
  • Fix broken urls in docstrings (#2393) (f82ad61c)
  • Raise error on unsupported redirects, log supported redirects (#2524) (17cd0b79)
  • Fix GithubIntegration that uses expiring jwt (#2460) (5011548c)
  • Add expiration argument back to GithubIntegration.create_jwt (#2439) (822fc05c)
  • Add crypto extras to pyjwt, which pulls in cryptogaphy package (#2443) (554b2b28)
  • Remove RLock from Requester (#2446) (45f3d723)
  • Move CI to Python 3.11 release and 3.12 dev (#2434) (e414c322)
  • Pass Requester base URL to integration (#2420) (bdceae2f)

Improvements

  • Add Webhook Deliveries (#2508) (517ad336)
  • Add support for workflow jobs and steps (#1951) (804c3107)
  • Add support for get_app() with App authentication (#2549) (6d4b6d14)
  • Allow multiline comments in PullRequest (#2540) (6a21761e)
  • Implement AppUserAuth for Github App user tokens (#2546) (f291a368)
  • Add support for environments (#2223) (0384e2fd)
  • Add support for new RepositoryAdvisories API 🎉 (#2483) (daf62bd4)
  • Make MainClass.get_app return completed GithubApp when slug is given (#2543) (84912a67)
  • Add authentication classes, move auth logic there (#2528) (fc2d0e15)
  • Add sort order and direction for getting comments (#2544) (a8e7c423)
  • Add name filter to Repository.get_artifacts() (#2459) (9f52e948)
  • Add name, display_title and path attributes to WorkflowRun (#2397) (10816389)
  • Add new create_fork arguments (#2493) (b94a83cb)
  • add ref to Deployment (#2489) (e8075c41)
  • Add query check_suite_id integer to Workflow.get_runs (#2466) (a4854519)
  • Add generate_release_notes parameter to create_git_release and create_git_tag_and_release (#2417) (49b3ae16)
  • Add example for Pull Request comments to documentation (#2390) (c2f12bdc)
  • Add allow_auto_merge support to Repository (#2477) (8c4b9465)
  • Add artifact_id argument to Repository.get_artifact() (#2458) (4fa0a5f3)
  • Add missing attributes to Branch (#2512) (e296dbdb)
  • Add allow_update_branch option to Organization (#2465) (bab4180f)
  • Add support for Issue.state_reason #2370 (#2392) (5aa544a1)
  • Add parameters to Repository.get_workflow_runs (#2408) (4198dbfb)

Maintenance

  • Add type stub for MainClass.get_project_column (#2502) (d514222c)
  • Sync GithubIntegration __init__ arguments with github.Github (#2556) (ea45237d)
  • Update MAINTAINERS (#2545) (f4e9dcb3)
  • Link to stable docs, update introduction in package used by pypi, move auth arg front (#2557) (006766f9)
  • Merge PaginatedList.pyi back to source (#2555) (cb50dec5)
  • Merge GithubObject.pyi/Requester.pyi stubs back to source (#2463) (b6258f4b)
  • [CI] Moving linting into separate workflow (#2522) (52fc1077)
  • Merging 1.58.x patch release notes into master (#2525) (217d4241)
  • Merge AppAuthentication.pyi to source (#2519) (8e8cfb30)
  • Merge GithubException.pyi stubs back to source (#2464) (03a2f696)
  • Add missing fields from GithubCredentials.py to CONTRIBUTING.md (#2482) (297317ba)
  • Update docstring and typing for allow_forking and allow_update_branch (Repository) (#2529) (600217f0)
  • Bump actions/checkout from 2 to 3.1.0 (#2327) (300c5015)
  • RTD: install current project (def5223c)
  • Add current dir sys.path as well (9c96faa7)
  • Use use_scm_version to get current version from git tag (#2429) (3ea91a3a)

Version 1.58.2 (May 09, 2023)

Bug Fixes

  • Fix GithubIntegration that uses expiring jwt (#2460) (5011548c)

Version 1.58.1 (March 18, 2023)

Bug Fixes

  • Add expiration argument back to GithubIntegration.create_jwt (#2439) (822fc05c)
  • Add crypto extras to pyjwt, which pulls in cryptogaphy package (#2443) (554b2b28)
  • Remove RLock from Requester (#2446) (45f3d723)
  • Move CI to Python 3.11 release and 3.12 dev (#2434) (e414c322)
  • pass requester base URL to integration (#2420) (bdceae2f)
  • RTD: install current project (def5223c)
  • Add current dir sys.path as well (9c96faa7)
  • Use use_scm_version to get current version from git tag (#2429) (3ea91a3a)

Version 1.58.0 (February 19, 2023)

Bug Fixes & Improvements

  • Add unarchiving support @Tsuesun (#2391)
  • Support full GitHub app authentication @dblanchette (#1986)
  • Continue the PR #1899 @Felixoid (#2386)
  • feat: add allow_forking to Repository @IbrahimAH (#2380)
  • Add code scanning alerts @eric-nieuwland (#2227)

Version 1.57 (November 05, 2022)

Breaking Changes

  • Add support for Python 3.11, drop support for Python 3.6 (#2332) (1e2f10dc)

Bug Fixes & Improvements

Version 1.56 (October 13, 2022)

Important

This is the last release that will support Python 3.6.

Bug Fixes & Improvements

Version 1.55 (April 26, 2021)

Breaking Changes

  • Remove client_id/client_secret authentication (#1888) (901af8c8)
  • Adjust to Github API changes regarding emails (#1890) (2c77cfad) - This impacts what AuthenticatedUser.get_emails() returns
  • PublicKey.key_id could be int on Github Enterprise (#1894) (ad124ef4)
  • Export headers in GithubException (#1887) (ddd437a7)

Bug Fixes & Improvements

Version 1.54.1 (December 24, 2020)

Version 1.54 (November 30, 2020)

Important

This is the last release that will support Python 3.5.

Breaking Changes

The Github.get_installation(integer) method has been removed. Repository.create_deployment()'s payload parameter is now a dictionary.

Bug Fixes & Improvements

Version 1.53 (August 18, 2020)

Version 1.52 (August 03, 2020)

Version 1.51 (May 03, 2020)

Version 1.50 (April 26, 2020)

New features

  • PyGithub now supports type checking thanks to (#1231) (91433fe9)
  • Slack is now the main channel of communication rather than Gitter (6a6e7c26)
  • Ability to retrieve public events (#1481) (5cf9950b)
  • Add and handle the maintainer_can_modify attribute in PullRequest (#1465) (e0997b43)
  • List matching references (#1471) (d3bc6a5c)
  • Add create_repository_dispatch (#1449) (edcbdfda)
  • Add some Organization and Repository attributes. (#1468) (3ab97d61)
  • Add create project method (801ea385)

Bug Fixes & Improvements

Version 1.47 (March 15, 2020)

Bug Fixes & Improvements

Version 1.46 (February 11, 2020)

Important

Python 2 support has been removed. If you still require Python 2, use 1.45.

Bug Fixes & Improvements

Version 1.45 (December 29, 2019)

Important

  • This is the last release of PyGithub that will support Python 2.

Breaking Changes

  • Branch.edit_{user,team}_push_restrictions() have been removed
  • The new API is: - Branch.add_{user,team}_push_restrictions() to add new members - Branch.replace_{user,team}_push_restrictions() to replace all members - Branch.remove_{user,team}_push_restrictions() to remove members
  • The api_preview parameter to Github() has been removed.

Bug Fixes & Improvements

Version 1.44.1 (November 07, 2019)

Version 1.44 (October 19, 2019)

New features

  • This version supports running under Python 3 directly, and the test suite passes under both 2.7 and recent 3.x's.

Bug Fixes & Improvements

Version 1.43.8 (July 20, 2019)

New features

Bug Fixes & Improvements

Deprecation

  • Repository.get_file_contents() no longer works use Repository.get_contents() instead

Version 1.43.7 (April 16, 2019)

Version 1.43.6 (April 05, 2019)

New features

  • Add support for Python 3.7 (#1028) (6faa00ac)
  • Adding HTTP retry functionality via urllib3 (#1002) (5ae7af55)
  • Add new dismiss() method on PullRequestReview (#1053) (8ef71b1b)
  • Add since and before to get_notifications (#1074) (7ee6c417)
  • Add url parameter to include anonymous contributors in get_contributors (#1075) (293846be)
  • Provide option to extend expiration of jwt token (#1068) (86a9d8e9)

Bug Fixes & Improvements

Deprecation

Version 1.43.5 (January 29, 2019)

Version 1.43.4 (December 21, 2018)

New features

Bug Fixes & Improvements

  • Change type of GitRelease.author to NamedUser (#969) (aca50a75)
  • Use total_count from data in PaginatedList (#963) (ec177610)

Version 1.43.3 (October 31, 2018)

New features

Bug Fixes & Improvements

  • Fix missing parameters when reversing PaginatedList (#946) (60a684c5)
  • Fix unable to trigger RateLimitExceededException. (#943) (972446d5)
  • Fix inconsistent behavior of trailing slash usage in file path (#931) (ee9f098d)
  • Fix handling of 301 redirects (#916) (6833245d)
  • Fix missing attributes of get_repos for authenticated users (#915) (c411196f)
  • Fix Repository.edit (#904) (7286eec0)
  • Improve __repr__ method of Milestone class (#921) (562908cb)
  • Fix rate limit documentation change (#902) (974d1ec5)
  • Fix comments not posted in create_review() (#909) (a18eeb3a)

Version 1.43.2 (September 12, 2018)

  • Restore RateLimit.rate attribute, raise deprecation warning instead (d92389be)

Version 1.43.1 (September 11, 2018)

New feature:

Version 1.43 (September 08, 2018)

Bug Fixes

  • Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)
  • Fixed Gistfile.content (#486) (e1df09f7)
  • Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Improvements

  • Add missing arguments to Repository.edit (#844) (29d23151)
  • Add missing attributes to Repository (#842) (2b352fb3)
  • Adding archival support for Repository.edit (#843) (1a90f5db)
  • Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)
  • Allow editing of Team descriptions (#839) (c0021747)
  • Add description to Organizations (#838) (1d918809)
  • Add missing attributes for IssueEvent (#857) (7ac2a2a)
  • Change MainClass.get_repo default laziness (#882) (6732517)

Deprecation

  • Removed Repository.get_protected_branch (#871) (49db6f8)

Version 1.42 (August 19, 2018)

  • Fix travis upload issue

Bug Fixes

  • Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)
  • Fixed Gistfile.content (#486) (e1df09f7)
  • Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Improvements

  • Add missing arguments to Repository.edit (#844) (29d23151)
  • Add missing properties to Repository (#842) (2b352fb3)
  • Adding archival support for Repository.edit (#843) (1a90f5db)
  • Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)
  • Allow editing of Team descriptions (#839) (c0021747)
  • Add description to Organizations (#838) (1d918809)

Version 1.41 (August 19, 2018)

Bug Fixes

  • Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)
  • Fixed Gistfile.content (#486) (e1df09f7)
  • Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Improvements

  • Add missing arguments to Repository.edit (#844) (29d23151)
  • Add missing properties to Repository (#842) (2b352fb3)
  • Adding archival support for Repository.edit (#843) (1a90f5db)
  • Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)
  • Allow editing of Team descriptions (#839) (c0021747)
  • Add description to Organizations (#838) (1d918809)

Version 1.40 (June 26, 2018)

Version 1.39 (April 10, 2018)

  • Add documentation to github.Repository.Repository.create_git_release() (#747) (a769c2ff)
  • Add add_to_members() and remove_from_membership() (#741) (4da483d1)
  • Documentation: clarify semantics of get_comments (#743) (fec3c943)
  • Add download_url to ContentFile, closes #575 (ca6fbc45)
  • Add PullRequestComment.in_reply_to_id (#718) (eaa6a508)
  • Add team privacy parameter to create team (#702) (5cb5ab71)
  • Implement License API (#734) (b54ccc78)
  • Fix delete method for RepositoryKey (911bf615)
  • Remove edit for UserKey (722f2534)
  • Labels API: support description (#738) (42e75938)
  • Added Issue.as_pull_request() and PullReqest.as_issue() (#630) (6bf2acc7)
  • Documentation: sort the Github Objects (#735) (1497e826)
  • Add support for getting PR single review's comments. (#670) (612c3500)
  • Update the RepositoryKey class (#530) (5e8c6832)
  • Added since to PR review comments get (#577) (d8508285)
  • Remove some duplicate attributes introduced in #522 (566b28d3)
  • Added tarball_url, zipball_url, prerelease and draft property (#522) (c76e67b7)
  • Source Import API (#673) (864c663a)

Version 1.38 (March 21, 2018)

  • Updated readthedocs, PyPI to reflect latest version
  • Added option to create review for Pull request (#662) (162f0397)
  • Depreciate legacy search API (3cd176e3)
  • Filter team members by role (#491) (10ee17a2)
  • Add url attribute to PullRequestReview object (#731) (0fb176fd)
  • Added target_commitish option to Repository.create_git_release() (#625) (0f0a7d4e)
  • Fix broken Github reference link in class docstrings (a32a17bf)
  • Add hook support for organizations (#729) (c7f6563c)
  • Get organization from the team (#590) (d9c5a07f)
  • Added search_commits (#727) (aa556f85)
  • Collaborator site admin (#719) (f8b23505)
  • Fix add_to_watched for AuthenticatedUser (#716) (6109eb3c)

Version 1.37 (March 03, 2018)

Version 1.36 (February 02, 2018)

Version 1.35 (July 10, 2017)

  • Add Support for repository collaborator invitations.

Version 1.34 (abril 04, 2017)

  • Add Support for Pull Request Reviews feature.

Version 1.32 (February 1, 2017)

  • Support for Integrations installation endpoint (656e70e1)

Version 1.31 (January 30, 2017)

  • Support HTTP 302 redirect in Organization.has_in_members (0154c6b)
  • Add details of repo type for get_repos documentation (f119147)
  • Note explicit support for Python 3.5 (3ae55f0)
  • Fix README instructions (5b0224e)
  • An easier to see link to the documentation in response to issue #480. (6039a4b)
  • Encode GithubObject repr values in utf-8 when using Python2 (8ab9082)
  • Updated documentation (4304ccd)
  • Added a subscribers count field (a2da7f9)
  • Added "add_to_assignees" & "remove_from_assignees" method to Issue object. (66430d7)
  • Added "assignees" attribute to PullRequest object. (c0de6be)
  • add html_url to GitRelease (ec633aa)
  • Removed unused imports (65afc3f)
  • Fix typo in a constant (10a28e0)
  • Fix changelog formatting glitch (03a9227)
  • Added "assignees" argument in Repository.create_issue() (ba007dc)
  • Enhance support of "assignees" argument in Issue.edit() (14dd9f0)
  • Added "assignees" attribute to Issue object. (e0e5fdf)

Version 1.30 (January 30, 2017)

  • adds GitHub integrations (d60943d)

Version 1.29 (October 10, 2016)

  • add issue assignee param (3a8edc7)
  • Fix different case (fcf6cfb)
  • DOC: remove easy_install suggestion; update links (45e76d9)
  • Add permission param documentation (9347345)
  • Add ability to set permission for team repo (5dddea7)
  • Fix status check (073bb44)
  • adds support for content dirs (0799753)

Version 1.28 (September 09, 2016)

  • test against python 3.5 (5d35284)
  • sort params and make them work on py3 (78374b9)
  • adds a nicer __repr__ (8571d87)
  • Add missing space (464259d)
  • Properly handle HTTP Proxy authentication with Python 3 (d015154)
  • Fix small typo (987bca0)
  • push to 'origin' instead of 'github' (d640666)

Version 1.27.1 (August 12, 2016)

  • upgrade release process based on travis (3c20a66)
  • change file content encoding to support unicode(like chinese), py2 (5404030)
  • adds missing testfile corrections (9134aa2)
  • fixed file API return values (0f29a53)
  • assert by str and unicode to make it more py3 friendly (7390827)
  • Patch issue 358 status context (#428) (70e30c5)
  • Adding "since" param to Issue.get_comments() (#426) (3c6f99f)
  • update doc url everywhere (#420) (cb0cf0a)
  • fix a couple typos to be clearer (#419) (23c0e75)
  • Document how one gets an AuthenticatedUser object (ba66862)
  • fix wrong expectance on requestJsonAndCheck() returning {} if no data (8985368)
  • Add previous_filename property to File (e1be1e6)
  • add changelog entry for 1.26.0 (a1f3de2)
  • update project files (be2e98b)
  • fix update/create/delete file api return value issue (8bb765a)
  • fix typo (a7929ac)
  • fix update/delete/create content return value invalid issue (a0a4511)
  • Follow redirects in the case of a 301 status code (c29f533)
  • Fix for pickling exception when deserializing GithubException. (8f8b455)
  • add support for the head parameter in Repository.get_pulls (397a74d)
  • Add: - CommitCombinedStatus class - get_combined_status() to Commit class to return combined status - Add test for combined status. (5823ed7)
  • fix python3 compatibility issue for using json/base64 (5b7f0bb)
  • remove not covered API from readme (9c6f881)
  • change replay data for update file test case (46895df)
  • fix python3 compatibility error in test case (00777db)
  • Add repo content create/update/delete testcase (4aaeb9e)
  • add MAINTAINERS file (a16b55b)
  • travis: disable email (6347157)
  • fix protect branch tests (65360b0)
  • Add branch protection endpoint (737f0c3)
  • fix request parameters issue (ae37d44)
  • add content file create/update/delete api (b83ffbf)
  • Add travis button on README. (a83649b)
  • fix misspelling: https://github.com/PyGithub/PyGithub/issues/363 (a06b5ec)
  • Adding base parameter to get_pulls() method. (71593a8)
  • add support for the direction parameter in Repository.get_pulls (70bcb6d)
  • added creator parameter (ca9af4f)

Version 1.27.0 (August 12, 2016)

  • this version was never released to PyPi due to a problem with the deployment

Version 1.26.0 (November 5th, 2015)

  • Added context parameter to Status API
  • Changed InputGitAuthor to reflect that time is an optional parameter
  • Added sort option to get_pulls
  • Added api_preview parameter to Requester class
  • Return empty list instead of None for pagination with no pages
  • Removed URL scheme validation that broke GitHub Enterprise
  • Added "add_membership" call to Teams
  • Added support to lazily load repositories
  • Updated test suite to record with oauth tokens
  • Added support for http_proxy
  • Add support for filter/role options in Organization.get_members()
  • Changed Organization.get_members's filter parameter to _filter
  • Fix escaping so that labels now support whitespaces
  • Updated create_issue to support taking a list of strings for labels
  • Added support for long integers in get_repo
  • Fixed pagination to thread headers between requests
  • Added repo.get_stargazers_with_dates()

Version 1.25.2 (October 7th, 2014)

  • Work around the GitHub API v3 returning nulls in some paginated responses, erichaase for the bug report

Version 1.25.1 (September 28th, 2014)

  • Fix two-factor authentication header, thanks to tradej for the pull request

Version 1.25.0 (May 4th, 2014)

Version 1.24.1 (March 16th, 2014)

  • Fix urlquoting in search, thanks to cro for the pull request

Version 1.24.0 (March 2nd, 2014)

Version 1.23.0 (December 23th, 2013)

  • Fix all that is based on headers in Python 3 (pagination, conditional request, rate_limit...), huge thanks to cwarren-mw for finding the bug
  • Accept strings for assignees and collaborators, thanks to farrd
  • Ease two-factor authentication by adding 'onetime_password' to AuthenticatedUser.create_authorization, thanks to cameronbwhite

Version 1.22.0 (December 15th, 2013)

Version 1.21.0 (November ??th, 2013)

  • Accept strings as well as Label objects in Issue.add_to_labels, Issue.remove_from_labels and Issue.set_labels. Thank you acdha for asking
  • Implement equality comparison for completable github objects (ie. those who have a url attribute). Warning, comparison is still not implemented for non-completable objects. This will be done in version 2.0 of PyGithub. Thank you OddBloke for asking
  • Add parameter author to Repository.get_commits. Thank you naorrosenberg for asking
  • Implement the statistics end points. Thank you naorrosenberg for asking

Version 1.20.0 (October 20th, 2013) (First Seattle edition)

  • Implement Github.get_hook(name). Thank you klmitch for asking
  • In case bad data is returned by Github API v3, raise an exception only when the user accesses the faulty attribute, not when constructing the object containing this attribute. Thank you klmitch for asking
  • Fix parameter public/private of Repository.edit. Thank you daireobroin449 for reporting the issue
  • Remove Repository.create_download and NamedUser.create_gist as the corresponding APIs are not documented anymore

Version 1.19.0 (September 8th, 2013) (AKFish's edition)

  • Implement conditional requests by the method GithubObject.update. Thank you very much akfish for the pull request and your collaboration!
  • Implement persistence of PyGithub objects: Github.save and Github.load. Don't forget to update your objects after loading them, it won't decrease your rate limiting quota if nothing has changed. Again, thank you akfish
  • Implement Github.get_repos to get all public repositories
  • Implement NamedUser.has_in_following
  • Implement Github.get_api_status, Github.get_last_api_status_message and Github.get_api_status_messages. Thank you ruxandraburtica for asking
  • Implement Github.get_rate_limit
  • Add many missing attributes
  • Technical change: HTTP headers are now stored in retrieved objects. This is a base for new functionalities. Thank you akfish for the pull request
  • Use the new URL to fork gists (minor change)
  • Use the new URL to test hooks (minor change)

Version 1.18.0 (August 21st, 2013) (Bénodet edition)

  • Issues' repository attribute will never be None. Thank you stuglaser for the pull request
  • No more false assumption on rate_limiting, and creation of rate_limiting_resettime. Thank you edjackson for the pull request
  • New parameters since and until to Repository.get_commits. Thank you apetresc for the pull request
  • Catch Json parsing exception for some internal server errors, and throw a better exception. Thank you MarkRoddy for the pull request
  • Allow reversed iteration of PaginatedList. Thank you davidbrai for the pull request

Version 1.17.0 (Jully 7th, 2013) (Hamburg edition)

Version 1.16.0 (May 31th, 2013) (Concarneau edition)

  • Add the html_url attribute to IssueComment and PullRequestComment

Version 1.15.0 (May 17th, 2013) (Switzerland edition)

  • Implement listing of user issues with all parameters. Thank you Daehyok Shin for reporting
  • Raise two new specific exceptions

Version 1.14.2 (April 25th, 2013)

  • Fix paginated requests when using secret-key oauth. Thank you jseabold for analysing the bug

Version 1.14.1 (April 25th, 2013)

Version 1.14.0 (April 22nd, 2013)

  • Improve gist edition. Thank you jasonwiener for asking:
    • Delete a file with gist.edit(files={"name.txt": None})
    • Rename a file with gist.edit(files={"old_name.txt": github.InputFileContent(gist.files["old_name.txt"].content, new_name="new_name.txt")})
  • Raise specific exceptions. Thank you pconrad for giving me the idea

Version 1.13.1 (March 28nd, 2013)

Version 1.13.0 (March 22nd, 2013)

Version 1.12.2 (March 3rd, 2013)

  • Fix major issue with Python 3: Json decoding was broken. Thank you bilderbuchi for reporting

Version 1.12.1 (February 20th, 2013)

  • Nothing, but packaging/upload of 1.12.0 failed

Version 1.12.0 (February 20th, 2013)

Version 1.11.1 (February 9th, 2013) (London edition)

  • Fix bug in lazy completion. Thank you ianozsvald for pinpointing it

Version 1.11.0 (February 7th, 2013)

Version 1.10.0 (December 25th, 2012) (Christmas 2012 edition)

Version 1.9.1 (November 20th, 2012)

  • Fix an assertion failure when integers returned by Github do not fit in a Python int

Version 1.9.0 (November 19th, 2012)

Version 1.8.1 (October 28th, 2012)

  • Repository.get_git_ref prepends "refs/" to the requested references. Thank you simon-weber for noting the incoherence between documentation and behavior. If you feel like it's a breaking change, please see this issue

Version 1.8.0 (September 30th, 2012)

  • Enable Travis CI
  • Fix error 500 when json payload contains percent character (%). Thank you again quixotique for pointing that and reporting it to Github
  • Enable debug logging. Logger name is "github". Simple logging can be enabled by github.enable_console_debug_logging(). Thank you quixotique for the merge request and the advice
  • Publish tests in the PyPi source archive to ease QA tests of the FreeBSD port. Thank you koobs for maintaining this port
  • Switch to Semantic Versioning
  • Respect pep8 Style Guide for Python Code

Version 1.7 (September 12th, 2012)

  • Be able to clear the assignee and the milestone of an Issue. Thank you quixotique for the merge request
  • Fix an AssertionFailure in Organization.get_xxx when using Github Enterprise. Thank you mnsanghvi for pointing that
  • Expose pagination to users needing it (PaginatedList.get_page). Thank you kukuts for asking
  • Improve handling of legacy search APIs
  • Small refactoring (documentation, removal of old code generation artifacts)

Version 1.6 (September 8th, 2012)

Version 1.5 (September 5th, 2012)

  • Add a timeout option, thank you much xobb1t for the merge request. This drops Python 2.5 support. I may be able to restore it in next version.
  • Implement Repository.delete, thank you pmchen for asking

Version 1.4 (August 4th, 2012)

  • Allow connection to a custom Github URL, for Github Enterprise, thank you very much engie for the merge request

Version 1.3 (July 13th, 2012)

  • Implement markdown rendering
  • GitAuthor.date is now a datetime, thank you bilderbuchi
  • Fix documentation of Github.get_gist: id is a string, not an integer

Version 1.2 (June 29th, 2012)

  • Implement legacy search APIs, thank you kukuts for telling me Github had released them
  • Fix a bug with issue labels containing spaces, thank you philipkimmey for detecting the bug and fixing it
  • Clarify how collections of objects are returned by get_* methods, thank you bilderbuchi for asking

Version 1.1 (June 20th, 2012)

  • Restore compatibility with Python 2.5, thank you pmuilu
  • Use package_data instead of data_files for documentation files in setup.py, thank you malexw for reporting

Version 1.0 (June 3rd, 2012)

  • Complete rewrite, with no more complicated meta-description
  • Full typing of attributes and parameters
  • Full documentation of attributes and parameters
  • More usable exceptions raised in case on problems with the API
  • Some bugs and limitations fixed, special thanks to bilderbuchi, roskakori and tallforasmurf for reporting them!

Pre-release versions

Version 0.7 (May 26th, 2012)

  • Use PyGithub with OAuth authentication or with no authentication at all

Version 0.6 (April 17th, 2012)

  • Fix issue 21 (KeyError when accessing repositories)
  • Re-completed the API with NamedUser.create_gist

Version 0.5 (March 19th, 2012)

  • Major achievement: all APIs are implemented
  • More refactoring, of course

Version 0.4 (March 12th, 2012)

  • The list of the not implemented APIs is shorter than the list of the implemented APIs
  • APIs not implemented:
    • GET /gists/public
    • GET /issues
    • GET /repos/:owner/:repo/compare/:base...:head
    • GET /repos/:owner/:repo/git/trees/:sha?recursive-1
    • POST /repos/:owner/:repo/git/trees?base_tree-
  • Gists
  • Authorizations
  • Keys
  • Hooks
  • Events
  • Merge pull requests
  • More refactoring, one more time

Version 0.3 (February 26th, 2012)

  • More refactoring
  • Issues, milestones and their labels
  • NamedUser:
    • emails
  • Repository:
    • downloads
    • tags, branches, commits and comments (not the same as "Git objects" of version 0.2)
    • pull requests (no automatic merge yet)
  • Automatic generation of the reference documentation of classes, with less "see API"s, and less errors

Version 0.2 (February 23rd, 2012)

  • Refactoring
  • Teams details and modification
    • basic attributes
    • list teams in organizations, on repositories
  • Git objects
    • create and get tags, references, commits, trees, blobs
    • list and edit references

Version 0.1 (February 19th, 2012)

  • User details and modification
    • basic attributes
    • followers, following, watching
    • organizations
    • repositories
  • Repository details and modification
    • basic attributes
    • forking
    • collaborators, contributors, watchers
  • Organization details and modification
    • basic attributes
    • members and public members