Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Python library implementing the full Github API v3
Python

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
ReplayDataForIntegrationTest
github
.gitignore
Design.md
IntegrationTest.py
ReadMe.md
ReferenceOfApis.md
ReferenceOfClasses.md
RoadMap.md
run_tests.sh
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 is still a work in progress, but it already covers the full API in version 0.5.

Next version (1.0) will focus on creating a really homogeneous and meaningful public interface. See the milestone on Github.

Should you have any question, or if you find a bug, please open an issue on Github.

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

History

Version 0.6 (April 17th, 2012)

  • Fix issue 21 (KeyError when accessing repositories)
  • Re-completed the API with NamedUser.create_gist

Version 0.5 (March 19th, 2012)

  • Major achievement: all APIs are implemented
  • More refactoring, of course

Version 0.4 (March 12th, 2012)

  • The list of the not implemented APIs is shorter than the list of the implemented APIs
  • APIs not implemented:
    • GET /gists/public
    • GET /issues
    • GET /repos/:user/:repo/compare/:base...:head
    • GET /repos/:user/:repo/git/trees/:sha?recursive=1
    • POST /repos/:user/:repo/git/trees?base_tree=
  • Gists
  • Autorizations
  • Keys
  • Hooks
  • Events
  • Merge pull requests
  • More refactoring, one more time

Version 0.3 (February 26th, 2012)

  • More refactoring
  • Issues, milestones and their labels
  • NamedUser:
    • emails
  • Repository:
    • downloads
    • tags, branches, commits and comments (not the same as "Git objects" of version 0.2)
    • pull requests (no automatic merge yet)
  • Automatic generation of the reference documentation of classes, with less "see API"s, and less errors

Version 0.2 (February 23rd, 2012)

  • Refactoring
  • Teams details and modification
    • basic attributes
    • list teams in organizations, on repositories
  • Git objects
    • create and get tags, references, commits, trees, blobs
    • list and edit references

Version 0.1 (February 19th, 2012)

  • User details and modification
    • basic attributes
    • followers, following, watching
    • organizations
    • repositories
  • Repository details and modification
    • basic attributes
    • forking
    • collaborators, contributors, watchers
  • Organization details and modification
    • basic attributes
    • members and public members
Something went wrong with that request. Please try again.