Typed interactions with the GitHub API v3

Last update: Jan 06, 2023

Overview

PyGitHub

PyGitHub is a Python library to access the GitHub API v3 and Github Enterprise API v3. This library enables you to manage GitHub resources such as repositories, user profiles, and organizations in your Python applications.

Install

$ pip install PyGithub

Simple Demo

from github import Github

# First create a Github instance:

# using username and password
g = Github("user", "password")

# or using an access token
g = Github("access_token")

# Github Enterprise with custom hostname
g = Github(base_url="https://{hostname}/api/v3", login_or_token="access_token")

# Then play with your Github objects:
for repo in g.get_user().get_repos():
    print(repo.name)

Documentation

More information can be found on the PyGitHub documentation site.

Development

Contributing

Long-term discussion and bug reports are maintained via GitHub Issues. Code review is done via GitHub Pull Requests.

For more information read CONTRIBUTING.md.

Maintainership

We're actively seeking maintainers that will triage issues and pull requests and cut releases. If you work on a project that leverages PyGitHub and have a vested interest in keeping the code alive and well, send an email to someone in the MAINTAINERS file.

Comments

ImportError: No module named github

I'm trying to use PyGitHub and I'm getting "ImportError: No module named github".

Setup specs: macOS v10.13.6 Python v3.7.0 Installed with pip v18.0
bug high priority

opened by JosephTLyons 47
Use 'requests' instead of 'httplib'
This is an updated version of #383 , with the following changes:

Resolves conflict in setup.py

Supports HTTP and HTTPS

Supports base_url other than github.com

Uses requests's sessions to further optimize timing

Proxies are now handled using requests' default handling. This means that the environment variables $HTTP_PROXY/$HTTPS_PROXY/$http_proxy/$https_proxy are now used (request seems to prefer the lower case version if both are defined) to specify proxies. A further PR could be added to pass this as a parameter to the calls, if required

refactoring improvement high priority
opened by mikeage 37
Create repo from template

Based on the comments made in this review https://github.com/PyGithub/PyGithub/pull/2088#pullrequestreview-787467842

i made extra effort to redo the PR so that all the lint related changes are reverted.

This is to solve #1395 and #1974

With the last commit being https://github.com/PyGithub/PyGithub/pull/2090/commits/8b638c5b491b17e974d6e4428d00a2451fdd9c9b

And this is a continuation of the PR in #2012 and #2088

@harismuha123 I have tried to resolve merge conflicts and hope that @s-t-e-v-e-n-k can approve this PR.

