This is a Python library to access the Github API v3.
With it, you can manage your Github resources (repositories, user profiles, organizations, etc.) from Python scripts.
It covers the full API, and all methods are tested against the real Github site.
Should you have any question, or if you find a bug, or if there is something you can do with the API but not with PyGithub, please open an issue.
PyGithub is stable. I will maintain it up to date with the API, and fix bugs if any, but I don't plan new heavy developments.
Version 1.8.1 (October 28th, 2012)
- Repository.get_git_ref prepends "refs/" to the requested references. Thank you simon-weber for noting the incoherence between documentation and behavior. If you feel like it's a breaking change, please see this issue
Download and install
First create a Gihtub instance:
from github import Github g = Github( "user", "password" )
Then play with your Github objects:
for repo in g.get_user().get_repos(): print repo.name repo.edit( has_wiki = False )
You can also create a Github instance with an OAuth token:
g = Github( token )
Or without authentication:
g = Github()
You need to use a Github API and wonder which class implements it? Reference of APIs
You want all the details about PyGithub classes? Reference of classes
PyGithub is distributed under the GNU Lesser General Public Licence. See files COPYING and COPYING.LESSER, as requested by GNU.
Projects using PyGithub
(Open an issue if you want to be listed here, I'll be glad to add your project)
- Upverter is a web-based schematic capture and PCB layout tool for people who design electronics. Designers can attach a Github project to an Upverter project.
- Tratihubis converts Trac tickets to Github issues
- https://github.com/natduca/quickopen uses PyGithub to automaticaly create issues