PyGitHub Files

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