Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Python library implementing the full Github API v3

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 doc
Octocat-spinner-32 github
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 COPYING
Octocat-spinner-32 COPYING.LESSER
Octocat-spinner-32 Contributing.md
Octocat-spinner-32 ReadMe.md
Octocat-spinner-32 publish.sh
Octocat-spinner-32 python25-requirements.txt
Octocat-spinner-32 setup.py
ReadMe.md

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.

What's new?

Build Status

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

Previous versions

See ChangeLog.

Download and install

This package is in the Python Package Index, so easy_install PyGithub or pip install PyGithub should be enough. You can also clone it on Github.

Tutorial

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()

Reference documentation

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

Licensing

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)

They talk about PyGithub

Something went wrong with that request. Please try again.