PyGitHub Files

Breaking Changes

• Rework Views and Clones by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3168: 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

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

should be replaced with

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

• Fix typos by @kianmeng in https://github.com/PyGithub/PyGithub/pull/3086: Property OrganizationCustomProperty.respository_id renamed to OrganizationCustomProperty.repository_id.

New Features

• Add capability for global laziness by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2746
• Add Support for GitHub Copilot Seat Management in Organizations by @pashafateev in https://github.com/PyGithub/PyGithub/pull/3082
• Get branches where commit is head by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3083
• Support downloading a Release Asset by @neel-m in https://github.com/PyGithub/PyGithub/pull/3060
• Add Repository.merge_upstream method by @Felixoid in https://github.com/PyGithub/PyGithub/pull/3175
• Support updating pull request draft status by @didot in https://github.com/PyGithub/PyGithub/pull/3104
• Add transfer ownership method to Repository by @tanannie22 in https://github.com/PyGithub/PyGithub/pull/3091
• Add enable and disable a Workflow by @nickrmcclorey in https://github.com/PyGithub/PyGithub/pull/3088
• Add support for managing Code Security Configrations by @billnapier in https://github.com/PyGithub/PyGithub/pull/3095
• Allow for private_key / sign function in AppAuth by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3065

Improvements

• Update RateLimit object with all the new categories GitHub added. by @billnapier in https://github.com/PyGithub/PyGithub/pull/3096
• Add support for make-latest to create_git_release and create_git_tag_and_release by @SebastienSyd in https://github.com/PyGithub/PyGithub/pull/3067
• Add branch protection support for required_status_checks.checks object by @treee111 in https://github.com/PyGithub/PyGithub/pull/2884
• Use id and tree_id from simple-commit to populate GitCommit.sha and GitCommit.tree by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3167
• Use message of response in GithubException by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3185
• Sync Advisory classes with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3193
• Sync Branch class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3109
• Sync BranchProtection class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3110
• Sync CheckRunAnnotation class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3112
• Sync CheckRun class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3111
• Sync CheckSuite class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3113
• Sync Commit class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3116
• Sync CommitComment class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3117
• Sync CommitStatus class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3118
• Sync ContentFile class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3119
• Sync DependabotAlert class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3120
• Sync Deployment class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3121
• Sync DeploymentStatus class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3122
• Sync Gist class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3123
• Sync GistComment class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3124
• Sync GitBlob class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3125
• Sync GitCommit class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3126
• Sync GithubApp class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3127
• Sync GitRef class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3128
• Sync GitReleaseAsset class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3130
• Sync GitRelease class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3129
• Sync GitTag class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3131
• Sync GitTree class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3132
• Sync Hook class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3133
• Sync HookDelivery class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3134
• Sync InstallationAuthorization class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3136
• Sync Installation class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3135
• Sync Invitation class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3139
• Sync Issue class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3140
• Sync IssueComment class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3141
• Sync IssueEvent class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3142
• Sync IssuePullRequest class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3143
• Sync Label class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3144
• Sync License class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3145
• Sync Membership class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3146
• Sync Migration class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3147
• Sync Milestone class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3148
• Sync NamedUser class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3149
• Sync Organization class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3150
• Sync OrganizationCustomProperty class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3151
• Sync Project class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3194
• Sync PublicKey class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3152
• Sync PullRequest class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3153
• Sync PullRequestComment class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3154
• Sync RateLimit class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3155
• Sync Repository class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3156
• Sync RepositoryKey class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3157
• Sync SecurityAndAnalysis class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3158
• Sync SelfHostedActionsRunner class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3159
• Sync SourceImport class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3160
• Sync Tag class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3161
• Sync Team class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3162
• Sync Topic class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3163
• Sync UserKey class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3164
• Sync Workflow class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3165
• Sync WorkflowRun class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3166

Bug Fixes

• Patch httpretty socket for latest urllib3 release by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3102
• Fix API break when contents not found by @skinitimski in https://github.com/PyGithub/PyGithub/pull/3181
• Change start_side argument of PullRequest.create_review_comment from int to str by @ryanpeach in https://github.com/PyGithub/PyGithub/pull/3170
• Create Review Request - transform string params to a list by @a-sido in https://github.com/PyGithub/PyGithub/pull/3099
• Fix Repository.get_contents redirection by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3183

Others

• Make conclusion nullable in WorkflowJob.py by @Apakottur in https://github.com/PyGithub/PyGithub/pull/3171
• Rename Github.get_organization argument login to org by @blyedev in https://github.com/PyGithub/PyGithub/pull/3187
• Make NotSet an Attribute[Any] by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3057

Maintenance

• Sort attributes and properties in GitHub classes by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3105
• Preparations for maintaining Github classes by code by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3106
• Annotate Github classes with API schemas by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3107
• Make Pickle test use recorded data by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3137
• Add tests for file and stream downloads by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3182
• Use responses instead of httpretty in tests by @majamassarini in https://github.com/PyGithub/PyGithub/pull/3087
• [CI] Publish test results by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3195
• Link Commit to correct upstream documentation by @xmo-odoo in https://github.com/PyGithub/PyGithub/pull/2936
• Replace release drafter with Github release note generation by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3196
• Add maintenance label to release.yml by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3197

New Contributors

• @pashafateev made their first contribution in https://github.com/PyGithub/PyGithub/pull/3082
• @SebastienSyd made their first contribution in https://github.com/PyGithub/PyGithub/pull/3067
• @kianmeng made their first contribution in https://github.com/PyGithub/PyGithub/pull/3086
• @neel-m made their first contribution in https://github.com/PyGithub/PyGithub/pull/3060
• @skinitimski made their first contribution in https://github.com/PyGithub/PyGithub/pull/3181
• @majamassarini made their first contribution in https://github.com/PyGithub/PyGithub/pull/3087
• @didot made their first contribution in https://github.com/PyGithub/PyGithub/pull/3104
• @Apakottur made their first contribution in https://github.com/PyGithub/PyGithub/pull/3171
• @tanannie22 made their first contribution in https://github.com/PyGithub/PyGithub/pull/3091
• @ryanpeach made their first contribution in https://github.com/PyGithub/PyGithub/pull/3170
• @a-sido made their first contribution in https://github.com/PyGithub/PyGithub/pull/3099
• @nickrmcclorey made their first contribution in https://github.com/PyGithub/PyGithub/pull/3088
• @blyedev made their first contribution in https://github.com/PyGithub/PyGithub/pull/3187

Full Changelog: https://github.com/PyGithub/PyGithub/compare/v2.5.0...v2.6.0