opened by simkimsia 34
Add support for projects
Initial solution for PyGithub support for projects (#606). Adds comprehensive project querying API.

Currently does not support for modifying projects, columns or cards. (I only need this interface for reporting purposes. Of course once I'm done others are more than welcome to add additional features!)

API that was integrated: https://developer.github.com/v3/projects https://developer.github.com/v3/projects/columns https://developer.github.com/v3/projects/cards

Note that the Github project API is in preview mode - it requires a special header in order for requests to be processed, and the API is subject to change without notice.

Summary

new classes: Project, ProjectColumn, ProjectCard

add Organization.get_projects method

add Repository.get_projects method

add MainClass.get_project method

add test cases to exercise all new classes and methods and verify attributes are as expected; replay data is included, recorded (mostly) from my fork of PyGithub

updated add_attribute script to:

use makeXXXAttribute API

be able to add to the end of the current set of properties

handle both Completable and NonCompletable class types correctly

Checklist

Not to be merged until these are done:

[x] remaining Project properties

[x] remaining ProjectColumn properties

[x] remaining ProjectCard properties

[x] support for archived_state parameter when getting cards: all,archived, or not_archived

[x] get issue from card, not just pull request ("get_content" method?)

[x] centralize header management for "preview" access to projects API

[x] add test for retrieving organization projects

[x] add test for getting issue / pull request content from card

new feature
opened by BBI-YggyKing 33
Type stubs for mypy

Adds type stubs that can be used in mypy, as requested in: #1217 The current type stubs were generated by MonkeyType against the unit test, however it missed a few things here and there so manual fix is required before merging (still WIP).
improvement high priority

opened by zer0tonin 32
Adding communications Retry functionality into requests via urllib3 retry object.
This PR is related to #757 and #378

This is an attempt to add a communications retry feature into PyGithub that can be user defined at the top level.

This works directly with requests and uses the low level urllib3 Retry object (already used by requests) to implement the functionality. It is backwards compatible with the current codeset.

The user can set the retry parameter in the top level github(<login>, retry = X) call. Where X can be a simple int to define the number of retrys or it can be an urllib3.util.retry.Retry(...) object. This allows the user very fine grained control over the retry system as defined by urllib3.

The structure for the Retry object can be setup like this example:

num_retries=3 backoff_factor=5 status_forcelist=(500, 502, 504) retry_data = urllib3.util.retry.Retry( total=num_retries, read=num_retries, connect=num_retries, backoff_factor=backoff_factor, status_forcelist=status_forcelist ) gserver = github(<login or token>, retry = retry_data)

The urllib3 Retry object has many parameters, that allows the user much flexibility to configure retry's to their heart's content.

The only issue I have at the moment, is that I am completely baffled on how to add tests for this feature given the current testing infrastructure. Any suggestions would be appreciated.

CC: @mfonville @jrouquie @sfdye

EDIT: The code for this PR is now stale, and is being moved forward via PR #1002. However, the discussion is still relevant.
improvement high priority needs further review
opened by allevin 31
Implement OAuth for apps
This PR adds support for:

Getting OAuth login URL for apps

Getting access tokens for apps

Listing app installations that are accessible to a user

Related to #828
high priority new feature
opened by rigaspapas 30
Adding new attributes to IssueEvent
See Issue #855

The class IssueEvent is missing a large number of attributes documented in the API.

This is also commented about in #653 to a degree

27 of the tests 27 known event types have tests.

Currently Tested using Issue #30

[x] subscribed

[x] assigned

[x] referenced

[x] closed

[x] labeled

Currently Tested using Issue/PR #538

[x] merged

[x] mentioned

[x] review_requested

Currently Tested using Issue/PR #857

[x] reopened

[x] unassigned

[x] unlabeled

[x] renamed

[x] base_ref_changed

[x] head_ref_deleted

[x] head_ref_restored

[x] milestoned

[x] demilestoned

[x] locked

[x] unlocked

[x] review_dismissed

[x] review_request_removed

[x] marked_as_duplicate

[x] unmarked_as_duplicate

[x] added_to_project

[x] moved_columns_in_project

[x] removed_from_project

[x] converted_note_to_issue - Note: this event is tied into Issue #866

This PR is now ready to be merged
improvement
opened by allevin 27
Fix github API requests after asset upload

In the old code the self.__hostname would be overwritten with uploads.github.com but it could not be correctly re-set to api.github.com after completing the upload Create a separate connection if hostname or port differ in requestBlobAndCheck

in the end this became quite a large overhaul, to also make this change generic for e.g. connecting to status.github.com and similar methods

~~not sure if tests need (more) updating, if so I will update the PR accordingly~~
refactoring improvement

opened by mfonville 26
Maintain PyGithub - looking for volunteers

Hello everyone,

I've obviously neglected PyGithub in the last few months and my current priorities are hardly compatible with doing a good job on PyGithub.

I'm looking for volunteer(s) to take over PyGithub. I would transfer ownership of the main PyGithub repository to a GitHub organization, and give admin permissions on the PyPI package as well.

Please comment on this issue if you're interested.
project management

opened by jacquev6 26

Large asset upload timed out.

Trying to upload an asset of ~600 MB to a GitHub release, but getting the below error.

Traceback (most recent call last):
  File "run_deploy.py", line 47, in <module>
    label=release_title
  File "C:\Python27-x64\lib\site-packages\github\GitRelease.py", line 161, in upload_asset
    input=path
  File "C:\Python27-x64\lib\site-packages\github\Requester.py", line 177, in requestBlobAndCheck
    return self.__check(*self.requestBlob(verb, url, parameters, headers, input))
  File "C:\Python27-x64\lib\site-packages\github\Requester.py", line 245, in requestBlob
    return self.__requestEncode(None, verb, url, parameters, headers, input, encode)
  File "C:\Python27-x64\lib\site-packages\github\Requester.py", line 268, in __requestEncode
    status, responseHeaders, output = self.__requestRaw(cnx, verb, url, requestHeaders, encoded_input)
  File "C:\Python27-x64\lib\site-packages\github\Requester.py", line 295, in __requestRaw
    response = cnx.getresponse()
  File "C:\Python27-x64\lib\httplib.py", line 1121, in getresponse
    response.begin()
  File "C:\Python27-x64\lib\httplib.py", line 438, in begin
    version, status, reason = self._read_status()
  File "C:\Python27-x64\lib\httplib.py", line 394, in _read_status
    line = self.fp.readline(_MAXLINE + 1)
  File "C:\Python27-x64\lib\socket.py", line 480, in readline
    data = self._sock.recv(self._rbufsize)
  File "C:\Python27-x64\lib\ssl.py", line 766, in recv
    return self.read(buflen)
  File "C:\Python27-x64\lib\ssl.py", line 653, in read
    v = self._sslobj.read(len)
ssl.SSLError: ('The read operation timed out',)

All I'm doing is release.upload_asset("/path/to/deployment.zip").

Am I using the library wrong somehow?

bug feature request

opened by tokejepsen 25

The `organization` attribute of github.Repository.Repository can't request teams

Hello. It looks like something is wrong with the credentials of the mentioned attribute.

Here's the reproducing case:

In [32]: from github import Github

In [33]: gh = Github(getpass.getpass(), per_page=100)
Password: 

In [34]: repo = gh.get_repo("ClickHouse/ClickHouse")

In [35]: repo.organization
Out[35]: Organization(login="ClickHouse")

In [36]: repo.organization.get_teams()
Out[36]: <github.PaginatedList.PaginatedList at 0x7f7ca69cdf90>

In [37]: list(Out[36])
---------------------------------------------------------------------------
UnknownObjectException                    Traceback (most recent call last)
Cell In[37], line 1
----> 1 list(Out[36])

File /usr/lib/python3.10/site-packages/github/PaginatedList.py:56, in PaginatedListBase.__iter__(self)
     54 yield from self.__elements
     55 while self._couldGrow():
---> 56     newElements = self._grow()
     57     yield from newElements

File /usr/lib/python3.10/site-packages/github/PaginatedList.py:67, in PaginatedListBase._grow(self)
     66 def _grow(self):
---> 67     newElements = self._fetchNextPage()
     68     self.__elements += newElements
     69     return newElements

File /usr/lib/python3.10/site-packages/github/PaginatedList.py:201, in PaginatedList._fetchNextPage(self)
    200 def _fetchNextPage(self):
--> 201     headers, data = self.__requester.requestJsonAndCheck(
    202         "GET", self.__nextUrl, parameters=self.__nextParams, headers=self.__headers
    203     )
    204     data = data if data else []
    206     self.__nextUrl = None

File /usr/lib/python3.10/site-packages/github/Requester.py:353, in Requester.requestJsonAndCheck(self, verb, url, parameters, headers, input)
    352 def requestJsonAndCheck(self, verb, url, parameters=None, headers=None, input=None):
--> 353     return self.__check(
    354         *self.requestJson(
    355             verb, url, parameters, headers, input, self.__customConnection(url)
    356         )
    357     )

File /usr/lib/python3.10/site-packages/github/Requester.py:378, in Requester.__check(self, status, responseHeaders, output)
    376 output = self.__structuredFromJson(output)
    377 if status >= 400:
--> 378     raise self.__createException(status, responseHeaders, output)
    379 return responseHeaders, output

UnknownObjectException: 404 {"message": "Not Found", "documentation_url": "https://docs.github.com/rest"}

In [38]: org = gh.get_organization(repo.organization.login)

In [39]: teams = list(org.get_teams())

In [40]: teams[1]
Out[40]: Team(name="****", id=00000000)

The library version is 1.57

opened by Felixoid 0

Update sphinx requirement from <3 to <7
Updates the requirements on sphinx to permit the latest version.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

#10468: Drop Python 3.6 support

#10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

#7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

.. code-block:: html+jinja

{%- block scripts %} {{ super() }} {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.

#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

5b56a23 Bump to 6.0.0 final

f1d1e9c Update coverage workflow for Tox 4

66a738c Update coverage workflow for new configuration location

041e5f8 Add test coverage for 'today_fmt' reference substitution (#10980)

da25145 Remove unnecessary conditional import in sphinx.ext.napoleon (#11043)

45a0ea9 Migrate coveragepy config into pyproject.toml (#11025)

3ec54f1 Create a pydata_sphinx_theme section in usage examples (#11046)

32bce8f Copy edit the tutorial (#11049)

9844162 Fix example using add_config_value (#10937)

bf4a626 RTD builder: add graphviz depedendency (#11040)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies python
opened by dependabot[bot] 1
Fix broken urls in AuthenticatedUser docstrings

I noticed that the URLs for accept_invitation and get_repos are broken on ReadTheDocs.

By adding the underscore at the end, it fixes the link when rendered with Sphinx

opened by Muscaw 1
Add support for Issue.state_reason #2370

Added new parameter cf #2370. As mentioned in the related docs.github issue, I've also asked for a documentation update as state_reason is somehow linked to state, to prevent misunderstanding if someone wants to change only state_reason.

opened by chouetz 1
Add unarchiving support

The github API now allows unarchiving an archived repo. This removes the check so that we ar able to unarchive repos using pygithub.

https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#update-a-repository

opened by Tsuesun 1

Releases(v1.57)

v1.57(Nov 5, 2022)
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)

Source code(tar.gz)
Source code(zip)
v1.56(Oct 13, 2022)
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)

Source code(tar.gz)
Source code(zip)
v1.55(Apr 26, 2021)
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 connetion pool_size definition (a77d4f48)

Always define the session adapter (aaec0a0f)

Source code(tar.gz)
Source code(zip)
v1.54.0.1(Apr 26, 2021)
Hotfix release to better support Python 3.5 users.

Pin pyjwt to <2.0 (502caed9)

Source code(tar.gz)
Source code(zip)
v1.54.1(Dec 24, 2020)
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)

Source code(tar.gz)
Source code(zip)
v1.54(Nov 30, 2020)
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)

Source code(tar.gz)
Source code(zip)
v1.53(Aug 18, 2020)
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)

Source code(tar.gz)
Source code(zip)
v1.52(Aug 3, 2020)
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)

Source code(tar.gz)
Source code(zip)
v1.51(May 2, 2020)
Type stubs are now packaged with the build (#1489) (6eba4506)

Travis CI is now dropped in favor of Github workflow (#1488) (d6e77ba1)

Get the project column by id (#1466) (63855409)

Source code(tar.gz)
Source code(zip)
v1.50(Apr 26, 2020)
New features

PyGithub now supports type checking thanks to (#1231) (91433fe9)

Slack is now the main channel of communication rather than Gitter (6a6e7c26)

Ability to retrieve public events (#1481) (5cf9950b)

Add and handle the maintainer_can_modify attribute in PullRequest (#1465) (e0997b43)

List matching references (#1471) (d3bc6a5c)

Add create_repository_dispatch (#1449) (edcbdfda)

Add some Organization and Repository attributes. (#1468) (3ab97d61)

Add create project method (801ea385)

Bug Fixes & Improvements

Drop use of shadow-cat for draft PRs (#1469) (84bb69ab)

AuthenticatedUser.get_organization_membership() should be str (#1473) (38b34db5)

Drop documentation for len() of PaginatedList (#1470) (70462598)

Fix param name of projectcard's move function (#1451) (bafc4efc)

Correct typos found with codespell (#1467) (83bef0f7)

Export IncompletableObject in the github namespace (#1450) (0ebdbb26)

Add GitHub Action workflow for checks (#1464) (f1401c15)

Drop unneeded ignore rule for flake8 (#1454) (b4ca9177)

Use pytest to parametrize tests (#1438) (d2e9bd69)

Source code(tar.gz)
Source code(zip)
v1.47(Mar 15, 2020)
Bug Fixes & Improvements

Add support to edit and delete a project (#1434) (f11f7395)

Add method for fetching pull requests associated with a commit (#1433) (0c55381b)

Add "get_repo_permission" to Team class (#1416) (219bde53)

Add list projects support, update tests (#1431) (e44d11d5)

Don't transform completely in PullRequest.*assignees (#1428) (b1c35499)

Add create_project support, add tests (#1429) (bf62f752)

Add draft attribute, update test (bd285248)

Docstring for Repository.create_git_tag_and_release (#1425) (bfeacded)

Create a tox docs environment (#1426) (b30c09aa)

Add Deployments API (#1424) (3d93ee1c)

Add support for editing project cards (#1418) (425280ce)

Add draft flag parameter, update tests (bd0211eb)

Switch to using pytest (#1423) (c822dd1c)

Fix GitMembership with a hammer (#1420) (f2939eb7)

Add support to reply to a Pull request comment (#1374) (1c82573d)

PullRequest.update_branch(): allow expected_head_sha to be empty (#1412) (806130e9)

Implement ProjectCard.delete() (#1417) (aeb27b78)

Add pre-commit plugin for black/isort/flake8 (#1398) (08b1c474)

Add tox (#1388) (125536fe)

Open file in text mode in scripts/add_attribute.py (#1396) (0396a493)

Silence most ResourceWarnings (#1393) (dd31a706)

Assert more attributes in Membership (#1391) (d6dee016)

Assert on changed Repository attributes (#1390) (6e3ceb19)

Add reset to the repr for Rate (#1389) (0829af81)

Source code(tar.gz)
Source code(zip)
v1.46(Feb 11, 2020)
Important

Python 2 support has been removed. If you still require Python 2, use 1.45.

Bug Fixes & Improvements

Add repo edit support for delete_branch_on_merge (#1381) (9564cd4d)

Fix mistake in Repository.create_fork() (#1383) (ad040baf)

Correct two attributes in Invitation (#1382) (882fe087)

Search repo issues by string label (#1379) (4ae1a1e5)

Correct Repository.create_git_tag_and_release() (#1362) (ead565ad)

exposed seats and filled_seats for Github Organization Plan (#1360) (06a300ae)

Repository.create_project() body is optional (#1359) (0e09983d)

Implement move action for ProjectCard (#1356) (b11add41)

Tidy up ProjectCard.get_content() (#1355) (dd80a6c0)

Added nested teams and parent (#1348) (eacabb2f)

Correct parameter for Label.edit (#1350) (16e5f989)

doc: example of Pull Request creation (#1344) (d5ad09ae)

Fix PyPI wheel deployment (#1330) (4561930b)

Source code(tar.gz)
Source code(zip)
v1.45(Dec 29, 2019)
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) (60464f65)

Support github timeline events. (#1302) (732fd26a)

Update link to GitHub Enterprise in README (#1324) (e1537f79)

Cleanup travis config (#1322) (8189a538)

Add support for update branch (#1317) (baddb719)

Refactor Logging tests (#1315) (b0ef1909)

Fix rtd build (b797cac0)

Add .git-blame-ignore-revs (573c674b)

Apply black to whole codebase (#1303) (6ceb9e9a)

Fix class used returning pull request comments (#1307) (f8e33620)

Support for create_fork (#1306) (2ad51f35)

Use Repository.get_contents() in tests (#1301) (e40768e0)

Allow GithubObject.update() to be passed headers (#1300) (989b635e)

Correct URL for assignees on PRs (#1296) (3170cafc)

Use inclusive ordered comparison for 'parameterized' requirement (#1281) (fb19d2f2)

Deprecate Repository.get_dir_contents() (#1285) (21e89ff1)

Apply some polish to manage.sh (#1284) (3a723252)

Source code(tar.gz)
Source code(zip)
v1.44.1(Nov 7, 2019)
Add Python 3.8 to classifiers list (#1280) (fec6034a)

Expand Topic class and add test coverage (#1252) (ac682742)

Add support for team discussions (#1246) (#1249) (ec3c8d7b)

Correct API for NamedUser.get_organization_membership (#1277) (077c80ba)

Correct header check for 2FA required (#1274) (6ad592b1)

Use replay framework for Issue142 test (#1271) (4d258d93)

Sync httpretty version requirement with setup.py (#1265) (99d38468)

Handle unicode strings when recording responses (#1253) (#1254) (faa1bbd6)

Add assignee removal/addition support to PRs (#1241) (a163ba15)

Check if the version is empty in manage.sh (#1268) (db294837)

Encode content for {create,update}_file (#1267) (bc225f9d)

Update changes.rst (#1263) (d7947d82)

Source code(tar.gz)
Source code(zip)
v1.44(Oct 19, 2019)
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) (a0765083)

Bump httpretty to be a greater or equal to (#1262) (27092fb0)

Add close all issues example (#1256) (13e2c7c7)

Add six to install_requires (#1245) (a840a906)

Implemented user organization membership. Added test case. (#1237) (e50420f7)

Create DEPLOY.md (c9ed82b2)

Support non-default URLs in GithubIntegration (#1229) (e33858a3)

Cleanup try/except import in PaginatedList (#1228) (89c967bb)

Add an IncompletableObject exception (#1227) (f91cbac2)

Fix redundant int checks (#1226) (850da5af)

Jump from notifications to related PRs/issues. (#1168) (020fbebc)

Code review bodies are optional in some cases. (#1169) (b84d9b19)

Update changes.rst (#1223) (2df7269a)

Do not auto-close issues with high priority tag (ab27ba4d)

Fix bug in repository create new file example PyGithub#1210 (#1211) (74cd6856)

Remove more Python version specific code (#1193) (a0f01cf9)

Drop use of assertEquals (#1194) (7bac694a)

Fix PR review creation. (#1184) (e90cdab0)

Add support to vulnerability alert and automated security fixes APIs (#1195) (8abd50e2)

Delete Legacy submodule (#1192) (7ddb657d)

Remove some uses of atLeastPython3 (#1191) (cca8e3a5)

Run flake8 in Travis (#1163) (f93207b4)

Fix directories for coverage in Travis (#1190) (657f87b5)

Switch to using six (#1189) (dc2f2ad8)

Update Repository.update_file() docstring (#1186) (f1ae7200)

Correct return type of MainClass.get_organizations (#1179) (6e79d270)

Add cryptography to test-requirements.txt (#1165) (9b1c1e09)

Source code(tar.gz)
Source code(zip)
v1.43.8(Jul 20, 2019)
New features

Add two factor attributes on organizations (#1132) (a0731685)

Add Repository methods for pending invitations (#1159) (57af1e05)

Adds get_issue_events to PullRequest object (#1154) (acd515aa)

Add invitee and inviter to Invitation (#1156) (0f2beaca)

Adding support for pending team invitations (#993) (edab176b)

Add support for custom base_url in GithubIntegration class (#1093) (6cd0d644)

GithubIntegration: enable getting installation (#1135) (18187045)

Add sorting capability to Organization.get_repos() (#1139) (ef6f009d)

Add new Organization.get_team_by_slug method (#1144) (4349bca1)

Add description field when creating a new team (#1125) (4a37860b)

Handle a path of / in Repository.get_contents() (#1070) (102c8208)

Add issue lock/unlock (#1107) (ec7bbcf5)

Bug Fixes & Improvements

Fix bug in recursive repository contents example (#1166) (8b6b4505)

Allow name to be specified for upload_asset (#1151) (8d2a6b53)

Fixes #1106 for GitHub Enterprise API (#1110) (54065792)

Source code(tar.gz)
Source code(zip)
v1.43.7(Apr 16, 2019)
Exclude tests from PyPI distribution (#1031) (78d283b9)

Add codecov badge (#1090) (4c0b54c0)

Source code(tar.gz)
Source code(zip)
v1.43.6(Apr 5, 2019)
New features

Add support for Python 3.7 (#1028) (6faa00ac)

Adding HTTP retry functionality via urllib3 (#1002) (5ae7af55)

Add new dismiss() method on PullRequestReview (#1053) (8ef71b1b)

Add since and before to get_notifications (#1074) (7ee6c417)

Add url parameter to include anonymous contributors in get_contributors (#1075) (293846be)

Provide option to extend expiration of jwt token (#1068) (86a9d8e9)

Bug Fixes & Improvements

Fix the default parameter for PullRequest.create_review (#1058) (118def30)

Fix get_access_token (#1042) (6a89eb64)

Fix Organization.add_to_members role passing (#1039) (480f91cf)

Deprecation

Remove Status API (6efd6318)

Source code(tar.gz)
Source code(zip)
v1.43.5(Jan 29, 2019)
Add project column create card (#1003) (5f5c2764)

Fix request got an unexpected keyword argument body (#1012) (ff789dcc)

Add missing import to PullRequest (#1007) (b5122768)

Source code(tar.gz)
Source code(zip)
v1.43.4(Dec 21, 2018)
New features

Add Migration API (#899) (b4d895ed)

Add Traffic API (#977) (a433a2fe)

New in Project API: create repository project, create project column (#995) (1c0fd97d)

Bug Fixes & Improvements

Change type of GitRelease.author to NamedUser (#969) (aca50a75)

Use total_count from data in PaginatedList (#963) (ec177610)

Source code(tar.gz)
Source code(zip)
v1.43.3(Oct 31, 2018)
New features

Add support for JWT authentication (#948) (8ccf9a94)

Added support for required signatures on protected branches (#939) (8ee75a28)

Ability to filter repository collaborators (#938) (5687226b)

Mark notification as read (#932) (0a10d7cd)

Add highlight search to search_code function (#925) (1fa25670)

Adding suspended_at property to NamedUSer (#922) (c13b43ea)

Add since parameter for Gists (#914) (e18b1078)

Bug Fixes & improvements

Fix missing parameters when reversing PaginatedList (#946) (60a684c5)

Fix unable to trigger RateLimitExceededException. (#943) (972446d5)

Fix inconsistent behavior of trailing slash usage in file path (#931) (ee9f098d)

Fix handling of 301 redirects (#916) (6833245d)

Fix missing attributes of get_repos for authenticated users (#915) (c411196f)

Fix Repository.edit (#904) (7286eec0)

Improve __repr__ method of Milestone class (#921) (562908cb)

Fix rate limit documentation change (#902) (974d1ec5)

Fix comments not posted in create_review() (#909) (a18eeb3a)

Source code(tar.gz)
Source code(zip)
v1.43.2(Sep 12, 2018)
Version 1.43.2 (September 12, 2018)

Restore RateLimit.rate attribute, raise deprecation warning instead (d92389be)

Source code(tar.gz)
Source code(zip)
v1.43.1(Sep 11, 2018)
Version 1.43.1 (September 11, 2018)

New feature:

Add support for Projects (#854) (faca4ce1)

Source code(tar.gz)
Source code(zip)
v1.43(Sep 8, 2018)
Version 1.43 (September 08, 2018)

BUGFIX

Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)

Fixed Gistfile.content (#486) (e1df09f7)

Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Add support for repository topics (#832) (c6802b51)

Add support for required approving review count (#888) (ef16702)

Add Organization.invite_user (880)(eb80564)

Add support for search/graphql rate limit (fd8a036)

Add Support search by topics (#893) (3ce0418)

Branch Protection API overhaul (#790) (171cc567)

(breaking) Removed Repository.protect_branch

Add BranchProtection <https://pygithub.readthedocs.io/en/latest/github_objects/BranchProtection.html>__

Add RequiredPullRequestReviews <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredPullRequestReviews.html>__

Add RequiredStatusChecks <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredStatusChecks.html>__

Add Branch.get_protection, Branch.get_required_pull_request_reviews, Branch.get_required_status_checks, etc

Improvements

Add missing arguments to Repository.edit (#844) (29d23151)

Add missing attributes to Repository (#842) (2b352fb3)

Adding archival support for Repository.edit (#843) (1a90f5db)

Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)

Allow editing of Team descriptions (#839) (c0021747)

Add description to Organizations (#838) (1d918809)

Add missing attributes for IssueEvent (#857) (7ac2a2a)

Change MainClass.get_repo default laziness (#882) (6732517)

Deprecation

Removed Repository.get_protected_branch (#871) (49db6f8)

Source code(tar.gz)
Source code(zip)
v1.42(Aug 19, 2018)
Version 1.42 (August 19, 2018)

Fix travis upload issue

BUGFIX

Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)

Fixed Gistfile.content (#486) (e1df09f7)

Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Add support for repository topics (#832) (c6802b51)

Branch Protection API overhaul (#790) (171cc567)

(breaking) Removed Repository.protect_branch

Add BranchProtection <https://pygithub.readthedocs.io/en/latest/github_objects/BranchProtection.html>__

Add RequiredPullRequestReviews <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredPullRequestReviews.html>__

Add RequiredStatusChecks <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredStatusChecks.html>__

Add Branch.get_protection, Branch.get_required_pull_request_reviews, Branch.get_required_status_checks, etc

Improvements

Add missing arguments to Repository.edit (#844) (29d23151)

Add missing properties to Repository (#842) (2b352fb3)

Adding archival support for Repository.edit (#843) (1a90f5db)

Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)

Allow editing of Team descriptions (#839) (c0021747)

Add description to Organizations (#838) (1d918809)

Source code(tar.gz)
Source code(zip)
v1.41(Aug 19, 2018)
Version 1.41 (August 19, 2018)

v1.41 is not available on pypi

BUGFIX

Repository.get_archive_link will now NOT follow HTTP redirect and return the url instead (#858) (43d325a5)

Fixed Gistfile.content (#486) (e1df09f7)

Restored NamedUser.contributions attribute (#865) (b91dee8d)

New features

Add support for repository topics (#832) (c6802b51)

Branch Protection API overhaul (#790) (171cc567)

(breaking) Removed Repository.protect_branch

Add BranchProtection <https://pygithub.readthedocs.io/en/latest/github_objects/BranchProtection.html>__

Add RequiredPullRequestReviews <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredPullRequestReviews.html>__

Add RequiredStatusChecks <https://pygithub.readthedocs.io/en/latest/github_objects/RequiredStatusChecks.html>__

Add Branch.get_protection, Branch.get_required_pull_request_reviews, Branch.get_required_status_checks, etc

Improvements

Add missing arguments to Repository.edit (#844) (29d23151)

Add missing properties to Repository (#842) (2b352fb3)

Adding archival support for Repository.edit (#843) (1a90f5db)

Add tag_name and target_commitish arguments to GitRelease.update_release (#834) (790f7dae)

Allow editing of Team descriptions (#839) (c0021747)

Add description to Organizations (#838) (1d918809)

Source code(tar.gz)
Source code(zip)
v1.40(Jun 26, 2018)
Major enhancement: use requests for HTTP instead of httplib (#664) (9aed19dd)

Increase default timeout from 10s to 15s (#793) (140c6480)

Test Framework improvement (#795) (faa8f205)

Handle HTTP 202 HEAD & GET with a retry (#791) (3aead158)

Fix github API requests after asset upload (#771) (8bdac23c)

Add remove_membership() method to Teams class (#807) (817f2230)

Add check-in to projects using PyGithub (#814) (05f49a59)

Include target_commitish in GitRelease (#788) (ba5bf2d7)

Fix asset upload timeout, increase default timeout from 10s to 15s (#793) (140c6480)

Fix Team.description (#797) (0e8ae376)

Fix Content-Length invalid headers exception (#787) (23395f5f)

Remove NamedUser.contributions (#774) (a519e467)

Source code(tar.gz)
Source code(zip)
v1.40a4(Jun 26, 2018)
Increase default timeout from 10s to 15s (#793) (140c6480)

Fix Team.description (#797) (0e8ae376)

Fix Content-Length invalid headers exception (#787) (23395f5f)

Remove NamedUser.contributions (#774) (a519e467)

Branch protection methods no longer require loki (#775) (b1e9ae68)

Source code(tar.gz)
Source code(zip)
v1.40a3(Apr 26, 2018)
Add ability to skip SSL cert verification for Github Enterprise (#758) (85a9124b)

Correct Repository.get_git_tree recursive use (#767) (bd0cf309)

Source code(tar.gz)
Source code(zip)
v1.40a2(Apr 23, 2018)
Re-work PullRequest reviewer request (#765) (e2e29918)

Add support for team privacy (#763) (1f23c06a)

Add support for organization outside collaborators (#533) (c4446996)

Make use of issue_url in PullRequest (#755) (0dba048f)

Source code(tar.gz)
Source code(zip)

Typed interactions with the GitHub API v3

Related tags

Overview

PyGitHub

Install

Simple Demo

Documentation

Development

Contributing

Maintainership

Comments

Summary

Checklist

v6.0.0

Release 6.0.0 (released Dec 29, 2022)

Dependencies

Incompatible changes

Features added

Releases(v1.57)

v1.57(Nov 5, 2022)

v1.56(Oct 13, 2022)

v1.55(Apr 26, 2021)

v1.54.0.1(Apr 26, 2021)

v1.54.1(Dec 24, 2020)

v1.54(Nov 30, 2020)

v1.53(Aug 18, 2020)

v1.52(Aug 3, 2020)

v1.51(May 2, 2020)

v1.50(Apr 26, 2020)

v1.47(Mar 15, 2020)

v1.46(Feb 11, 2020)

v1.45(Dec 29, 2019)

v1.44.1(Nov 7, 2019)

v1.44(Oct 19, 2019)

v1.43.8(Jul 20, 2019)

v1.43.7(Apr 16, 2019)

v1.43.6(Apr 5, 2019)

v1.43.5(Jan 29, 2019)

v1.43.4(Dec 21, 2018)

v1.43.3(Oct 31, 2018)

v1.43.2(Sep 12, 2018)

Version 1.43.2 (September 12, 2018)

v1.43.1(Sep 11, 2018)

Version 1.43.1 (September 11, 2018)

v1.43(Sep 8, 2018)

Version 1.43 (September 08, 2018)

v1.42(Aug 19, 2018)

Version 1.42 (August 19, 2018)

v1.41(Aug 19, 2018)

Version 1.41 (August 19, 2018)

v1.40(Jun 26, 2018)

v1.40a4(Jun 26, 2018)

v1.40a3(Apr 26, 2018)

v1.40a2(Apr 23, 2018)

Owner

A complete Python application to automatize the process of uploading files to Amazon S3

AnyAPI is a library that helps you to write any API wrapper with ease and in pythonic way.

Easy to use reaction role Discord bot written in Python.

2b2t Priority queue discord bot announcer

A bot to get Statistics like the Playercount from your Minecraft-Server on your Discord-Server

Translates English into Mandalorian (Mando'a) utilizing a "funtranslations" free API

LHXP・Official "LH - Cyber Security" Discord Leveling-Bot

Simple debugger and tester for dico-command.

Google Drive, OneDrive and Youtube as covert-channels - Control systems remotely by uploading files to Google Drive, OneDrive, Youtube or Telegram

Collection of AWS Fault Injection Simulator (FIS) experiment templates.

Pancakeswap Sniper BOT - TORNADO CASH Proxy (MAC WINDOWS ANDROID LINUX) A fully decentralized protocol for private transactions

A hilarious program that translates text to Google's

A customizable, multilanguage Telegram shop bot with Telegram Payments support

A simple and easy to use musicbot in python and it uses lavalink.

Send SMS text messages via email with as many accounts as you want :)

Anime Themed Telegram Group Manager Bot By WaifuNetwork

Automatic Video Library Manager for TV Shows

Source code of BobuxAdmin bot from Bobux Bot Development server.

Signs API calls to SberCloud.Advanced with AK/SK

Python-random-quote - A file-based quote bot written in Python