Merge branch 'develop'

ReferenceOfClasses.md

@@ -3,7 +3,7 @@ You obtain instances through calls to `get_` and `create_` methods.
 
 Class `Github`
 ==============
-* Constructed from user's login and password
+* Constructed from user's login and password or OAuth token
 * `get_user()`: `AuthenticatedUser`
 * `get_user( login )`: `NamedUser`
 * `get_organization( login )`: `Organization`

github/Github.py

@@ -2,8 +2,8 @@ from Requester import Requester
 from GithubObjects import *
 
 class Github:
-    def __init__( self, login, password, debugFile = None ):
-        self.__requester = Requester( login, password )
+    def __init__( self, login_or_token = None, password = None, debugFile = None ):
+        self.__requester = Requester( login_or_token, password )
         self.__debugFile = debugFile
 
     def _dataRequest( self, verb, url, parameters, data ):

github/Requester.py

@@ -7,8 +7,15 @@ class UnknownGithubObject( Exception ):
     pass
 
 class Requester:
-    def __init__( self, login, password ):
-        self.__authorizationHeader = "Basic " + base64.b64encode( login + ":" + password ).replace( '\n', '' )
+    def __init__( self, login_or_token, password ):
+        if password is not None:
+            login = login_or_token
+            self.__authorizationHeader = "Basic " + base64.b64encode( login + ":" + password ).replace( '\n', '' )
+        elif login_or_token is not None:
+            token = login_or_token
+            self.__authorizationHeader = "token " + token
+        else:
+            self.__authorizationHeader = None
 
     def dataRequest( self, verb, url, parameters, input ):
         if parameters is None:
@@ -46,12 +53,16 @@ class Requester:
     def __rawRequest( self, verb, url, parameters, input ):
         assert verb in [ "HEAD", "GET", "POST", "PATCH", "PUT", "DELETE" ]
 
+        headers = dict()
+        if self.__authorizationHeader is not None:
+            headers[ "Authorization" ] = self.__authorizationHeader
+
         cnx = httplib.HTTPSConnection( "api.github.com", strict = True )
         cnx.request(
             verb,
             self.__completeUrl( url, parameters ),
             json.dumps( input ),
-            { "Authorization" : self.__authorizationHeader }
+            headers
         )
         response = cnx.getresponse()
 

setup.py

@@ -5,7 +5,7 @@ import textwrap
 
 setup(
     name = 'PyGithub',
-    version = '0.6',
+    version = '0.7',
     description = 'Use the full Github API v3',
     author = 'Vincent Jacques',
     author_email = 'vincent@vincent-jacques.net',
@@ -26,6 +26,14 @@ setup(
                 print repo.name
                 repo.edit( has_wiki = False )
 
+        You can also create a Github instance without authentication::
+
+            g = Github( "user", "password" )
+
+        Or with an OAuth token::
+
+            g = Github( token )
+
         Reference documentation
         =======================