This is a Python (2 and 3) 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.10.0 (December 25th, 2012) (Christmas 2012 edition)
- Major improvement: support Python 3! PyGithub is automaticaly tested on Travis with versions 2.5, 2.6, 2.7, 3.1 and 3.2 of Python
- Add a shortcut function
Github.get_repoto get a repo directly from its full name. thank you lwc for the contribution
- Add the optional
get_readme. Thank you fixxxeruk for the contribution
- Get comments for all issues and all pull requests on a repository (
Download and install
First create a Github 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