Changelog
### 1.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)
```
### 1.56
```
-----------------------------------
**Important**
This is the last release that will support Python 3.6.
**Bug Fixes & Improvements**
* Create repo from template (2090) (b50283a7)
* Improve signature of Repository.create_repo (2118) (001970d4)
* Add support for 'visibility' attribute preview for Repositories (1872) (8d1397af)
* Add Repository.rename_branch method (2089) (6452ddfe)
* Add function to delete pending reviews on a pull request (1897) (c8a945bb)
* Cover all code paths in search_commits (2087) (f1faf941)
* Correctly deal when PaginatedList's data is a dict (2084) (93b92cd2)
* Add two_factor_authentication in AuthenticatedUser. (1972) (4f00cbf2)
* Add ProjectCard.edit() to the type stub (2080) (d417e4c4)
* Add method to delete Workflow runs (2078) (b1c8eec5)
* Implement organization.cancel_invitation() (2072) (53fb4988)
* Feat: Add `html_url` property in Team Class. (1983) (6570892a)
* Add support for Python 3.10 (2073) (aa694f8e)
* Add github actions secrets to org (2006) (bc5e5950)
* Correct replay for Organization.create_project() test (2075) (fcc12368)
* Fix install command example (2043) (99e00a28)
* Fix: 1671 Convert Python Bool to API Parameter for Authenticated User Notifications (2001) (1da600a3)
* Do not transform requestHeaders when logging (1965) (1265747e)
* Add type to OrderedDict (1954) (ed7d0fe9)
* Add Commit.get_pulls() to pyi (1958) (b4664705)
* Adding headers in GithubException is a breaking change (1931) (d1644e33)
```
### 1.55
```
-----------------------------------
**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**
* Do not import from unpackaged paths in typing (1926) (27ba7838)
* Implement hash for CompletableGithubObject (1922) (4faff23c)
* Use property decorator to improve typing compatibility (1925) (e4168109)
* Fix :rtype: directive (1927) (54b6a97b)
* Update most URLs to docs.github.com (1896) (babcbcd0)
* Tighten asserts for new Permission tests (1893) (5aab6f5d)
* Adding attributes "maintain" and "triage" to class "Permissions" (1810) (76879613)
* Add default arguments to Workflow method type annotations (1857) (7d6bac9e)
* Re-raise the exception when failing to parse JSON (1892) (916da53b)
* Allow adding attributes at the end of the list (1807) (0245b758)
* Updating links to Github documentation for deploy keys (1850) (c27fb919)
* Update PyJWT Version to 2.0+ (1891) (a68577b7)
* Use right variable in both get_check_runs() (1889) (3003e065)
* fix bad assertions in github.Project.edit (1817) (6bae9e5c)
* Test repr() for PublicKey (1879) (e0acd8f4)
* Add support for deleting repository secrets (1868) (696793de)
* Switch repository secrets to using f-strings (1867) (aa240304)
* Manually fixing paths for codecov.io to cover all project files (1813) (b2232c89)
* Add missing links to project metadata (1789) (64f532ae)
* No longer show username and password examples (1866) (55d98373)
* Adding github actions secrets (1681) (c90c050e)
* fix get_user_issues (1842) (7db1b0c9)
* Switch all string addition to using f-strings (1774) (290b6272)
* Enabling connection pool_size definition (a77d4f48)
* Always define the session adapter (aaec0a0f)
```
### 1.54.1
```
-----------------------------------
* Pin pyjwt version (1797) (31a1c007)
* Add pyupgrade to pre-commit configuration (1783) (e113e37d)
* Fix 1731: Incorrect annotation (82c349ce)
* Drop support for Python 3.5 (1770) (63e4fae9)
* Revert "Pin requests to <2.25 as well (1757)" (1763) (a806b523)
* Fix stubs file for Repository (fab682a5)
```
### 1.54
```
-----------------------------------
**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**
* Add support for Check Suites (1764) (6d501b28)
* Add missing preview features of Deployment and Deployment Statuses API (1674) (197e0653)
* Correct typing for Commit.get_comments() (1765) (fcdd9eae)
* Pin requests to <2.25 as well (1757) (d159425f)
* Add Support for Check Runs (1727) (c77c0676)
* Added a method for getting a user by their id (1691) (4cfc9912)
* Fix 1742 - incorrect typehint for `Installation.id` (1743) (546f6495)
* Add WorkflowRun.workflow_id (1737) (78a29a7c)
* Add support for Python 3.9 (1735) (1bb18ab5)
* Added support for the Self-Hosted actions runners API (1684) (24251f4b)
* Fix Branch protection status in the examples (1729) (88800844)
* Filter the DeprecationWarning in Team tests (1728) (23f47539)
* Added get_installations() to Organizations (1695) (b42fb244)
* Fix 1507: Add new Teams: Add or update team repository endpoint (1509) (1c55be51)
* Added support for `Repository.get_workflow_runs` parameters (1682) (c23564dd)
* feat(pullrequest): add the rebaseable attribute (1690) (ee4c7a7e)
* Add support for deleting reactions (1708) (f7d203c0)
* Correct type hint for InputGitTreeElement.sha (08b72b48)
* Ignore new black formatting commit for git blame (1680) (7ec4f155)
* Format with new black (1679) (07e29fe0)
* Add get_timeline() to Issue's type stubs (1663) (6bc9ecc8)
```
### 1.53
```
-----------------------------------
* Test Organization.get_hook() (1660) (2646a98c)
* Add method get_team_membership for user to Team (1658) (749e8d35)
* Add typing files for OAuth classes (1656) (429fcc73)
* Fix Repository.create_repository_dispatch type signature (1643) (f891bd61)
* PaginatedList's totalCount is 0 if no last page (1641) (69b37b4a)
* Add initial support for Github Apps. (1631) (260558c1)
* Correct **kwargs typing for search_* (1636) (165d995d)
* Add delete_branch_on_merge arg to Repository.edit type stub (1639) (15b5ae0c)
* Fix type stub for MainClass.get_user (1637) (8912be64)
* Add type stub for Repository.create_fork (1638) (de386dfb)
* Correct Repository.create_pull typing harder (1635) (5ad091d0)
```
### 1.52
```
-----------------------------------
* upload_asset with data in memory (1601) (a7786393)
* Make Issue.closed_by nullable (1629) (06dae387)
* Add support for workflow dispatch event (1625) (16850ef1)
* Do not check reaction_type before sending (1592) (136a3e80)
* Various Github Action improvement (1610) (416f2d0f)
* more flexible header splitting (1616) (85e71361)
* Create Dependabot config file (1607) (e272f117)
* Add support for deployment statuses (1588) (048c8a1d)
* Adds the 'twitter_username' attribute to NamedUser. (1585) (079f75a7)
* Create WorkflowRun.timing namedtuple from the dict (1587) (1879518e)
* Add missing properties to PullRequest.pyi (1577) (c84fad81)
* Add support for Workflow Runs (1583) (4fb1d23f)
* More precise typing for Repository.create_pull (1581) (4ed7aaf8)
* Update sphinx-rtd-theme requirement from <0.5 to <0.6 (1563) (f9e4feeb)
* More precise typing for MainClass.get_user() (1575) (3668f866)
* Small documentation correction in Repository.py (1565) (f0f6ec83)
* Remove "api_preview" parameter from type stubs and docstrings
(1559) (cc1b884c)
* Upgrade actions/setup-python to v2 (1555) (6f1640d2)
* Clean up tests for GitReleaseAsset (1546) (925764ad)
* Repository.update_file() content also accepts bytes (1543) (9fb8588b)
* Fix Repository.get_issues stub (1540) (b40b75f8)
* Check all arguments of NamedUser.get_repos() (1532) (69bfc325)
* Correct Workflow typing (1533) (f41c046f)
* Remove RateLimit.rate (1529) (7abf6004)
* PullRequestReview is not a completable object (1528) (19fc43ab)
* Test more attributes (1526) (52ec366b)
* Remove pointless setters in GitReleaseAsset (1527) (1dd1cf9c)
* Drop some unimplemented methods in GitRef (1525) (d4b61311)
* Remove unneeded duplicate string checks in Branch (1524) (61b61092)
* Turn on coverage reporting for codecov (1522) (e79b9013)
* Drastically increase coverage by checking repr() (1521) (291c4630)
* Fixed formatting of docstrings for `Repository.create_git_tag_and_release()`
and `StatsPunchCard`. (1520) (ce400bc7)
* Remove Repository.topics (1505) (53d58d2b)
* Small improvements to typing (1517) (7b20b13d)
* Correct Repository.get_workflows() (1518) (8727003f)
* docs(repository): correct releases link (1514) (f7cc534d)
* correct Repository.stargazers_count return type to int (1513) (b5737d41)
* Fix two RST warnings in Webhook.rst (1512) (5a8bc203)
* Filter FutureWarning for 2 test cases (1510) (09a1d9e4)
* Raise a FutureWarning on use of client_{id,secret} (1506) (2475fa66)
* Improve type signature for create_from_raw_data (1503) (c7b5eff0)
* feat(column): move, edit and delete project columns (1497) (a32a8965)
* Add support for Workflows (1496) (a1ed7c0e)
* Add create_repository_dispatch to typing files (1502) (ba9d59c2)
* Add OAuth support for GitHub applications (4b437110)
* Create AccessToken entity (4a6468aa)
* Extend installation attributes (61808da1)
```
Links
- PyPI: https://pypi.org/project/pygithub
- Changelog: https://pyup.io/changelogs/pygithub/
- Repo: https://github.com/pygithub/pygithub
This PR updates pygithub from 1.51 to 1.57.
Changelog
### 1.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) ``` ### 1.56 ``` ----------------------------------- **Important** This is the last release that will support Python 3.6. **Bug Fixes & Improvements** * Create repo from template (2090) (b50283a7) * Improve signature of Repository.create_repo (2118) (001970d4) * Add support for 'visibility' attribute preview for Repositories (1872) (8d1397af) * Add Repository.rename_branch method (2089) (6452ddfe) * Add function to delete pending reviews on a pull request (1897) (c8a945bb) * Cover all code paths in search_commits (2087) (f1faf941) * Correctly deal when PaginatedList's data is a dict (2084) (93b92cd2) * Add two_factor_authentication in AuthenticatedUser. (1972) (4f00cbf2) * Add ProjectCard.edit() to the type stub (2080) (d417e4c4) * Add method to delete Workflow runs (2078) (b1c8eec5) * Implement organization.cancel_invitation() (2072) (53fb4988) * Feat: Add `html_url` property in Team Class. (1983) (6570892a) * Add support for Python 3.10 (2073) (aa694f8e) * Add github actions secrets to org (2006) (bc5e5950) * Correct replay for Organization.create_project() test (2075) (fcc12368) * Fix install command example (2043) (99e00a28) * Fix: 1671 Convert Python Bool to API Parameter for Authenticated User Notifications (2001) (1da600a3) * Do not transform requestHeaders when logging (1965) (1265747e) * Add type to OrderedDict (1954) (ed7d0fe9) * Add Commit.get_pulls() to pyi (1958) (b4664705) * Adding headers in GithubException is a breaking change (1931) (d1644e33) ``` ### 1.55 ``` ----------------------------------- **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** * Do not import from unpackaged paths in typing (1926) (27ba7838) * Implement hash for CompletableGithubObject (1922) (4faff23c) * Use property decorator to improve typing compatibility (1925) (e4168109) * Fix :rtype: directive (1927) (54b6a97b) * Update most URLs to docs.github.com (1896) (babcbcd0) * Tighten asserts for new Permission tests (1893) (5aab6f5d) * Adding attributes "maintain" and "triage" to class "Permissions" (1810) (76879613) * Add default arguments to Workflow method type annotations (1857) (7d6bac9e) * Re-raise the exception when failing to parse JSON (1892) (916da53b) * Allow adding attributes at the end of the list (1807) (0245b758) * Updating links to Github documentation for deploy keys (1850) (c27fb919) * Update PyJWT Version to 2.0+ (1891) (a68577b7) * Use right variable in both get_check_runs() (1889) (3003e065) * fix bad assertions in github.Project.edit (1817) (6bae9e5c) * Test repr() for PublicKey (1879) (e0acd8f4) * Add support for deleting repository secrets (1868) (696793de) * Switch repository secrets to using f-strings (1867) (aa240304) * Manually fixing paths for codecov.io to cover all project files (1813) (b2232c89) * Add missing links to project metadata (1789) (64f532ae) * No longer show username and password examples (1866) (55d98373) * Adding github actions secrets (1681) (c90c050e) * fix get_user_issues (1842) (7db1b0c9) * Switch all string addition to using f-strings (1774) (290b6272) * Enabling connection pool_size definition (a77d4f48) * Always define the session adapter (aaec0a0f) ``` ### 1.54.1 ``` ----------------------------------- * Pin pyjwt version (1797) (31a1c007) * Add pyupgrade to pre-commit configuration (1783) (e113e37d) * Fix 1731: Incorrect annotation (82c349ce) * Drop support for Python 3.5 (1770) (63e4fae9) * Revert "Pin requests to <2.25 as well (1757)" (1763) (a806b523) * Fix stubs file for Repository (fab682a5) ``` ### 1.54 ``` ----------------------------------- **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** * Add support for Check Suites (1764) (6d501b28) * Add missing preview features of Deployment and Deployment Statuses API (1674) (197e0653) * Correct typing for Commit.get_comments() (1765) (fcdd9eae) * Pin requests to <2.25 as well (1757) (d159425f) * Add Support for Check Runs (1727) (c77c0676) * Added a method for getting a user by their id (1691) (4cfc9912) * Fix 1742 - incorrect typehint for `Installation.id` (1743) (546f6495) * Add WorkflowRun.workflow_id (1737) (78a29a7c) * Add support for Python 3.9 (1735) (1bb18ab5) * Added support for the Self-Hosted actions runners API (1684) (24251f4b) * Fix Branch protection status in the examples (1729) (88800844) * Filter the DeprecationWarning in Team tests (1728) (23f47539) * Added get_installations() to Organizations (1695) (b42fb244) * Fix 1507: Add new Teams: Add or update team repository endpoint (1509) (1c55be51) * Added support for `Repository.get_workflow_runs` parameters (1682) (c23564dd) * feat(pullrequest): add the rebaseable attribute (1690) (ee4c7a7e) * Add support for deleting reactions (1708) (f7d203c0) * Correct type hint for InputGitTreeElement.sha (08b72b48) * Ignore new black formatting commit for git blame (1680) (7ec4f155) * Format with new black (1679) (07e29fe0) * Add get_timeline() to Issue's type stubs (1663) (6bc9ecc8) ``` ### 1.53 ``` ----------------------------------- * Test Organization.get_hook() (1660) (2646a98c) * Add method get_team_membership for user to Team (1658) (749e8d35) * Add typing files for OAuth classes (1656) (429fcc73) * Fix Repository.create_repository_dispatch type signature (1643) (f891bd61) * PaginatedList's totalCount is 0 if no last page (1641) (69b37b4a) * Add initial support for Github Apps. (1631) (260558c1) * Correct **kwargs typing for search_* (1636) (165d995d) * Add delete_branch_on_merge arg to Repository.edit type stub (1639) (15b5ae0c) * Fix type stub for MainClass.get_user (1637) (8912be64) * Add type stub for Repository.create_fork (1638) (de386dfb) * Correct Repository.create_pull typing harder (1635) (5ad091d0) ``` ### 1.52 ``` ----------------------------------- * upload_asset with data in memory (1601) (a7786393) * Make Issue.closed_by nullable (1629) (06dae387) * Add support for workflow dispatch event (1625) (16850ef1) * Do not check reaction_type before sending (1592) (136a3e80) * Various Github Action improvement (1610) (416f2d0f) * more flexible header splitting (1616) (85e71361) * Create Dependabot config file (1607) (e272f117) * Add support for deployment statuses (1588) (048c8a1d) * Adds the 'twitter_username' attribute to NamedUser. (1585) (079f75a7) * Create WorkflowRun.timing namedtuple from the dict (1587) (1879518e) * Add missing properties to PullRequest.pyi (1577) (c84fad81) * Add support for Workflow Runs (1583) (4fb1d23f) * More precise typing for Repository.create_pull (1581) (4ed7aaf8) * Update sphinx-rtd-theme requirement from <0.5 to <0.6 (1563) (f9e4feeb) * More precise typing for MainClass.get_user() (1575) (3668f866) * Small documentation correction in Repository.py (1565) (f0f6ec83) * Remove "api_preview" parameter from type stubs and docstrings (1559) (cc1b884c) * Upgrade actions/setup-python to v2 (1555) (6f1640d2) * Clean up tests for GitReleaseAsset (1546) (925764ad) * Repository.update_file() content also accepts bytes (1543) (9fb8588b) * Fix Repository.get_issues stub (1540) (b40b75f8) * Check all arguments of NamedUser.get_repos() (1532) (69bfc325) * Correct Workflow typing (1533) (f41c046f) * Remove RateLimit.rate (1529) (7abf6004) * PullRequestReview is not a completable object (1528) (19fc43ab) * Test more attributes (1526) (52ec366b) * Remove pointless setters in GitReleaseAsset (1527) (1dd1cf9c) * Drop some unimplemented methods in GitRef (1525) (d4b61311) * Remove unneeded duplicate string checks in Branch (1524) (61b61092) * Turn on coverage reporting for codecov (1522) (e79b9013) * Drastically increase coverage by checking repr() (1521) (291c4630) * Fixed formatting of docstrings for `Repository.create_git_tag_and_release()` and `StatsPunchCard`. (1520) (ce400bc7) * Remove Repository.topics (1505) (53d58d2b) * Small improvements to typing (1517) (7b20b13d) * Correct Repository.get_workflows() (1518) (8727003f) * docs(repository): correct releases link (1514) (f7cc534d) * correct Repository.stargazers_count return type to int (1513) (b5737d41) * Fix two RST warnings in Webhook.rst (1512) (5a8bc203) * Filter FutureWarning for 2 test cases (1510) (09a1d9e4) * Raise a FutureWarning on use of client_{id,secret} (1506) (2475fa66) * Improve type signature for create_from_raw_data (1503) (c7b5eff0) * feat(column): move, edit and delete project columns (1497) (a32a8965) * Add support for Workflows (1496) (a1ed7c0e) * Add create_repository_dispatch to typing files (1502) (ba9d59c2) * Add OAuth support for GitHub applications (4b437110) * Create AccessToken entity (4a6468aa) * Extend installation attributes (61808da1) ```Links
- PyPI: https://pypi.org/project/pygithub - Changelog: https://pyup.io/changelogs/pygithub/ - Repo: https://github.com/pygithub/pygithub