Releases | Open Source Science

What's Changed

Breaking Changes

Method Github.get_rate_limit() now returns RateLimitOverview rather than RateLimit (https://github.com/PyGithub/PyGithub/pull/3205).

Code like

python gh.get_rate_limit().core.remaining

should be replaced with

python gh.get_rate_limit().resources.core.remaining

Method GitTag.verification now returns GitCommitVerification rather than dict[str, Any] (https://github.com/PyGithub/PyGithub/pull/3226).

Code like

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

should be replaced with

python tag.verification.reason

New Features

Add getting list of self-hosted runners of organization by @climbfuji in https://github.com/PyGithub/PyGithub/pull/3190
Apply OpenAPI spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3317
Add support for Sub-Issues by @e7217 in https://github.com/PyGithub/PyGithub/pull/3258

Improvement

Refactor search results into separate classes by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3204
Add OrganizationInvitation by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3207
Add and apply missing schemas by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3209
Sync RepositoryAdvisory tests with OpenAPI spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3215
Sync ProjectColumn and ProjectCard tests with OpenAPI spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3216
Sync CopilotSeat class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3232
Sync HookDeliverySummary class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3233
Sync RequiredPullRequestReviews class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3234
Sync RequiredStatusChecks class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3236
Sync Team class with API spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3237
Replace deprecated.deprecated() with typing_extensions.deprecated() by @lazka in https://github.com/PyGithub/PyGithub/pull/3255
fix(CodeScanAlert): add missing attributes by @ReenigneArcher in https://github.com/PyGithub/PyGithub/pull/3274
Allow SHAs when creating PR comments by @tuchfarber in https://github.com/PyGithub/PyGithub/pull/3248
Get collaborator role name by @jmgate in https://github.com/PyGithub/PyGithub/pull/3295
Adding prevent_self_review property to Repository.createEnvironment by @gopidesupavan in https://github.com/PyGithub/PyGithub/pull/3246
Add PullRequest.get_issue_timeline method by @kukarkinmm in https://github.com/PyGithub/PyGithub/pull/3259
Support built-in reversed() on PaginatedList by @mfocko in https://github.com/PyGithub/PyGithub/pull/3260
Relax 404 condition in Requester exception handling by @jsmolar in https://github.com/PyGithub/PyGithub/pull/3299
Add delete_self_hosted_runner to Organization by @uncleDecart in https://github.com/PyGithub/PyGithub/pull/3306

Bug Fixes

Fix broken pickle support for Auth classes by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3211
Remove schema from Deployment, remove message attribute by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3223
Fix incorrect deprecated import by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3225
Add CodeSecurityConfigRepository returned by get_repos_for_code_security_config by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3219
Fix Branch.get_required_status_checks return type by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3235
Adds multi_select and true_false options to CustomProperty.value_type by @gfog-floqast in https://github.com/PyGithub/PyGithub/pull/3173
Fix url encoding of strings with slashes in URLs by @OscarVanL in https://github.com/PyGithub/PyGithub/pull/3263
Fix side-effect when removing Authorization key from headers by @alecglen in https://github.com/PyGithub/PyGithub/pull/3313
Make TimingData.run_duration_ms optional by @LifeLex in https://github.com/PyGithub/PyGithub/pull/3268
Normalize App ID to String & Enhance JWT Issuer Verification by @x612skm in https://github.com/PyGithub/PyGithub/pull/3272

Dependencies

Bump actions/checkout from 3 to 4 by @dependabot[bot] in https://github.com/PyGithub/PyGithub/pull/2754

Maintenance

Mention removal of AppAuth.private_key in changelog by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3212
Remove wrong schema from Repository by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3220
Rename HookDeliveryRequest and …Response private headers fields by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3221
Sort classes' functions by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3231
Move all Python files to future annotations by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3241
Fix return type of PaginatedList[int] by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3240
Sync with OpenAPI spec by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3244
Make token auth default in tests by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3242
Add Organization.get_repos_for_code_security_config test by @billnapier in https://github.com/PyGithub/PyGithub/pull/3239
Add Python 3.13 to CI by @lazka in https://github.com/PyGithub/PyGithub/pull/3253
Enhance PyGithub webhook documentation by @ssganesh035 in https://github.com/PyGithub/PyGithub/pull/3267
Create codeql.yml by @JLLeitschuh in https://github.com/PyGithub/PyGithub/pull/3277
Add schema to TimingData by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3206
Remove error schemas from classes by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3202

New Contributors

@ssganesh035 made their first contribution in https://github.com/PyGithub/PyGithub/pull/3267
@ReenigneArcher made their first contribution in https://github.com/PyGithub/PyGithub/pull/3274
@climbfuji made their first contribution in https://github.com/PyGithub/PyGithub/pull/3190
@tuchfarber made their first contribution in https://github.com/PyGithub/PyGithub/pull/3248
@jmgate made their first contribution in https://github.com/PyGithub/PyGithub/pull/3295
@gopidesupavan made their first contribution in https://github.com/PyGithub/PyGithub/pull/3246
@kukarkinmm made their first contribution in https://github.com/PyGithub/PyGithub/pull/3259
@mfocko made their first contribution in https://github.com/PyGithub/PyGithub/pull/3260
@gfog-floqast made their first contribution in https://github.com/PyGithub/PyGithub/pull/3173
@jsmolar made their first contribution in https://github.com/PyGithub/PyGithub/pull/3299
@OscarVanL made their first contribution in https://github.com/PyGithub/PyGithub/pull/3263
@alecglen made their first contribution in https://github.com/PyGithub/PyGithub/pull/3313
@LifeLex made their first contribution in https://github.com/PyGithub/PyGithub/pull/3268
@e7217 made their first contribution in https://github.com/PyGithub/PyGithub/pull/3258
@x612skm made their first contribution in https://github.com/PyGithub/PyGithub/pull/3272
@uncleDecart made their first contribution in https://github.com/PyGithub/PyGithub/pull/3306

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

- Python
Published by EnricoMi 7 months ago

Bug Fixes

Fix broken pickle support for Auth classes by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3211
Remove schema from Deployment, remove message attribute by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3223
Fix incorrect deprecated import by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3225
Add CodeSecurityConfigRepository returned by get_repos_for_code_security_config by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3219
Make GitTag.verification return GitCommitVerification by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3226

Maintenance

Mention removal of AppAuth.private_key in changelog by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/3212

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

- Python
Published by EnricoMi about 1 year ago

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 creategitrelease and creategittagandrelease 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

- Python
Published by EnricoMi about 1 year ago

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

Rework GraphQL mutations @EnricoMi (#3046)
Make pagination work with GraphQL response data @EnricoMi (#3047)
Add RepositoryDiscussion powered by GraphQL API @EnricoMi (#3048)
Add Repository.get_discussion() to get a single Discussion @tiangolo (#3072)

Improvements

Adds List organization memberships for the authenticated user @eduramirezh (#3040)
Add actor property to WorkflowRun @gbhand (#2764)
Make requester a public attribute @minrk (#3056)

Bug Fixes

Fix requesting urls containing parameters with parameters dict @EnricoMi (#2929)
PullRequest.delete_branch: fix the remaining pull requests check @fetsko (#3063)

Maintenance

Remove stale bot @EnricoMi (510c1402)
Upgrade Github actions @EnricoMi (#3075)
Add top issues dashboard action @EnricoMi (#3049)
Make tests pass some more years @bmwiedemann (#3045)
Run top issues workflow only in PyGithub repo @EnricoMi (0d395d4e)
Replace pre-commit action in order to pin pre-commit @minrk (#3059)

- Python
Published by github-actions[bot] over 1 year ago

New features

Allow custom authentication @kliem (#2987)

Improvements

Add has_discussions to AuthenticatedUser and Repository classes @cwlls (#3020)
Update more SecurityAndAnalysis attributes @squatched (#3025)
Implement support for re-running only failed workflow jobs. @chrisgavin (#2983)
Add possibility to mark a thread/notification as done @m42e (#2985)
Add "pull_request_review_id" to PullRequestComment object @stroebs (#3000)
Add minimize and unminimize functions for IssueComment class @arash77 (#3005)
Support Organization/Repository custom properties @jackylamhk (#2968)
Add dict type to add_attribute script @jackylamhk (#2977)
Allow for deleting and restoring branch associated with PR @austinsasko (#1784)
Add "archived_at" to Organization object. @billnapier (#2974)
Adds Security & Analysis To Repository @squatched (#2960)
Add added_by and last_used attributes to RepositoryKey @ramiro (#2952)
Add make_latest to GitRelease.update_release @treee111 (#2888)
Make Commit.files return PaginatedList @iarspider (#2939)

Bug Fixes

Fix GraphQL Queries with Variables @kgal-pan (#3002)

Maintenance

Remove support for Python 3.7 @EnricoMi @khneal (#3008, #2975)
docs: add missing code-block @kumy (#2982)
Update README.md @KPCOFGS (#2961)
CI: Fix test success job @EnricoMi (#3010)

- Python
Published by EnricoMi over 1 year ago

New features

Support oauth for enterprise @EnricoMi (#2780)
Support creation of Dependabot Organization and Repository Secrets @thomascrowley (#2874)

Improvements

Create release with optional name and message when generate_release_notes is true @heitorpolidoro (#2868)
Add missing attributes to WorkflowJob @xvega (#2921)
Add created and check_suite_id filter for Repository Workflow runs @treee111 (#2891)
Assert requester argument type in Auth @EnricoMi (#2912)

Bug Fixes

Revert having allowed values for add_to_collaborators @jodelasur (#2905)

Maintenance

Fix imports in authentication docs @wurstbrot (#2923)
CI: add docformatter to precommit @Borda (#2614)
Add .swp fils to .gitignore @boomanaiden154 (#2903)
Fix instructions building docs in CONTRIBUTING.md @wakamex (#2900)
Explicitly name the modules built in pyproject.toml @treee111 (#2894)

- Python
Published by github-actions[bot] almost 2 years ago

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:

python commits = repo.compare("v0.6", "v0.7").commits no_of_commits = len(commits) # will raise a TypeError

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:

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

New features

Add support to call GraphQL API

Improvements

Add parentteamid, maintainers and notification_setting for creating and updating teams. by @Cheshirez in https://github.com/PyGithub/PyGithub/pull/2863
Add support for issue reactions summary by @smuzaffar in https://github.com/PyGithub/PyGithub/pull/2866
Support for DependabotAlert APIs by @coopernetes in https://github.com/PyGithub/PyGithub/pull/2879
Derive GraphQL URL from base_url by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2880
Make Repository.compare().commits return paginated list by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2882
Add missing branch protection fields by @treee111 in https://github.com/PyGithub/PyGithub/pull/2873
Add include_all_branches to create_repo_from_template of AuthenticatedUser and Organization by @janssonoskar in https://github.com/PyGithub/PyGithub/pull/2871
Add and update organisation dependabot secrets by @mohy01 in https://github.com/PyGithub/PyGithub/pull/2316
Add missing params to Organization.create_repo by @tekumara in https://github.com/PyGithub/PyGithub/pull/2700
Update allowed values for Repository collaborator permissions by @flying-sheep in https://github.com/PyGithub/PyGithub/pull/1996
Support editing PullRequestReview by @ColasGael in https://github.com/PyGithub/PyGithub/pull/2851
Update attributes after calling PullRequestReview.dismiss by @ColasGael in https://github.com/PyGithub/PyGithub/pull/2854
Add request_cve on RepositoryAdvisories by @JLLeitschuh in https://github.com/PyGithub/PyGithub/pull/2855
Filter collaborators of a repository by permissions by @notmicaelfilipe in https://github.com/PyGithub/PyGithub/pull/2792
Set pull request to auto merge via GraphQL API by @heitorpolidoro in https://github.com/PyGithub/PyGithub/pull/2816
Support Environment Variables and Secrets by @AndrewJDawes in https://github.com/PyGithub/PyGithub/pull/2848
Update workflow.getruns & pullrequest.addto_assignees function signature by @sd-kialo in https://github.com/PyGithub/PyGithub/pull/2799
Add GithubObject.last_modified_datetime to have last_modified as a datetime by @chouetz in https://github.com/PyGithub/PyGithub/pull/2772
Add support for global advisories and unify some shared logic with repository advisories by @crimsonknave in https://github.com/PyGithub/PyGithub/pull/2702
Add internal as valid Repository visibility value by @AndrewJDawes in https://github.com/PyGithub/PyGithub/pull/2806
Add support for issue comments reactions summary by @smuzaffar in https://github.com/PyGithub/PyGithub/pull/2813

Bug Fixes

Add a bunch of missing urllib.parse.quote calls by @ExplodingCabbage in https://github.com/PyGithub/PyGithub/pull/1976
Fix Variable and Secret url bugs by @AndrewJDawes in https://github.com/PyGithub/PyGithub/pull/2835

Maintenance

Update the class name for NetrcAuth in the examples by @vinnybod in https://github.com/PyGithub/PyGithub/pull/2860
Move build to PEP517 by @trim21 in https://github.com/PyGithub/PyGithub/pull/2800
Use new type assert functions in Repository by @trim21 in https://github.com/PyGithub/PyGithub/pull/2798
PyTest: Move config to pyproject.toml by @Borda in https://github.com/PyGithub/PyGithub/pull/2859
codespell: ignore-words-list by @Borda in https://github.com/PyGithub/PyGithub/pull/2858
Improve fix-headers.py script by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2728
Remove dependency on python-dateutil by @lazka in https://github.com/PyGithub/PyGithub/pull/2804
CI: update precommit & apply by @Borda in https://github.com/PyGithub/PyGithub/pull/2600
Docs: Fix parameter order according to Version 2.1.0 by @nad182 in https://github.com/PyGithub/PyGithub/pull/2786
Add missing GitHub classes to docs by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2783
CI: Fix mypy error by ignoring override by @EnricoMi in https://github.com/PyGithub/PyGithub/pull/2779

Full Changelog: https://github.com/PyGithub/PyGithub/compare/v2.1.1...v2.2.0

- Python
Published by EnricoMi about 2 years ago

pygithub - v2.1.1

Bug Fixes

Require urllib 1.26.0 or greater (#2774) (001c0852)

Maintenance

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

- Python
Published by EnricoMi over 2 years ago

pygithub - v2.1.0.post0

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:

python 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

python 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:

python 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.Netrc instance to use Netrc credentials:

```python

auth = Auth.Netrc() g = Github(auth=auth) g.get_user().login 'login' ```

Repository.create_pull

Merged overloaded create_pull methods

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

into

python 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

Throttle requests to mitigate RateLimitExceededExceptions (#2145) (99155806)
Retry retryable 403 (rate limit) (#2387) (0bb72ca0)
Close connections after use (#2724) (73236e23)

Improvements

Make datetime objects timezone-aware (#2565) (0177f7c5)
Make Branch.edit_* functions return objects (#2748) (8dee53a8)
Add license attribute to Repository (#2721) (26d353e7)
Add missing attributes to Repository (#2742) (65cfeb1b)
Add is_alphanumeric attribute to Autolink and Repository.create_autolink (#2630) (b6a28a26)
Suppress requests fallback to netrc, provide github.Auth.Netrc (#2739) (ac36f6a9)
Pass Requester arguments to AppInstallationAuth.__integration (#2695) (8bf542ae)
Adding feature for enterprise consumed license (#2626) (a7bfdf2d)
Search Workflows by Name (#2711) (eadc241e)
Add Secret and Variable classes (#2623) (bcca758d)
Add Autolink API link (#2632) (aedfa0b9)
Add required_linear_history attribute to BranchProtection (#2643) (7a80fad9)
Add retry issue to GithubException, don't log it (#2611) (de80ff4b)
Add message property to GithubException (#2591) (f087cad3)
Add support for repo and org level actions variables (#2580) (91b3f40f)
Add missing arguments to Workflow.get_runs() (#2346) (766df993)
Add github.Rate.used field (#2531) (c4c2e527)

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

Epic mass-merge .pyi type stubs back to .py sources (#2636)
Move to main default branch (#2566) (e66c163a)
Force Unix EOL (#2573) (094538e1)
Close replay test data file silently when test is failing already (#2747) (6d871d56)
CI: Make CI support merge queue (#2644) (a91debf1)
CI: Run CI on release branches (#2708) (9a88b6b1)
CI: remove conflict label workflow (#2669) (95d8b83c)
Fix pip install command in README.md (#2731) (2cc1ba2c)
Update add_attribute.py to latest conding style (#2631) (e735972e)
CI: Improve ruff DX (#2667) (48d2009c)
CI: Increase wait and retries of labels action (#2670) (ff0f31c2)
Replace flake8 with ruff (#2617) (42c3b47c)
CI: update labels action name and version (#2654) (c5c83eb5)
CI: label PRs that have conflicts (#2622) (1d637e4b)
Unify requirements files location & source in setup.py (#2598) (2edc0f8f)
Enable mypy disallow_untyped_defs (#2609) (294c0cc9)
Enable mypy check_untyped_defs (#2607) (8816889a)
Set line length to 120 characters (#2599) (13e178a3)
CI: Build and check package before release (#2593) (3c880e76)
Use typing_extensions for TypedDict (#2592) (5fcb0c7d)
CI: Update action actions/setup-python (#2382) (2e5cd31e)
Add more methods and attributes to Repository.pyi (#2581) (72840de4)
CI: Make pytest color logs (#2597) (73241102)
precommit: move flake8 as last (#2595) (11bb6bd7)
Test on Windows and macOS, don't fail fast (#2590) (5c600894)
Remove symlinks from test data (#2588) (8d3b9057)

- Python
Published by EnricoMi over 2 years ago

pygithub - v2.0.1-preview

Bug Fixes

Safely coerce responseHeaders to int (#2697) (64705bfd)

- Python
Published by EnricoMi over 2 years ago

pygithub - v1.59.1

Bug Fixes

Safely coerce responseHeaders to int (#2697) (adbfce92)

- Python
Published by EnricoMi over 2 years ago

pygithub - v2.0.0-preview.1

Bug Fixes

Add retry issue to GithubException, don't log it (#2611) (3f0c1a6b)
Use timezone-aware reset datetime in GithubRetry.py (#2610) (0a7b7bac)

- Python
Published by EnricoMi over 2 years ago

pygithub - v2.0.0-preview

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

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):
    ...

New features

Throttle requests to mitigate RateLimitExceededExceptions (#2145) (99155806)
Retry retryable 403 (rate limit) (#2387) (0bb72ca0)

Improvements

Make datetime objects timezone-aware (#2565) (0177f7c5)

Bug Fixes

Fix Branch.bypass_pull_request_allowances failing with "nil is not an object" (#2535) (c5542a6a)

Maintenance

Move to main default branch (#2566) (e66c163a)
Force Unix EOL (#2573) (094538e1)
Merge Artifact type stub back to source (#2553)

- Python
Published by github-actions[bot] over 2 years ago

pygithub - v1.59.0

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 callinggithub.PullRequest.getreviewcomments(…)with this argument as positional argument breaks. Please use keyword argument:github.PullRequest.getreviewcomments(since=…)`.

Deprecations

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 :tada: (#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 allowautomerge support to Repository (#2477) (8c4b9465)
Add artifact_id argument to Repository.get_artifact() (#2458) (4fa0a5f3)
Add missing attributes to Branch (#2512) (e296dbdb)
Add allowupdatebranch option to Organization (#2465) (bab4180f)
Add support for Issue.state_reason #2370 (#2392) (5aa544a1)
Add parameters to Repository.getworkflowruns (#2408) (4198dbfb)

Maintenance

Add type stub for MainClass.getprojectcolumn (#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 allowforking and allowupdate_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 usescmversion to get current version from git tag (#2429) (3ea91a3a)

- Python
Published by github-actions[bot] over 2 years ago

pygithub - v1.58.2

Fixes

Fix GithubIntegration that uses expiring jwt @EnricoMi (#2460)

- Python
Published by EnricoMi almost 3 years ago

pygithub - v1.58.1

Changes

Bump actions/checkout from 2 to 3.1.0 @dependabot (#2327)
Add crypto extras to pyjwt, which pulls in cryptogaphy package @EnricoMi (#2443)
Move CI to Python 3.11 release and 3.12 dev @EnricoMi (#2434)

Bug Fixes

Add expiration argument back to GithubIntegration.create_jwt @EnricoMi (#2439)
Remove RLock from Requester @EnricoMi (#2446)
Pass requester base URL to integration (#2420) @bluek1te (#2425)
Use use_scm_version to get current version from git tag @sfdye (#2429)

- Python
Published by github-actions[bot] almost 3 years ago

pygithub - v1.58.0

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)

- Python
Published by github-actions[bot] about 3 years ago

pygithub - v1.57

Breaking Changes

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

Bug Fixes & Improvements

Speed up get requested reviewers and teams for pr (#2349) (6725eceb)
[WorkflowRun] - Add missing attributes (run_started_at & run_attempt), remove deprecated unicode type (#2273) (3a6235b5)
Add support for repository autolink references (#2016) (0fadd6be)
Add retry and pool_size to typing (#2151) (784a3efd)
Fix/types for repo topic team (#2341) (db9337a4)
Add class Artifact (#2313) (#2319) (437ff845)

- Python
Published by sfdye over 3 years ago

Recent Releases of pygithub

pygithub - v2.7.0

What's Changed

Breaking Changes

New Features

Improvement

Bug Fixes

Dependencies

Maintenance

New Contributors

pygithub - v2.6.1

Bug Fixes

Maintenance

pygithub - v2.6.0

Breaking Changes

New Features

Improvements

Bug Fixes

Others

Maintenance

New Contributors

pygithub - v2.5.0

Breaking Changes

New features

Improvements

Bug Fixes

Maintenance

pygithub - v2.4.0

New features

Improvements

Bug Fixes

Maintenance

pygithub - v2.3.0

New features

Improvements

Bug Fixes

Maintenance

pygithub - v2.2.0

Breaking Changes

New features

Improvements

Bug Fixes

Maintenance

pygithub - v2.1.1

Bug Fixes

Maintenance

pygithub - v2.1.0.post0

Important

Request throttling

Request retry

Breaking Changes

Timestamps

Netrc authentication

Repository.create_pull

New features

Improvements

Bug Fixes

Maintenance

pygithub - v2.0.1-preview

Bug Fixes

pygithub - v1.59.1

Bug Fixes

pygithub - v2.0.0-preview.1

Bug Fixes

pygithub - v2.0.0-preview

Important

Request throttling

Request retry

Breaking Changes

New features

Improvements

Bug Fixes

Maintenance

pygithub - v1.59.0

Important

Breaking Changes

Deprecations

Bug Fixes

Improvements

Maintenance