aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/github.py
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-01 19:57:59 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-01 19:57:59 +0100
commitb891dfb211f9a58e5d834ccd148943286c45f61c (patch)
treec90ab9489c5217151c1f1c716aea8fa39b303393 /pygithub3/github.py
parentRepos.watchers service done (diff)
parentComplete services.repos doc (diff)
downloadpython-github3-b891dfb211f9a58e5d834ccd148943286c45f61c.tar.xz
python-github3-b891dfb211f9a58e5d834ccd148943286c45f61c.zip
Merge branch 'docs'
Diffstat (limited to 'pygithub3/github.py')
-rw-r--r--pygithub3/github.py19
1 files changed, 16 insertions, 3 deletions
diff --git a/pygithub3/github.py b/pygithub3/github.py
index 4941ffd..5b5353d 100644
--- a/pygithub3/github.py
+++ b/pygithub3/github.py
@@ -2,20 +2,33 @@
# -*- encoding: utf-8 -*-
from pygithub3.services.users import User
-from pygithub3.services.repos import Repo
+from pygithub3.services.repos import Repos
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)
- self._repos = Repo(**config)
+ self._repos = Repos(**config)
@property
def users(self):
+ """
+ :ref:`User service <User service>`
+ """
return self._users
@property
def repos(self):
+ """
+ :ref:`Repos service <Repos service>`
+ """
return self._repos