Pygithub

-----------------------------------
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
^^^^^^^^^^^^^^^^^^^^^^^^

* Allow sha=None for InputGitTreeElement (`1327 <https://github.com/PyGithub/PyGithub/pull/1327>`_) (`60464f65 <https://github.com/PyGithub/PyGithub/commit/60464f65>`_)
* Support github timeline events. (`1302 <https://github.com/PyGithub/PyGithub/pull/1302>`_) (`732fd26a <https://github.com/PyGithub/PyGithub/commit/732fd26a>`_)
* Update link to GitHub Enterprise in README (`1324 <https://github.com/PyGithub/PyGithub/pull/1324>`_) (`e1537f79 <https://github.com/PyGithub/PyGithub/commit/e1537f79>`_)
* Cleanup travis config (`1322 <https://github.com/PyGithub/PyGithub/pull/1322>`_) (`8189a538 <https://github.com/PyGithub/PyGithub/commit/8189a538>`_)
* Add support for update branch (`1317 <https://github.com/PyGithub/PyGithub/pull/1317>`_) (`baddb719 <https://github.com/PyGithub/PyGithub/commit/baddb719>`_)
* Refactor Logging tests (`1315 <https://github.com/PyGithub/PyGithub/pull/1315>`_) (`b0ef1909 <https://github.com/PyGithub/PyGithub/commit/b0ef1909>`_)
* Fix rtd build (`b797cac0 <https://github.com/PyGithub/PyGithub/commit/b797cac0>`_)
* Add .git-blame-ignore-revs (`573c674b <https://github.com/PyGithub/PyGithub/commit/573c674b>`_)
* Apply black to whole codebase (`1303 <https://github.com/PyGithub/PyGithub/pull/1303>`_) (`6ceb9e9a <https://github.com/PyGithub/PyGithub/commit/6ceb9e9a>`_)
* Fix class used returning pull request comments (`1307 <https://github.com/PyGithub/PyGithub/pull/1307>`_) (`f8e33620 <https://github.com/PyGithub/PyGithub/commit/f8e33620>`_)
* Support for create_fork (`1306 <https://github.com/PyGithub/PyGithub/pull/1306>`_) (`2ad51f35 <https://github.com/PyGithub/PyGithub/commit/2ad51f35>`_)
* Use Repository.get_contents() in tests (`1301 <https://github.com/PyGithub/PyGithub/pull/1301>`_) (`e40768e0 <https://github.com/PyGithub/PyGithub/commit/e40768e0>`_)
* Allow GithubObject.update() to be passed headers (`1300 <https://github.com/PyGithub/PyGithub/pull/1300>`_) (`989b635e <https://github.com/PyGithub/PyGithub/commit/989b635e>`_)
* Correct URL for assignees on PRs (`1296 <https://github.com/PyGithub/PyGithub/pull/1296>`_) (`3170cafc <https://github.com/PyGithub/PyGithub/commit/3170cafc>`_)
* Use inclusive ordered comparison for 'parameterized' requirement (`1281 <https://github.com/PyGithub/PyGithub/pull/1281>`_) (`fb19d2f2 <https://github.com/PyGithub/PyGithub/commit/fb19d2f2>`_)
* Deprecate Repository.get_dir_contents() (`1285 <https://github.com/PyGithub/PyGithub/pull/1285>`_) (`21e89ff1 <https://github.com/PyGithub/PyGithub/commit/21e89ff1>`_)
* Apply some polish to manage.sh (`1284 <https://github.com/PyGithub/PyGithub/pull/1284>`_) (`3a723252 <https://github.com/PyGithub/PyGithub/commit/3a723252>`_)

-----------------------------------

