From 86033f8a626bcb3a01a434fa7f71496b367a6903 Mon Sep 17 00:00:00 2001 From: Vincent Jacques Date: Mon, 19 Nov 2012 21:40:17 +0100 Subject: [PATCH] Prepare version 1.9.0 --- ReadMe.md | 17 ++++++++++++++--- doc/ChangeLog.md | 16 ++++++++++++++++ doc/ReferenceOfClasses.md | 4 ++++ github/tests/Authentication.py | 2 +- 4 files changed, 35 insertions(+), 4 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index c3ad6035..92228dd1 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -13,10 +13,21 @@ What's new? [![Build Status](https://secure.travis-ci.org/jacquev6/PyGithub.png)](http://travis-ci.org/jacquev6/PyGithub) -[Version 1.8.1](https://github.com/jacquev6/PyGithub/issues?milestone=15&state=closed) (October 28th, 2012) ------------------------------------------------------------------------------------------------------------ +[Version 1.9.0](https://github.com/jacquev6/PyGithub/issues?milestone=14&state=closed) (November 19th, 2012) +------------------------------------------------------------------------------------------------------------ -* Repository.get_git_ref prepends "refs/" to the requested references. Thank you [simon-weber](https://github.com/simon-weber) for noting the incoherence between documentation and behavior. If you feel like it's a breaking change, please see [this issue](https://github.com/jacquev6/PyGithub/issues/104) +* You can now use your client_id and client_secret to increase rate limiting without authentication +* You can now send a custom User-Agent +* PullRequest now has its 'assignee' attribute, thank you [mstead](https://github.com/mstead) +* Repository.edit now has 'default_branch' parameter +* create_repo has 'auto_init' and 'gitignore_template' parameters +* GistComment URL is changed (see http://developer.github.com/changes/2012-10-31-gist-comment-uris) +* A typo in the readme was fixed by [tymofij](https://github.com/tymofij), thank you +* Internal stuff: + * Add encoding comment to Python files, thank you [Zearin](https://github.com/Zearin) + * Restore support of Python 2.5 + * Restore coverage measurement in setup.py test + * Small refactoring Previous versions ----------------- diff --git a/doc/ChangeLog.md b/doc/ChangeLog.md index f38329c4..f8ab7d11 100644 --- a/doc/ChangeLog.md +++ b/doc/ChangeLog.md @@ -1,3 +1,19 @@ +[Version 1.9.0](https://github.com/jacquev6/PyGithub/issues?milestone=14&state=closed) (November 19th, 2012) +------------------------------------------------------------------------------------------------------------ + +* You can now use your client_id and client_secret to increase rate limiting without authentication +* You can now send a custom User-Agent +* PullRequest now has its 'assignee' attribute, thank you [mstead](https://github.com/mstead) +* Repository.edit now has 'default_branch' parameter +* create_repo has 'auto_init' and 'gitignore_template' parameters +* GistComment URL is changed (see http://developer.github.com/changes/2012-10-31-gist-comment-uris) +* A typo in the readme was fixed by [tymofij](https://github.com/tymofij), thank you +* Internal stuff: + * Add encoding comment to Python files, thank you [Zearin](https://github.com/Zearin) + * Restore support of Python 2.5 + * Restore coverage measurement in setup.py test + * Small refactoring + [Version 1.8.1](https://github.com/jacquev6/PyGithub/issues?milestone=15&state=closed) (October 28th, 2012) ----------------------------------------------------------------------------------------------------------- diff --git a/doc/ReferenceOfClasses.md b/doc/ReferenceOfClasses.md index 048354cc..e34a3882 100644 --- a/doc/ReferenceOfClasses.md +++ b/doc/ReferenceOfClasses.md @@ -10,7 +10,11 @@ Constructed from user's login and password or OAuth token or nothing: g = Github( token ) g = Github() +You can also use your client_id and client_secret: + g = github.Github(client_id="YourClientId", client_secret="YourClientSecret") + You can add an argument `base_url = "http://my.enterprise.com:8080/path/to/github"` to connect to a local install of Github (ie. Github Enterprise). +You can add an argument `user_agent` to send a custom User-Agent header to Github. Another argument, that can be passed is `timeout` which has default value `10`. Attributes diff --git a/github/tests/Authentication.py b/github/tests/Authentication.py index 465d4077..7d585933 100644 --- a/github/tests/Authentication.py +++ b/github/tests/Authentication.py @@ -32,7 +32,7 @@ class Authentication(Framework.BasicTestCase): # Warning: I don't have a scret key, so the requests for this test are forged def testSecretKeyAuthentication(self): - g = github.Github(client_id=self.client_id,client_secret=self.client_secret) + g = github.Github(client_id=self.client_id, client_secret=self.client_secret) self.assertListKeyEqual(g.get_organization("BeaverSoftware").get_repos("public"), lambda r: r.name, ["FatherBeaver", "PyGithub"]) def testUserAgent(self):