diff --git a/README.rst b/README.rst index f9384deb..e2a3f116 100644 --- a/README.rst +++ b/README.rst @@ -10,21 +10,12 @@ PyGithub is stable. I will maintain it up to date with the API, and fix bugs if What's new? =========== -Version 1.12.2 (March 3rd, 2013) --------------------------------- +`Version 1.13.0 `_ (March 15th, 2013) (`ksookocheff-va `_'s edition) +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -* `Fix `_ major issue with Python 3: Json decoding was broken. Thank you `bilderbuchi `_ for reporting +All issues solved in this version were reported by `ksookocheff-va `_. Thank you! -Version 1.12.1 (February 20th, 2013) ------------------------------------- - -* Nothing, but packaging/upload of 1.12.0 failed - -`Version 1.12.0 `_ (February 20th, 2013) ---------------------------------------------------------------------------------------------------------------- - -* Much better documentation: http://jacquev6.github.com/PyGithub -* `Implement `_ ``github.Repository.Repository.get_gir_contents``. Thank you `ksookocheff-va `_ for asking +* `Fix `_ for Python 3 on case-insensitive file-systems Documentation ============= diff --git a/doc/apis.rst b/doc/apis.rst index bff00fa2..48e4601c 100644 --- a/doc/apis.rst +++ b/doc/apis.rst @@ -23,7 +23,7 @@ APIs * ``/gists/:id`` - * GET: :meth:`github.Github.Github.get_gist` + * GET: :meth:`github.MainClass.Github.get_gist` * PATCH: :meth:`github.Gist.Gist.edit` * DELETE: :meth:`github.Gist.Gist.delete` @@ -50,7 +50,7 @@ APIs * ``/gists/public`` - * GET: :meth:`github.Github.Github.get_gists` + * GET: :meth:`github.MainClass.Github.get_gists` * ``/gists/starred`` @@ -58,15 +58,15 @@ APIs * ``/gitignore/templates`` - * GET: :meth:`github.Github.Github.get_gitignore_templates` + * GET: :meth:`github.MainClass.Github.get_gitignore_templates` * ``/gitignore/templates/:name`` - * GET: :meth:`github.Github.Github.get_gitignore_template` + * GET: :meth:`github.MainClass.Github.get_gitignore_template` * ``/hooks`` - * GET: :meth:`github.Github.Github.get_hooks` + * GET: :meth:`github.MainClass.Github.get_hooks` * ``/hub`` @@ -82,19 +82,19 @@ APIs * ``/legacy/repos/search/:keyword`` - * GET: :meth:`github.Github.Github.legacy_search_repos` + * GET: :meth:`github.MainClass.Github.legacy_search_repos` * ``/legacy/user/email/:email`` - * GET: :meth:`github.Github.Github.legacy_search_user_by_email` + * GET: :meth:`github.MainClass.Github.legacy_search_user_by_email` * ``/legacy/user/search/:keyword`` - * GET: :meth:`github.Github.Github.legacy_search_users` + * GET: :meth:`github.MainClass.Github.legacy_search_users` * ``/markdown`` - * POST: :meth:`github.Github.Github.render_markdown` + * POST: :meth:`github.MainClass.Github.render_markdown` * ``/markdown/raw`` @@ -106,7 +106,7 @@ APIs * ``/orgs/:org`` - * GET: :meth:`github.Github.Github.get_organization` + * GET: :meth:`github.MainClass.Github.get_organization` * PATCH: :meth:`github.Organization.Organization.edit` * ``/orgs/:org/events`` @@ -148,7 +148,7 @@ APIs * ``/repos/:user/:repo`` - * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_repo` or :meth:`github.NamedUser.NamedUser.get_repo` or :meth:`github.Organization.Organization.get_repo` or :meth:`github.Github.Github.get_repo` + * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_repo` or :meth:`github.NamedUser.NamedUser.get_repo` or :meth:`github.Organization.Organization.get_repo` or :meth:`github.MainClass.Github.get_repo` * PATCH: :meth:`github.Repository.Repository.edit` * DELETE: :meth:`github.Repository.Repository.delete` @@ -482,7 +482,7 @@ APIs * ``/user`` - * GET: :meth:`github.Github.Github.get_user` + * GET: :meth:`github.MainClass.Github.get_user` * PATCH: :meth:`github.AuthenticatedUser.AuthenticatedUser.edit` * ``/user/emails`` @@ -557,7 +557,7 @@ APIs * ``/users/:user`` - * GET: :meth:`github.Github.Github.get_user` + * GET: :meth:`github.MainClass.Github.get_user` * ``/users/:user/events`` diff --git a/doc/changes.rst b/doc/changes.rst index 1191777e..6fb47af9 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -31,14 +31,14 @@ Version 1.12.1 (February 20th, 2013) * 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.Github.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) ---------------------------------------------------------------------------------------------------------------------------------------- * 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.Github.Github.get_repo` to get a repo directly from its full name. thank you `lwc `_ for the contribution -* :meth:`github.Github.Github.get_gitignore_templates` and :meth:`github.Github.Github.get_gitignore_template` for APIs ``/gitignore/templates`` +* 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 * Get comments for all issues and all pull requests on a repository (``GET /repos/:user/:repo/pulls/comments``: :meth:`github.Repository.Repository.get_pulls_comments` or :meth:`github.Repository.Repository.get_pulls_review_comments`; ``GET /repos/:user/:repo/issues/comments``: :meth:`github.Repository.Repository.get_issues_comments`) diff --git a/doc/github.rst b/doc/github.rst index 1668ca3a..848d0baa 100644 --- a/doc/github.rst +++ b/doc/github.rst @@ -1,4 +1,4 @@ Main class: Github ================== -.. autoclass:: github.Github.Github +.. autoclass:: github.MainClass.Github diff --git a/github/Github.py b/github/MainClass.py similarity index 100% rename from github/Github.py rename to github/MainClass.py diff --git a/github/__init__.py b/github/__init__.py index 46fe5e60..f1253cbc 100644 --- a/github/__init__.py +++ b/github/__init__.py @@ -14,14 +14,14 @@ # You should have received a copy of the GNU Lesser General Public License along with PyGithub. If not, see . """ -The primary class you will instanciate is :class:`github.Github.Github`. +The primary class you will instanciate is :class:`github.MainClass.Github`. From its ``get_``, ``create_`` methods, you will obtain instances of all Github objects like :class:`github.NamedUser.NamedUser` or :class:`github.Repository.Repository`. """ import logging -from Github import Github +from MainClass import Github from GithubException import GithubException from InputFileContent import InputFileContent from InputGitAuthor import InputGitAuthor