mirror of
https://github.com/status-im/PyGithub.git
synced 2026-09-01 11:21:16 +00:00
Vincent Jacques
6658713d27
I hope I've understood well http://docs.python.org/distutils/setupscript.html#installing-package-data
149 lines
4.7 KiB
Markdown
149 lines
4.7 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](http://github.com) 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](https://github.com/jacquev6/PyGithub/issues).
|
|
|
|
News (on June 3rd, 2012)
|
|
========================
|
|
|
|
Version 1.0 is out! You can now consider PyGithub stable. I will maintain it up to date with the API, and fix bugs if any, but I don't plan new heavy developments.
|
|
|
|
Download and install
|
|
====================
|
|
|
|
This package is in the [Python Package Index](http://pypi.python.org/pypi/PyGithub), so `easy_install PyGithub` or `pip install PyGithub` should be enough.
|
|
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 )
|
|
|
|
You can also create a Github instance with an OAuth token:
|
|
|
|
g = Github( token )
|
|
|
|
Or without authentication:
|
|
|
|
g = Github()
|
|
|
|
Licensing
|
|
=========
|
|
|
|
PyGithub is distributed under the GNU Lesser General Public Licence.
|
|
See files COPYING and COPYING.LESSER, as requested by [GNU](http://www.gnu.org/licenses/gpl-howto.html).
|
|
|
|
Projects using PyGithub
|
|
=======================
|
|
|
|
([Open an issue](https://github.com/jacquev6/PyGithub/issues) if you want to be listed here, I'll be glad to add your project)
|
|
|
|
* [Tratihubis](http://pypi.python.org/pypi/tratihubis/) converts Trac tickets to Github issues
|
|
|
|
History
|
|
=======
|
|
|
|
Version 1.1 (June 20th, 2012)
|
|
-----------------------------
|
|
|
|
* Restore compatibility with Python 2.5, thank you [pmuilu](https://github.com/pmuilu)
|
|
* Use `package_data` instead of `data_files` for documentation files in `setup.py`, thank you [malexw](https://github.com/malexw) for reporting
|
|
|
|
Version 1.0 (June 3rd, 2012)
|
|
----------------------------
|
|
|
|
* Complete rewrite, with no more complicated meta-description
|
|
* Full typing of attributes and parameters
|
|
* Full documentation of attributes and parameters
|
|
* More usable exceptions raised in case on problems with the API
|
|
* Some bugs and limitations fixed, special thanks to [bilderbuchi](https://github.com/bilderbuchi), [roskakori](https://github.com/roskakori) and [tallforasmurf](https://github.com/tallforasmurf) for reporting them!
|
|
|
|
Version 0.7 (May 26th, 2012)
|
|
----------------------------
|
|
|
|
* Use PyGithub with OAuth authentication or with no authentication at all
|
|
|
|
Version 0.6 (April 17th, 2012)
|
|
------------------------------
|
|
|
|
* Fix [issue 21](https://github.com/jacquev6/PyGithub/issues/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
|