Files
PyGithub/ReadMe.md
T
2012-03-04 09:45:59 +00:00

70 lines
1.9 KiB
Markdown

This is a Python library to access the [Github API v3](http://developer.github.com/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 I'm sure I'll finish it soon. The aim is to cover the **full** API in version 1.0.
Download and install
====================
This package is in the [Python Package Index](http://pypi.python.org/pypi/PyGithub).
You can also clone it on [Github](http://github.com/jacquev6/PyGithub).
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.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