* Add Python 3.8 to classifiers list (`1280 <https://github.com/PyGithub/PyGithub/pull/1280>`_) (`fec6034a <https://github.com/PyGithub/PyGithub/commit/fec6034a>`_)
* Expand Topic class and add test coverage (`1252 <https://github.com/PyGithub/PyGithub/pull/1252>`_) (`ac682742 <https://github.com/PyGithub/PyGithub/commit/ac682742>`_)
* Add support for team discussions (`1246 <https://github.com/PyGithub/PyGithub/pull/1246>`_) (#1249) (`ec3c8d7b <https://github.com/PyGithub/PyGithub/commit/ec3c8d7b>`_)
* Correct API for NamedUser.get_organization_membership (`1277 <https://github.com/PyGithub/PyGithub/pull/1277>`_) (`077c80ba <https://github.com/PyGithub/PyGithub/commit/077c80ba>`_)
* Correct header check for 2FA required (`1274 <https://github.com/PyGithub/PyGithub/pull/1274>`_) (`6ad592b1 <https://github.com/PyGithub/PyGithub/commit/6ad592b1>`_)
* Use replay framework for Issue142 test (`1271 <https://github.com/PyGithub/PyGithub/pull/1271>`_) (`4d258d93 <https://github.com/PyGithub/PyGithub/commit/4d258d93>`_)
* Sync httpretty version requirement with setup.py (`1265 <https://github.com/PyGithub/PyGithub/pull/1265>`_) (`99d38468 <https://github.com/PyGithub/PyGithub/commit/99d38468>`_)
* Handle unicode strings when recording responses (`1253 <https://github.com/PyGithub/PyGithub/pull/1253>`_) (#1254) (`faa1bbd6 <https://github.com/PyGithub/PyGithub/commit/faa1bbd6>`_)
* Add assignee removal/addition support to PRs (`1241 <https://github.com/PyGithub/PyGithub/pull/1241>`_) (`a163ba15 <https://github.com/PyGithub/PyGithub/commit/a163ba15>`_)
* Check if the version is empty in manage.sh (`1268 <https://github.com/PyGithub/PyGithub/pull/1268>`_) (`db294837 <https://github.com/PyGithub/PyGithub/commit/db294837>`_)
* Encode content for {create,update}_file (`1267 <https://github.com/PyGithub/PyGithub/pull/1267>`_) (`bc225f9d <https://github.com/PyGithub/PyGithub/commit/bc225f9d>`_)
* Update changes.rst (`1263 <https://github.com/PyGithub/PyGithub/pull/1263>`_) (`d7947d82 <https://github.com/PyGithub/PyGithub/commit/d7947d82>`_)

-----------------------------------

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
^^^^^^^^^^^^^^^^^^^^^^^^

* Stop ignoring unused imports and remove them (`1250 <https://github.com/PyGithub/PyGithub/pull/1250>`_) (`a0765083 <https://github.com/PyGithub/PyGithub/commit/a0765083>`_)
* Bump httpretty to be a greater or equal to (`1262 <https://github.com/PyGithub/PyGithub/pull/1262>`_) (`27092fb0 <https://github.com/PyGithub/PyGithub/commit/27092fb0>`_)
* Add close all issues example (`1256 <https://github.com/PyGithub/PyGithub/pull/1256>`_) (`13e2c7c7 <https://github.com/PyGithub/PyGithub/commit/13e2c7c7>`_)
* Add six to install_requires (`1245 <https://github.com/PyGithub/PyGithub/pull/1245>`_) (`a840a906 <https://github.com/PyGithub/PyGithub/commit/a840a906>`_)
* Implemented user organization membership. Added test case. (`1237 <https://github.com/PyGithub/PyGithub/pull/1237>`_) (`e50420f7 <https://github.com/PyGithub/PyGithub/commit/e50420f7>`_)
* Create DEPLOY.md (`c9ed82b2 <https://github.com/PyGithub/PyGithub/commit/c9ed82b2>`_)
* Support non-default URLs in GithubIntegration (`1229 <https://github.com/PyGithub/PyGithub/pull/1229>`_) (`e33858a3 <https://github.com/PyGithub/PyGithub/commit/e33858a3>`_)
* Cleanup try/except import in PaginatedList (`1228 <https://github.com/PyGithub/PyGithub/pull/1228>`_) (`89c967bb <https://github.com/PyGithub/PyGithub/commit/89c967bb>`_)
* Add an IncompletableObject exception (`1227 <https://github.com/PyGithub/PyGithub/pull/1227>`_) (`f91cbac2 <https://github.com/PyGithub/PyGithub/commit/f91cbac2>`_)
* Fix redundant int checks (`1226 <https://github.com/PyGithub/PyGithub/pull/1226>`_) (`850da5af <https://github.com/PyGithub/PyGithub/commit/850da5af>`_)
* Jump from notifications to related PRs/issues. (`1168 <https://github.com/PyGithub/PyGithub/pull/1168>`_) (`020fbebc <https://github.com/PyGithub/PyGithub/commit/020fbebc>`_)
* Code review bodies are optional in some cases. (`1169 <https://github.com/PyGithub/PyGithub/pull/1169>`_) (`b84d9b19 <https://github.com/PyGithub/PyGithub/commit/b84d9b19>`_)
* Update changes.rst (`1223 <https://github.com/PyGithub/PyGithub/pull/1223>`_) (`2df7269a <https://github.com/PyGithub/PyGithub/commit/2df7269a>`_)
* Do not auto-close issues with high priority tag (`ab27ba4d <https://github.com/PyGithub/PyGithub/commit/ab27ba4d>`_)
* Fix bug in repository create new file example PyGithub1210 (`1211 <https://github.com/PyGithub/PyGithub/pull/1211>`_) (`74cd6856 <https://github.com/PyGithub/PyGithub/commit/74cd6856>`_)
* Remove more Python version specific code (`1193 <https://github.com/PyGithub/PyGithub/pull/1193>`_) (`a0f01cf9 <https://github.com/PyGithub/PyGithub/commit/a0f01cf9>`_)
* Drop use of assertEquals (`1194 <https://github.com/PyGithub/PyGithub/pull/1194>`_) (`7bac694a <https://github.com/PyGithub/PyGithub/commit/7bac694a>`_)
* Fix PR review creation. (`1184 <https://github.com/PyGithub/PyGithub/pull/1184>`_) (`e90cdab0 <https://github.com/PyGithub/PyGithub/commit/e90cdab0>`_)
* Add support to vulnerability alert and automated security fixes APIs (`1195 <https://github.com/PyGithub/PyGithub/pull/1195>`_) (`8abd50e2 <https://github.com/PyGithub/PyGithub/commit/8abd50e2>`_)
* Delete Legacy submodule (`1192 <https://github.com/PyGithub/PyGithub/pull/1192>`_) (`7ddb657d <https://github.com/PyGithub/PyGithub/commit/7ddb657d>`_)
* Remove some uses of atLeastPython3 (`1191 <https://github.com/PyGithub/PyGithub/pull/1191>`_) (`cca8e3a5 <https://github.com/PyGithub/PyGithub/commit/cca8e3a5>`_)
* Run flake8 in Travis (`1163 <https://github.com/PyGithub/PyGithub/pull/1163>`_) (`f93207b4 <https://github.com/PyGithub/PyGithub/commit/f93207b4>`_)
* Fix directories for coverage in Travis (`1190 <https://github.com/PyGithub/PyGithub/pull/1190>`_) (`657f87b5 <https://github.com/PyGithub/PyGithub/commit/657f87b5>`_)
* Switch to using six (`1189 <https://github.com/PyGithub/PyGithub/pull/1189>`_) (`dc2f2ad8 <https://github.com/PyGithub/PyGithub/commit/dc2f2ad8>`_)
* Update Repository.update_file() docstring (`1186 <https://github.com/PyGithub/PyGithub/pull/1186>`_) (`f1ae7200 <https://github.com/PyGithub/PyGithub/commit/f1ae7200>`_)
* Correct return type of MainClass.get_organizations (`1179 <https://github.com/PyGithub/PyGithub/pull/1179>`_) (`6e79d270 <https://github.com/PyGithub/PyGithub/commit/6e79d270>`_)
* Add cryptography to test-requirements.txt (`1165 <https://github.com/PyGithub/PyGithub/pull/1165>`_) (`9b1c1e09 <https://github.com/PyGithub/PyGithub/commit/9b1c1e09>`_)

-----------------------------------

New features
^^^^^^^^^^^^

* Add two factor attributes on organizations (`1132 <https://github.com/PyGithub/PyGithub/pull/1132>`_) (`a0731685 <https://github.com/PyGithub/PyGithub/commit/a0731685>`_)
* Add Repository methods for pending invitations (`1159 <https://github.com/PyGithub/PyGithub/pull/1159>`_) (`57af1e05 <https://github.com/PyGithub/PyGithub/commit/57af1e05>`_)
* Adds `get_issue_events` to `PullRequest` object (`1154 <https://github.com/PyGithub/PyGithub/pull/1154>`_) (`acd515aa <https://github.com/PyGithub/PyGithub/commit/acd515aa>`_)
* Add invitee and inviter to Invitation (`1156 <https://github.com/PyGithub/PyGithub/pull/1156>`_) (`0f2beaca <https://github.com/PyGithub/PyGithub/commit/0f2beaca>`_)
* Adding support for pending team invitations (`993 <https://github.com/PyGithub/PyGithub/pull/993>`_) (`edab176b <https://github.com/PyGithub/PyGithub/commit/edab176b>`_)
* Add support for custom base_url in GithubIntegration class (`1093 <https://github.com/PyGithub/PyGithub/pull/1093>`_) (`6cd0d644 <https://github.com/PyGithub/PyGithub/commit/6cd0d644>`_)
* GithubIntegration: enable getting installation (`1135 <https://github.com/PyGithub/PyGithub/pull/1135>`_) (`18187045 <https://github.com/PyGithub/PyGithub/commit/18187045>`_)
* Add sorting capability to Organization.get_repos() (`1139 <https://github.com/PyGithub/PyGithub/pull/1139>`_) (`ef6f009d <https://github.com/PyGithub/PyGithub/commit/ef6f009d>`_)
* Add new Organization.get_team_by_slug method (`1144 <https://github.com/PyGithub/PyGithub/pull/1144>`_) (`4349bca1 <https://github.com/PyGithub/PyGithub/commit/4349bca1>`_)
* Add description field when creating a new team (`1125 <https://github.com/PyGithub/PyGithub/pull/1125>`_) (`4a37860b <https://github.com/PyGithub/PyGithub/commit/4a37860b>`_)
* Handle a path of / in Repository.get_contents() (`1070 <https://github.com/PyGithub/PyGithub/pull/1070>`_) (`102c8208 <https://github.com/PyGithub/PyGithub/commit/102c8208>`_)
* Add issue lock/unlock (`1107 <https://github.com/PyGithub/PyGithub/pull/1107>`_) (`ec7bbcf5 <https://github.com/PyGithub/PyGithub/commit/ec7bbcf5>`_)

Bug Fixes & Improvements
^^^^^^^^^^^^^^^^^^^^^^^^

* Fix bug in recursive repository contents example (`1166 <https://github.com/PyGithub/PyGithub/pull/1166>`_) (`8b6b4505 <https://github.com/PyGithub/PyGithub/commit/8b6b4505>`_)
* Allow name to be specified for upload_asset (`1151 <https://github.com/PyGithub/PyGithub/pull/1151>`_) (`8d2a6b53 <https://github.com/PyGithub/PyGithub/commit/8d2a6b53>`_)
* Fixes 1106 for GitHub Enterprise API (`1110 <https://github.com/PyGithub/PyGithub/pull/1110>`_) (`54065792 <https://github.com/PyGithub/PyGithub/commit/54065792>`_)

Deprecation
^^^^^^^^^^^

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

-----------------------------------

* Exclude tests from PyPI distribution (`1031 <https://github.com/PyGithub/PyGithub/pull/1031>`_) (`78d283b9 <https://github.com/PyGithub/PyGithub/commit/78d283b9>`_)
* Add codecov badge (`1090 <https://github.com/PyGithub/PyGithub/pull/1090>`_) (`4c0b54c0 <https://github.com/PyGithub/PyGithub/commit/4c0b54c0>`_)

-----------------------------------

New features
^^^^^^^^^^^^

* Add support for Python 3.7 (`1028 <https://github.com/PyGithub/PyGithub/pull/1028>`_) (`6faa00ac <https://github.com/PyGithub/PyGithub/commit/6faa00ac>`_)
* Adding HTTP retry functionality via urllib3 (`1002 <https://github.com/PyGithub/PyGithub/pull/1002>`_) (`5ae7af55 <https://github.com/PyGithub/PyGithub/commit/5ae7af55>`_)
* Add new dismiss() method on PullRequestReview (`1053 <https://github.com/PyGithub/PyGithub/pull/1053>`_) (`8ef71b1b <https://github.com/PyGithub/PyGithub/commit/8ef71b1b>`_)
* Add since and before to `get_notifications` (`1074 <https://github.com/PyGithub/PyGithub/pull/1074>`_) (`7ee6c417 <https://github.com/PyGithub/PyGithub/commit/7ee6c417>`_)
* Add url parameter to include anonymous contributors in `get_contributors` (`1075 <https://github.com/PyGithub/PyGithub/pull/1075>`_) (`293846be <https://github.com/PyGithub/PyGithub/commit/293846be>`_)
* Provide option to extend expiration of jwt token (`1068 <https://github.com/PyGithub/PyGithub/pull/1068>`_) (`86a9d8e9 <https://github.com/PyGithub/PyGithub/commit/86a9d8e9>`_)

Bug Fixes & Improvements
^^^^^^^^^^^^^^^^^^^^^^^^

* Fix the default parameter for `PullRequest.create_review` (`1058 <https://github.com/PyGithub/PyGithub/pull/1058>`_) (`118def30 <https://github.com/PyGithub/PyGithub/commit/118def30>`_)
* Fix `get_access_token` (`1042 <https://github.com/PyGithub/PyGithub/pull/1042>`_) (`6a89eb64 <https://github.com/PyGithub/PyGithub/commit/6a89eb64>`_)
* Fix `Organization.add_to_members` role passing (`1039 <https://github.com/PyGithub/PyGithub/pull/1039>`_) (`480f91cf <https://github.com/PyGithub/PyGithub/commit/480f91cf>`_)

Deprecation
^^^^^^^^^^^

* Remove Status API (`6efd6318 <https://github.com/PyGithub/PyGithub/commit/6efd6318>`_)