diff options
| author |   David Medina <davidmedina9@gmail.com> | 2012-02-29 01:22:16 +0100 |
|---|---|---|
| committer | David Medina <davidmedina9@gmail.com> | 2012-02-29 01:22:16 +0100 |
| commit | d5a26bd35820b1cb3de991fd45460345b9d3f492 (patch) | |
| tree | db935b1c504b86b4208946f9e15c3d89b04611db /pygithub3/github.py | |
| parent | Repos.watchers service done (diff) | |
| download | python-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.tar.xz python-github3-d5a26bd35820b1cb3de991fd45460345b9d3f492.zip | |
Init documentation
+core
+services.user
~services.repos
Diffstat (limited to 'pygithub3/github.py')
| -rw-r--r-- | pygithub3/github.py | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/pygithub3/github.py b/pygithub3/github.py index 4941ffd..d05f069 100644 --- a/pygithub3/github.py +++ b/pygithub3/github.py @@ -6,7 +6,14 @@ from pygithub3.services.repos import Repo class Github(object): - """ Main entrance """ + """ + You can preconfigure all services globally with a ``config`` dict. See + :attr:`~pygithub3.services.base.Service` + + Example:: + + gh = Github(user='kennethreitz', token='ABC...', repo='requests') + """ def __init__(self, **config): self._users = User(**config) @@ -14,8 +21,14 @@ class Github(object): @property def users(self): + """ + :ref:`User service <User service>` + """ return self._users @property def repos(self): + """ + :ref:`Repos service <Repos service>` + """ return self._repos |