diff --git a/doc/changes.rst b/doc/changes.rst index b8cd0c82..76f355d2 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -4,135 +4,143 @@ Change log Stable versions ~~~~~~~~~~~~~~~ -`Version 1.20.0 `_ (October 20th, 2013) (First Seattle edition) --------------------------------------------------------------------------------------------------------------------------------------- +`Version 1.21.0 `__ (November ??th, 2013) +---------------------------------------------------------------------------------------------------------------- -* `Implement `_ ``Github.get_hook(name)``. Thank you `klmitch `_ for asking -* In case bad data is returned by Github API v3, `raise `_ an exception only when the user accesses the faulty attribute, not when constructing the object containing this attribute. Thank you `klmitch `_ for asking -* `Fix `_ parameter public/private of ``Repository.edit``. Thank you `daireobroin449 `_ for reporting the issue +* `Accept `__ strings as well as ``Label`` objects in ``Issue.add_to_labels``, ``Issue.remove_from_labels`` and ``Issue.set_labels``. Thank you `acdha `__ for asking +* `Implement `__ equality comparison for *completable* github objects (ie. those who have a ``url`` attribute). Warning, comparison is still not implemented for non-completable objects. This will be done in version 2.0 of PyGithub. Thank you `OddBloke `__ for asking +* `Add `__ parameter ``author`` to ``Repository.get_commits``. Thank you `naorrosenberg `__ for asking +* `Implement `__ the statistics end points. Thank you `naorrosenberg `__ for asking + +`Version 1.20.0 `__ (October 20th, 2013) (First Seattle edition) +--------------------------------------------------------------------------------------------------------------------------------------- + +* `Implement `__ ``Github.get_hook(name)``. Thank you `klmitch `__ for asking +* In case bad data is returned by Github API v3, `raise `__ an exception only when the user accesses the faulty attribute, not when constructing the object containing this attribute. Thank you `klmitch `__ for asking +* `Fix `__ parameter public/private of ``Repository.edit``. Thank you `daireobroin449 `__ for reporting the issue * Remove ``Repository.create_download`` and ``NamedUser.create_gist`` as the corrensponding APIs are not documented anymore -`Version 1.19.0 `_ (September 8th, 2013) (AKFish's edition) ----------------------------------------------------------------------------------------------------------------------------------- +`Version 1.19.0 `__ (September 8th, 2013) (AKFish's edition) +----------------------------------------------------------------------------------------------------------------------------------- -* Implement `conditional requests `_ by the method ``GithubObject.update``. Thank you very much `akfish `_ for the pull request and your collaboration! +* Implement `conditional requests `__ by the method ``GithubObject.update``. Thank you very much `akfish `__ for the pull request and your collaboration! * Implement persistence of PyGithub objects: ``Github.save`` and ``Github.load``. Don't forget to ``update`` your objects after loading them, it won't decrease your rate limiting quota if nothing has changed. Again, thank you `akfish `_ * Implement ``Github.get_repos`` to get all public repositories * Implement ``NamedUser.has_in_following`` -* `Implement `_ ``Github.get_api_status``, ``Github.get_last_api_status_message`` and ``Github.get_api_status_messages``. Thank you `ruxandraburtica `_ for asking +* `Implement `__ ``Github.get_api_status``, ``Github.get_last_api_status_message`` and ``Github.get_api_status_messages``. Thank you `ruxandraburtica `__ for asking * Implement ``Github.get_rate_limit`` * Add many missing attributes -* Technical change: HTTP headers are now stored in retrieved objects. This is a base for new functionalities. Thank you `akfish `_ for the pull request +* Technical change: HTTP headers are now stored in retrieved objects. This is a base for new functionalities. Thank you `akfish `__ for the pull request * Use the new URL to fork gists (minor change) * Use the new URL to test hooks (minor change) -`Version 1.18.0 `_ (August 21st, 2013) (Bénodet edition) -------------------------------------------------------------------------------------------------------------------------------- +`Version 1.18.0 `__ (August 21st, 2013) (Bénodet edition) +-------------------------------------------------------------------------------------------------------------------------------- -* `Issues `_' ``repository`` attribute will never be ``None``. Thank you `stuglaser `_ for the pull request -* No more false assumption on `rate_limiting `_, and creation of ``rate_limiting_resettime``. Thank you `edjackson `_ for the pull request -* `New `_ parameters ``since`` and ``until`` to ``Repository.get_commits``. Thank you `apetresc `_ for the pull request -* `Catch `_ Json parsing exception for some internal server errors, and throw a better exception. Thank you `MarkRoddy `_ for the pull request -* `Allow `_ reversed iteration of ``PaginatedList``s. Thank you `davidbrai `_ for the pull request +* `Issues `_' ``repository`` attribute will never be ``None``. Thank you `stuglaser `__ for the pull request +* No more false assumption on `rate_limiting `_, and creation of ``rate_limiting_resettime``. Thank you `edjackson `__ for the pull request +* `New `__ parameters ``since`` and ``until`` to ``Repository.get_commits``. Thank you `apetresc `__ for the pull request +* `Catch `__ Json parsing exception for some internal server errors, and throw a better exception. Thank you `MarkRoddy `__ for the pull request +* `Allow `__ reversed iteration of ``PaginatedList``s. Thank you `davidbrai `__ for the pull request -`Version 1.17.0 `_ (Jully 7th, 2013) (Hamburg edition) ------------------------------------------------------------------------------------------------------------------------------ +`Version 1.17.0 `__ (Jully 7th, 2013) (Hamburg edition) +------------------------------------------------------------------------------------------------------------------------------ -* `Fix `_ bug in ``Repository.get_comment`` when using custom ``per_page``. Thank you `davidbrai `_ -* `Handle `_ Http redirects in ``Repository.get_dir_contents``. Thank you `MarkRoddy `_ -* `Implement `_ API ``/user`` in ``Github.get_users``. Thank you `rakeshcusat `_ for asking -* `Improve `_ the documentation. Thank you `martinqt `_ +* `Fix `__ bug in ``Repository.get_comment`` when using custom ``per_page``. Thank you `davidbrai `_ +* `Handle `__ Http redirects in ``Repository.get_dir_contents``. Thank you `MarkRoddy `_ +* `Implement `__ API ``/user`` in ``Github.get_users``. Thank you `rakeshcusat `__ for asking +* `Improve `__ the documentation. Thank you `martinqt `_ Version 1.16.0 (May 31th, 2013) (Concarneau edition) ---------------------------------------------------- -* `Add `_ the html_url attribute to IssueComment and PullRequestComment +* `Add `__ the html_url attribute to IssueComment and PullRequestComment -`Version 1.15.0 `_ (May 17th, 2013) (Switzerland edition) --------------------------------------------------------------------------------------------------------------------------------- +`Version 1.15.0 `__ (May 17th, 2013) (Switzerland edition) +--------------------------------------------------------------------------------------------------------------------------------- -* `Implement `_ listing of user issues with all parameters. Thank you Daehyok Shin for reporting -* `Raise `_ two new specific exceptions +* `Implement `__ listing of user issues with all parameters. Thank you Daehyok Shin for reporting +* `Raise `__ two new specific exceptions -`Version 1.14.2 `_ (April 25th, 2013) ------------------------------------------------------------------------------------------------------------- +`Version 1.14.2 `__ (April 25th, 2013) +------------------------------------------------------------------------------------------------------------- -* `Fix `_ paginated requests when using secret-key oauth. Thank you `jseabold `_ for analysing the bug +* `Fix `__ paginated requests when using secret-key oauth. Thank you `jseabold `__ for analysing the bug -`Version 1.14.1 `_ (April 25th, 2013) ------------------------------------------------------------------------------------------------------------- +`Version 1.14.1 `__ (April 25th, 2013) +------------------------------------------------------------------------------------------------------------- -* Set the default User-Agent header to "PyGithub/Python". (Github has `enforced the User Agent header `_ yesterday.) Thank you `jjh42 `_ for `the fix `_, thank you `jasenmh `_ and `pconrad `_ for reporting `the issue `_. +* Set the default User-Agent header to "PyGithub/Python". (Github has `enforced the User Agent header `__ yesterday.) Thank you `jjh42 `__ for `the fix `_, thank you `jasenmh `__ and `pconrad `__ for reporting `the issue `_. -`Version 1.14.0 `_ (April 22nd, 2013) ------------------------------------------------------------------------------------------------------------- +`Version 1.14.0 `__ (April 22nd, 2013) +------------------------------------------------------------------------------------------------------------- -* `Improve `_ gist edition. Thank you `jasonwiener `_ for asking: +* `Improve `__ gist edition. Thank you `jasonwiener `__ for asking: * Delete a file with ``gist.edit(files={"name.txt": None})`` * Rename a file with ``gist.edit(files={"old_name.txt": github.InputFileContent(gist.files["old_name.txt"].content, new_name="new_name.txt")})`` -* `Raise `_ specific exceptions. Thank you `pconrad `_ for giving me the idea +* `Raise `__ specific exceptions. Thank you `pconrad `__ for giving me the idea Version 1.13.1 (March 28nd, 2013) --------------------------------- -* `Fix `_ login/password authentication for Python 3. Thank you `sebastianstigler `_ for reporting +* `Fix `__ login/password authentication for Python 3. Thank you `sebastianstigler `__ for reporting -`Version 1.13.0 `_ (March 22nd, 2013) ------------------------------------------------------------------------------------------------------------- +`Version 1.13.0 `__ (March 22nd, 2013) +------------------------------------------------------------------------------------------------------------- -* `Fix `_ for Python 3 on case-insensitive file-systems. Thank you `ptwobrussell `_ for reporting -* `Expose `_ raw data returned by Github for all objects. Thank you `ptwobrussell `_ for asking -* `Add `_ a property :attr:`github.MainClass.Github.per_page` (and a parameter to the constructor) to change the number of items requested in paginated requests. Thank you again `ptwobrussell `_ for asking -* `Implement `_ the first part of the `Notifications `_ API. Thank you `pgolm `_ -* `Fix `_ automated tests on Python 3.3. Thank you `bkabrda `_ for reporting +* `Fix `__ for Python 3 on case-insensitive file-systems. Thank you `ptwobrussell `__ for reporting +* `Expose `__ raw data returned by Github for all objects. Thank you `ptwobrussell `__ for asking +* `Add `__ a property :attr:`github.MainClass.Github.per_page` (and a parameter to the constructor) to change the number of items requested in paginated requests. Thank you again `ptwobrussell `__ for asking +* `Implement `__ the first part of the `Notifications `__ API. Thank you `pgolm `_ +* `Fix `__ automated tests on Python 3.3. Thank you `bkabrda `__ for reporting Version 1.12.2 (March 3rd, 2013) -------------------------------- -* `Fix `_ major issue with Python 3: Json decoding was broken. Thank you `bilderbuchi `_ for reporting +* `Fix `__ major issue with Python 3: Json decoding was broken. Thank you `bilderbuchi `__ for reporting Version 1.12.1 (February 20th, 2013) ------------------------------------ * Nothing, but packaging/upload of 1.12.0 failed -`Version 1.12.0 `_ (February 20th, 2013) ---------------------------------------------------------------------------------------------------------------- +`Version 1.12.0 `__ (February 20th, 2013) +---------------------------------------------------------------------------------------------------------------- * Much better documentation: http://jacquev6.github.com/PyGithub -* `Implement `_ :meth:`github.Repository.Repository.get_dir_contents`. Thank you `ksookocheff-va `_ for asking +* `Implement `__ :meth:`github.Repository.Repository.get_dir_contents`. Thank you `ksookocheff-va `__ for asking -`Version 1.11.1 `_ (February 9th, 2013) (London edition) -------------------------------------------------------------------------------------------------------------------------------- +`Version 1.11.1 `__ (February 9th, 2013) (London edition) +-------------------------------------------------------------------------------------------------------------------------------- -* Fix `bug `_ in lazy completion. Thank you `ianozsvald `_ for pinpointing it +* Fix `bug `__ in lazy completion. Thank you `ianozsvald `__ for pinpointing it -`Version 1.11.0 `_ (February 7th, 2013) --------------------------------------------------------------------------------------------------------------- +`Version 1.11.0 `__ (February 7th, 2013) +--------------------------------------------------------------------------------------------------------------- -* Fix bug in PaginatedList without url parameters. Thank you `llimllib `_ for the `contribution `_ -* `Implement `_ :meth:`github.NamedUser.NamedUser.get_keys` +* Fix bug in PaginatedList without url parameters. Thank you `llimllib `__ for the `contribution `_ +* `Implement `__ :meth:`github.NamedUser.NamedUser.get_keys` * `Support PubSubHub `_: :meth:`github.Repository.Repository.subscribe_to_hub` and :meth:`github.Repository.Repository.unsubscribe_from_hub` -* `Publish the oauth scopes `_ in :attr:`github.MainClass.Github.oauth_scopes`, thank you `bilderbuchi `_ for asking +* `Publish the oauth scopes `__ in :attr:`github.MainClass.Github.oauth_scopes`, thank you `bilderbuchi `__ for asking -`Version 1.10.0 `_ (December 25th, 2012) (Christmas 2012 edition) ----------------------------------------------------------------------------------------------------------------------------------------- +`Version 1.10.0 `__ (December 25th, 2012) (Christmas 2012 edition) +----------------------------------------------------------------------------------------------------------------------------------------- -* Major improvement: support Python 3! PyGithub is automaticaly tested on `Travis `_ with versions 2.5, 2.6, 2.7, 3.1 and 3.2 of Python -* Add a shortcut function :meth:`github.MainClass.Github.get_repo` to get a repo directly from its full name. thank you `lwc `_ for the contribution +* Major improvement: support Python 3! PyGithub is automaticaly tested on `Travis `__ with versions 2.5, 2.6, 2.7, 3.1 and 3.2 of Python +* Add a shortcut function :meth:`github.MainClass.Github.get_repo` to get a repo directly from its full name. thank you `lwc `__ for the contribution * :meth:`github.MainClass.Github.get_gitignore_templates` and :meth:`github.MainClass.Github.get_gitignore_template` for APIs ``/gitignore/templates`` -* Add the optional ``ref`` parameter to :meth:`github.Repository.Repository.get_contents` and :meth:`github.Repository.Repository.get_readme`. Thank you `fixxxeruk `_ for the contribution +* Add the optional ``ref`` parameter to :meth:`github.Repository.Repository.get_contents` and :meth:`github.Repository.Repository.get_readme`. Thank you `fixxxeruk `__ for the contribution * Get comments for all issues and all pull requests on a repository (``GET /repos/:owner/:repo/pulls/comments``: :meth:`github.Repository.Repository.get_pulls_comments` or :meth:`github.Repository.Repository.get_pulls_review_comments`; ``GET /repos/:owner/:repo/issues/comments``: :meth:`github.Repository.Repository.get_issues_comments`) -`Version 1.9.1 `_ (November 20th, 2012) --------------------------------------------------------------------------------------------------------------- +`Version 1.9.1 `__ (November 20th, 2012) +--------------------------------------------------------------------------------------------------------------- * Fix an assertion failure when integers returned by Github do not fit in a Python ``int`` -`Version 1.9.0 `_ (November 19th, 2012) --------------------------------------------------------------------------------------------------------------- +`Version 1.9.0 `__ (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 @@ -148,108 +156,108 @@ Version 1.12.1 (February 20th, 2013) + Restore coverage measurement in setup.py test + Small refactoring -`Version 1.8.1 `_ (October 28th, 2012) -------------------------------------------------------------------------------------------------------------- +`Version 1.8.1 `__ (October 28th, 2012) +-------------------------------------------------------------------------------------------------------------- -* Repository.get_git_ref prepends "refs/" to the requested references. Thank you `simon-weber `_ for noting the incoherence between documentation and behavior. If you feel like it's a breaking change, please see `this issue `_ +* Repository.get_git_ref prepends "refs/" to the requested references. Thank you `simon-weber `__ for noting the incoherence between documentation and behavior. If you feel like it's a breaking change, please see `this issue `_ -`Version 1.8.0 `_ (September 30th, 2012) ---------------------------------------------------------------------------------------------------------------- +`Version 1.8.0 `__ (September 30th, 2012) +---------------------------------------------------------------------------------------------------------------- * Enable `Travis CI `_ -* Fix error 500 when json payload contains percent character (`%`). Thank you again `quixotique `_ for pointing that and reporting it to Github -* Enable debug logging. Logger name is `"github"`. Simple logging can be enabled by `github.enable_console_debug_logging()`. Thank you `quixotique `_ for the merge request and the advice -* Publish tests in the PyPi source archive to ease QA tests of the `FreeBSD port `_. Thank you `koobs `_ for maintaining this port +* Fix error 500 when json payload contains percent character (`%`). Thank you again `quixotique `__ for pointing that and reporting it to Github +* Enable debug logging. Logger name is `"github"`. Simple logging can be enabled by `github.enable_console_debug_logging()`. Thank you `quixotique `__ for the merge request and the advice +* Publish tests in the PyPi source archive to ease QA tests of the `FreeBSD port `_. Thank you `koobs `__ for maintaining this port * Switch to `Semantic Versioning `_ * Respect `pep8 Style Guide for Python Code `_ -`Version 1.7 `_ (September 12th, 2012) -------------------------------------------------------------------------------------------------------------- +`Version 1.7 `__ (September 12th, 2012) +-------------------------------------------------------------------------------------------------------------- -* Be able to clear the assignee and the milestone of an Issue. Thank you `quixotique `_ for the merge request -* Fix an AssertionFailure in `Organization.get_xxx` when using Github Enterprise. Thank you `mnsanghvi `_ for pointing that -* Expose pagination to users needing it (`PaginatedList.get_page`). Thank you `kukuts `_ for asking +* Be able to clear the assignee and the milestone of an Issue. Thank you `quixotique `__ for the merge request +* Fix an AssertionFailure in `Organization.get_xxx` when using Github Enterprise. Thank you `mnsanghvi `__ for pointing that +* Expose pagination to users needing it (`PaginatedList.get_page`). Thank you `kukuts `__ for asking * Improve handling of legacy search APIs * Small refactoring (documentation, removal of old code generation artifacts) -`Version 1.6 `_ (September 8th, 2012) ------------------------------------------------------------------------------------------------------------- +`Version 1.6 `__ (September 8th, 2012) +------------------------------------------------------------------------------------------------------------- * Restore support for Python 2.5 * Implement new APIS: * /hooks (undocumented, but mentioned in http://developer.github.com/v3/repos/hooks/#create-a-hook) * `Merging `_ - * `Starring `_ and `subscriptions `_ + * `Starring `__ and `subscriptions `_ * `Assignees `_ * `Commit statuses `_ - * `Contents `_, thank you `berndca `_ for asking + * `Contents `_, thank you `berndca `__ for asking -* Clarify issue and review comments on PullRequest, thank you `nixoz2k7 `_ for asking +* Clarify issue and review comments on PullRequest, thank you `nixoz2k7 `__ for asking -`Version 1.5 `_ (September 5th, 2012) ------------------------------------------------------------------------------------------------------------ +`Version 1.5 `__ (September 5th, 2012) +------------------------------------------------------------------------------------------------------------ -* Add a timeout option, thank you much `xobb1t `_ for the merge request. *This drops Python 2.5 support*. I may be able to restore it in next version. -* Implement `Repository.delete`, thank you `pmchen `_ for asking +* Add a timeout option, thank you much `xobb1t `__ for the merge request. *This drops Python 2.5 support*. I may be able to restore it in next version. +* Implement `Repository.delete`, thank you `pmchen `__ for asking -`Version 1.4 `_ (August 4th, 2012) +`Version 1.4 `__ (August 4th, 2012) +--------------------------------------------------------------------------------------------------------- + +* Allow connection to a custom Github URL, for Github Enterprise, thank you very much `engie `__ for the merge request + +`Version 1.3 `__ (July 13th, 2012) -------------------------------------------------------------------------------------------------------- -* Allow connection to a custom Github URL, for Github Enterprise, thank you very much `engie `_ for the merge request - -`Version 1.3 `_ (July 13th, 2012) -------------------------------------------------------------------------------------------------------- - * Implement `markdown rendering `_ * `GitAuthor.date` is now a datetime, thank you `bilderbuchi `_ * Fix documentation of `Github.get_gist`: `id` is a string, not an integer -`Version 1.2 `_ (June 29th, 2012) -------------------------------------------------------------------------------------------------------- +`Version 1.2 `__ (June 29th, 2012) +-------------------------------------------------------------------------------------------------------- -* Implement `legacy search APIs `_, thank you `kukuts `_ for telling me Github had released them -* Fix a bug with issue labels containing spaces, thank you `philipkimmey `_ for detecting the bug and fixing it -* Clarify how collections of objects are returned by `get_*` methods, thank you `bilderbuchi `_ for asking +* Implement `legacy search APIs `_, thank you `kukuts `__ for telling me Github had released them +* Fix a bug with issue labels containing spaces, thank you `philipkimmey `__ for detecting the bug and fixing it +* Clarify how collections of objects are returned by `get_*` methods, thank you `bilderbuchi `__ for asking Version 1.1 (June 20th, 2012) ----------------------------- * Restore compatibility with Python 2.5, thank you `pmuilu `_ -* Use `package_data` instead of `data_files` for documentation files in `setup.py`, thank you `malexw `_ for reporting +* Use `package_data` instead of `data_files` for documentation files in `setup.py`, thank you `malexw `__ for reporting -`Version 1.0 `_ (June 3rd, 2012) ------------------------------------------------------------------------------------------------------- +`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 `_, `roskakori `_ and `tallforasmurf `_ for reporting them! +* Some bugs and limitations fixed, special thanks to `bilderbuchi `_, `roskakori `__ and `tallforasmurf `__ for reporting them! Pre-release versions ~~~~~~~~~~~~~~~~~~~~ -`Version 0.7 `_ (May 26th, 2012) ------------------------------------------------------------------------------------------------------- +`Version 0.7 `__ (May 26th, 2012) +------------------------------------------------------------------------------------------------------- * Use PyGithub with OAuth authentication or with no authentication at all -`Version 0.6 `_ (April 17th, 2012) --------------------------------------------------------------------------------------------------------- +`Version 0.6 `__ (April 17th, 2012) +--------------------------------------------------------------------------------------------------------- -* Fix `issue 21 `_ (KeyError when accessing repositories) +* Fix `issue 21 `__ (KeyError when accessing repositories) * Re-completed the API with NamedUser.create_gist -`Version 0.5 `_ (March 19th, 2012) --------------------------------------------------------------------------------------------------------- +`Version 0.5 `__ (March 19th, 2012) +--------------------------------------------------------------------------------------------------------- * Major achievement: **all APIs are implemented** * More refactoring, of course -`Version 0.4 `_ (March 12th, 2012) --------------------------------------------------------------------------------------------------------- +`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*: diff --git a/doc/conf.py b/doc/conf.py index 0e7cbda1..1e6bf0a8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -320,7 +320,7 @@ for githubClass in githubClasses + ["MainClass"]: isProperty = True if line.startswith(" def "): if not isProperty: - assert method is None, method + " has no :calls: section" + assert method is None or (githubClass, method) in [("github.StatsPunchCard.StatsPunchCard", "get")], githubClass + "." + method + " has no :calls: section" method = line.split("(")[0][8:] if method in ["_initAttributes", "_useAttributes", "__init__", "__create_pull_1", "__create_pull_2", "__create_pull", "_hub", "__get_FIX_REPO_GET_GIT_REF", "__set_FIX_REPO_GET_GIT_REF", "__get_per_page", "__set_per_page", "create_from_raw_data", "dump", "load"]: method = None diff --git a/doc/introduction.rst b/doc/introduction.rst index c22a6b5e..64306ff7 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -1,12 +1,12 @@ Introduction ============ -PyGithub is a Python (2 and 3) library to use the `Github API v3 `_. -With it, you can manage your `Github `_ resources (repositories, user profiles, organizations, etc.) from Python scripts. +PyGithub is a Python (2 and 3) library to use the `Github API v3 `__. +With it, you can manage your `Github `__ resources (repositories, user profiles, organizations, etc.) from Python scripts. Should you have any question, any remark, 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 `_. +please `open an issue `__. (Very short) tutorial --------------------- @@ -26,32 +26,32 @@ Then play with your Github objects:: Download and install -------------------- -This package is in the `Python Package Index `_, +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 `_. +You can also clone it on `Github `__. Licensing --------- PyGithub is distributed under the GNU Lesser General Public Licence. -See files COPYING and COPYING.LESSER, as requested by `GNU `_. +See files COPYING and COPYING.LESSER, as requested by `GNU `__. What next? ---------- -You need to use a Github API and wonder which class implements it? `Reference of APIs `_ +You need to use a Github API and wonder which class implements it? `Reference of APIs `__ -You want all the details about PyGithub classes? `Reference of classes `_ +You want all the details about PyGithub classes? `Reference of classes `__ Projects using PyGithub ----------------------- -(`Open an issue `_ if you want to be listed here, I'll be glad to add your project) +(`Open an issue `__ if you want to be listed here, I'll be glad to add your project) * `DevAssistant `_ -* `Upverter `_ is a web-based schematic capture and PCB layout tool for people who design electronics. Designers can attach a Github project to an Upverter project. -* `Notifico `_ receives messages (such as commits and issues) from services and scripts and delivers them to IRC channels. It can import/sync from Github. -* `Tratihubis `_ converts Trac tickets to Github issues +* `Upverter `__ is a web-based schematic capture and PCB layout tool for people who design electronics. Designers can attach a Github project to an Upverter project. +* `Notifico `__ receives messages (such as commits and issues) from services and scripts and delivers them to IRC channels. It can import/sync from Github. +* `Tratihubis `__ converts Trac tickets to Github issues * https://github.com/CMB/cligh * https://github.com/natduca/quickopen uses PyGithub to automaticaly create issues * https://gist.github.com/3433798 diff --git a/github/tests/Repository.py b/github/tests/Repository.py index 5e81c857..05f6b33f 100644 --- a/github/tests/Repository.py +++ b/github/tests/Repository.py @@ -252,9 +252,9 @@ class Repository(Framework.TestCase): def testGetCommitsWithAuthor(self): self.g.per_page = 5 akfish = self.g.get_user("AKFish") - self.assertListKeyBegin(self.repo.get_commits(author=self.user), lambda c:c.sha, ["54f718a15770579a37ffbe7ae94ad30003407786"]) - self.assertListKeyBegin(self.repo.get_commits(author=akfish), lambda c:c.sha, ["38b137fb37c0fdc74f8802a4184518e105db9121"]) - self.assertListKeyBegin(self.repo.get_commits(author="m.ki2@laposte.net"), lambda c:c.sha, ["ab674dfcbc86c70bc32d9ecbe171b48a5694c337"]) + self.assertListKeyBegin(self.repo.get_commits(author=self.user), lambda c: c.sha, ["54f718a15770579a37ffbe7ae94ad30003407786"]) + self.assertListKeyBegin(self.repo.get_commits(author=akfish), lambda c: c.sha, ["38b137fb37c0fdc74f8802a4184518e105db9121"]) + self.assertListKeyBegin(self.repo.get_commits(author="m.ki2@laposte.net"), lambda c: c.sha, ["ab674dfcbc86c70bc32d9ecbe171b48a5694c337"]) def testGetDownloads(self): self.assertListKeyEqual(self.repo.get_downloads(), lambda d: d.id, [245143]) diff --git a/setup.py b/setup.py index b2105412..c0e94967 100755 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ import subprocess import shutil import os.path -version = "1.20.0" +version = "1.21.0" if __name__ == "__main__":