Init documentation

+core
+services.user
~services.repos

18 files changed, 959 insertions, 13 deletions

diff --git a/.gitignore b/.gitignore
index 0abbe71..228a223 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@
 *.DS_STORE
 *.rope*
 MANIFEST
+docs/_build
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..5e804dc
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pygithub3.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pygithub3.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/pygithub3"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pygithub3"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..d3d00a6
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,245 @@
+# -*- coding: utf-8 -*-
+#
+# pygithub3 documentation build configuration file, created by
+# sphinx-quickstart on Sun Feb 26 22:08:00 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.append(os.path.abspath('../'))
+#sys.path.append(os.path.abspath('_themes'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'pygithub3'
+copyright = u'2012, David Medina'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+highlight_language = 'python'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinxdoc'
+#html_theme = 'werkzeug'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_themes']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pygithub3doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'pygithub3.tex', u'pygithub3 Documentation',
+   u'David Medina', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'pygithub3', u'pygithub3 Documentation',
+     [u'David Medina'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'pygithub3', u'pygithub3 Documentation',
+   u'David Medina', 'pygithub3', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/docs/github.rst b/docs/github.rst
new file mode 100644
index 0000000..b54cef2
--- /dev/null
+++ b/docs/github.rst
@@ -0,0 +1,7 @@
+Github
+========
+
+This is the main entrance of **pygithub3**
+
+.. autoclass:: pygithub3.github.Github
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..24561ca
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,44 @@
+Documentation Overview
+=======================
+
+**pygithub3** is a Github APIv3 python wrapper.
+
+You can consume the API with several :doc:`services` (users, repos...) like
+you see in `Github API v3 documentation`_.
+
+When you do an API request, **pygithub3** map the result into :doc:`resources`
+which can do its own related requests in future releases.
+
+Fast sample
+-----------
+::
+
+    from pygithub3 import Github
+
+    gh = Github(login='octocat', password='password')
+
+    octocat = gh.users.get() # Auth required
+    copitux = gh.users.get('copitux')
+    # copitux = <User (copitux)>
+
+    octocat_followers = gh.users.followers.list().all()
+    copitux_followers = gh.users.followers.list('copitux').all()
+    # copitux_followers = [<User (ahmontero)>, <User (alazaro)>, ...]
+
+
+Others
+-------
+
+You must apologize my English level. I'm trying to do my best
+
+
+.. toctree::
+    :maxdepth: 3
+
+    installation
+    github
+    services
+    resources
+    result
+
+.. _Github API v3 documentation: http://developer.github.com
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000..8ed6c10
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,29 @@
+Installation
+=============
+::
+
+    pip install pygithub3
+
+    or
+
+    easy_install pygithub3
+
+
+Dependencies
+---------------
+
+Required
+.........
+
+This library only depends on `request library`_ module.
+
+If you install ``pygithub3`` with ``pip`` all is done. The best option
+
+Optional
+.........
+
+If you want to run the test suite, you must install `nose`_ and `mock`_
+
+.. _request library: http://docs.python-requests.org/en/v0.10.6/index.html
+.. _nose: http://readthedocs.org/docs/nose/en/latest
+.. _mock: http://pypi.python.org/pypi/mock
diff --git a/docs/repos.rst b/docs/repos.rst
new file mode 100644
index 0000000..73aadb2
--- /dev/null
+++ b/docs/repos.rst
@@ -0,0 +1,84 @@
+.. _Repos service:
+
+Repos's services
+===================
+
+**Fast sample**::
+
+    from pygithub3 import Github
+
+    auth = dict(login='octocat', password='pass')
+    gh = Github(**auth)
+
+    # Get copitux user
+    gh.users.get('copitux')
+
+    # Get copitux's followers
+    gh.users.followers.list('copitux')
+
+    # Get octocat's emails
+    gh.users.emails.list()
+
+Repo
+-------
+
+.. autoclass:: pygithub3.services.repos.Repo
+    :members:
+
+    .. attribute:: collaborators
+
+        :ref:`Collaborators service`
+
+    .. attribute:: commits
+
+        :ref:`Commits service`
+
+    .. attribute:: downloads
+
+        :ref:`Downloads service`
+
+    .. attribute:: forks
+
+        :ref:`Forks service`
+
+    .. attribute:: keys
+
+        :ref:`RepoKeys service`
+
+    .. attribute:: watchers
+
+        :ref:`Watchers service`
+
+.. _Collaborators service:
+
+Collaborators
+--------------
+
+
+.. _Commits service:
+
+Commits
+----------
+
+.. _Downloads service:
+
+Downloads
+------------
+
+
+.. _Forks service:
+
+Forks
+---------
+
+
+.. _RepoKeys service:
+
+Keys
+----------
+
+
+.. _Watchers service:
+
+Watchers
+---------
diff --git a/docs/resources.rst b/docs/resources.rst
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/resources.rst
diff --git a/docs/result.rst b/docs/result.rst
new file mode 100644
index 0000000..2162745
--- /dev/null
+++ b/docs/result.rst
@@ -0,0 +1,37 @@
+
+Result
+=======
+
+Some requests returns multiple :doc:`resources`, for that reason the
+``Github API`` paginate it and **pygithub3** too
+
+.. autoclass:: pygithub3.core.result.Result
+
+You have several ways to consume it
+
+1. Iterating over the result::
+
+    result = some_request()
+    for page in result:
+        for resource in page:
+            print resource
+
+2. With a generator::
+
+    result = some_request()
+    for resource in result.iterator():
+        print resource
+
+3. As a list::
+
+    result = some_request()
+    print result.all()
+
+4. Also you can request some page manually
+
+.. autoattribute:: pygithub3.core.result.Result.pages
+.. automethod:: pygithub3.core.result.Result.get_page
+
+Each ``Page`` is an iterator and contains resources
+
+
diff --git a/docs/services.rst b/docs/services.rst
new file mode 100644
index 0000000..ddd8c89
--- /dev/null
+++ b/docs/services.rst
@@ -0,0 +1,48 @@
+Services
+==========
+
+:doc:`github` class is a glue to all of them and the recommended option to
+start
+
+Overview
+..........
+
+You can access to the API requests through the different services.
+
+If you take a look at
+`github API v3 documentation <http://developer.github.com/>`_, you'll see a
+few sections in the sidebar.
+
+**pygithub3** has one service per each section of request-related
+
+For example: ::
+
+    repos => services.repos.repo
+        collaborators => services.repos.collaborators
+        commits => services.repos.commits
+        ....
+
+Each service has the functions to throw the API requests and is isolated
+from the rest.
+
+Config each service
+.....................................
+
+Each service can be configurated with some variables (behind the scenes, each
+service has her client which is configurated with this variables).
+
+.. note::
+
+    Also you can configure :doc:`github` as a service
+
+.. autoclass:: pygithub3.services.base.Service
+    :members:
+
+List of services
+..................
+
+.. toctree::
+    :maxdepth: 2
+
+    users
+    repos
diff --git a/docs/users.rst b/docs/users.rst
new file mode 100644
index 0000000..5bd2e97
--- /dev/null
+++ b/docs/users.rst
@@ -0,0 +1,60 @@
+.. _User service:
+
+User's services
+===============
+
+**Fast sample**::
+
+    from pygithub3 import Github
+
+    auth = dict(login='octocat', password='pass')
+    gh = Github(**auth)
+
+    # Get copitux user
+    gh.users.get('copitux')
+
+    # Get copitux's followers
+    gh.users.followers.list('copitux')
+
+    # Get octocat's emails
+    gh.users.emails.list()
+
+User
+--------
+
+.. autoclass:: pygithub3.services.users.User
+    :members:
+
+    .. attribute:: emails
+
+        :ref:`Emails service`
+    .. attribute:: keys
+
+        :ref:`Keys service`
+    .. attribute:: followers
+
+        :ref:`Followers service`
+
+.. _Emails service:
+
+Emails
+--------
+
+.. autoclass:: pygithub3.services.users.Emails
+    :members:
+
+.. _Keys service:
+
+Keys
+------
+
+.. autoclass:: pygithub3.services.users.Keys
+    :members:
+
+.. _Followers service:
+
+Followers
+-----------
+
+.. autoclass:: pygithub3.services.users.Followers
+    :members:
diff --git a/pygithub3/core/client.py b/pygithub3/core/client.py
index a9e9ad4..ce6cf7c 100644
--- a/pygithub3/core/client.py
+++ b/pygithub3/core/client.py
@@ -15,12 +15,6 @@ class Client(object):
     """ Client to send configurated requests"""
 
     def __init__(self, **kwargs):
-        """
-        It can be configurated
-
-        :login, :password, :user, :repo, :token, :per_page, :base_url, :verbose
-        """
-
         self.requester = requests.session()
         self.config = {
             'per_page': 100,
diff --git a/pygithub3/core/result.py b/pygithub3/core/result.py
index 226d6ab..9e69e7d 100644
--- a/pygithub3/core/result.py
+++ b/pygithub3/core/result.py
@@ -135,10 +135,11 @@ class Page(object):
 
 
 class Result(object):
-    """ """
+    """
+    Result is a very lazy paginator. It only do a real request when is needed
+    """
 
     def __init__(self, client, request, **kwargs):
-        """ """
         self.getter = Method(client.get, request, **kwargs)
         self.page = Page(self.getter)
 
@@ -158,9 +159,14 @@ class Result(object):
 
     @property
     def pages(self):
+        """ Total number of pages in request """
         return self.getter.last
 
     def get_page(self, page):
+        """ Get ``Page`` of resources
+
+        :param int page: Page number
+        """
         if page in xrange(1, self.pages + 1):
             return Page(self.getter, page)
         return None
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
diff --git a/pygithub3/services/base.py b/pygithub3/services/base.py
index 21b22eb..fced575 100644
--- a/pygithub3/services/base.py
+++ b/pygithub3/services/base.py
@@ -8,6 +8,34 @@ from pygithub3.core.errors import NotFound
 
 
 class Service(object):
+    """
+    You can configure each service with this keyword variables:
+
+    :param str login: Username to authenticate
+    :param str password: Username to authenticate
+    :param str user: Default username in requests
+    :param str repo: Default repository in requests
+    :param str token: Token to OAuth
+    :param int per_page: Items in each page of multiple returns
+    :param str base_url: To support another github-related API (untested)
+    :param stream verbose: Stream to write debug logs
+
+    You can configure the **authentication** with BasicAuthentication (login
+    and password) and with `OAuth <http://developer.github.com/v3/oauth/>`_ (
+    token).
+    If you include ``login``, ``password`` and ``token`` in config; Oauth has
+    precedence
+
+    Some API requests need ``user`` and/or ``repo`` arguments (e.g repos
+    service).
+    You can configure the default value here to avoid repeating
+
+    Some API requests return multiple resources with pagination. You can
+    configure how many items has each page.
+
+    You can configure ``verbose`` logging like `requests library <http://docs.
+    python-requests.org/en/v0.10.6/user/advanced/#verbose-logging>`_
+    """
 
     def __init__(self, **config):
         self._client = Client(**config)
@@ -17,18 +45,35 @@ class Service(object):
         return self._client.user
 
     def set_user(self, user):
+        """ Set user
+
+        :param str user: Default username in requests
+        """
         self._client.user = user
 
     def get_repo(self):
         return self._client.repo
 
     def set_repo(self, repo):
+        """ Set repository
+
+        :param str repo: Default repository in requests
+        """
         self._client.repo = repo
 
     def set_credentials(self, login, password):
+        """ Set Basic Authentication
+
+        :param str login: Username to authenticate
+        :param str password: Username to authenticate
+        """
         self._client.set_credentials(login, password)
 
     def set_token(self, token):
+        """ Set OAuth token
+
+        :param str token: Token to OAuth
+        """
         self._client.set_token(token)
 
     def make_request(self, request, **kwargs):
@@ -90,6 +135,16 @@ class Service(object):
 
 
 class MimeTypeMixin(object):
+    """
+    Mimetype support to Services that inherit this Mixin
+
+    Adds 4 public functions to service:
+
+        1. set_raw_mimetype
+        2. set_text_mimetype
+        3. set_html_mimetype
+        4. set_full_mimetype
+    """
 
     VERSION = 'beta'
 
diff --git a/pygithub3/services/repos.py b/pygithub3/services/repos.py
index b20d317..3643633 100644
--- a/pygithub3/services/repos.py
+++ b/pygithub3/services/repos.py
@@ -148,7 +148,7 @@ class Commits(Service, MimeTypeMixin):
         self._delete(request)
 
 
-class Collaborator(Service):
+class Collaborators(Service):
 
     def list(self, user=None, repo=None):
         request = self.make_request('repos.collaborators.list',
@@ -172,9 +172,10 @@ class Collaborator(Service):
 
 
 class Repo(Service):
+    """ Consume `Repos API <http://developer.github.com/v3/repos>`_ """
 
     def __init__(self, **config):
-        self.collaborators = Collaborator(**config)
+        self.collaborators = Collaborators(**config)
         self.commits = Commits(**config)
         self.downloads = Downloads(**config)
         self.forks = Forks(**config)
diff --git a/pygithub3/services/users.py b/pygithub3/services/users.py
index 2bf4302..8c436e6 100644
--- a/pygithub3/services/users.py
+++ b/pygithub3/services/users.py
@@ -5,71 +5,216 @@ from .base import Service
 
 
 class Keys(Service):
+    """ Consume `Keys API <http://developer.github.com/v3/users/keys/>`_
+
+    .. warning::
+
+        You must be authenticated for all requests
+    """
 
     def list(self):
+        """ Get public keys
+
+        It returns a :doc:`result`
+        """
         request = self.make_request('users.keys.list')
         return self._get_result(request)
 
     def get(self, key_id):
+        """ Get a public key
+
+        :param int key_id: Key id
+
+        ::
+
+            key_service.get(42)
+        """
         request = self.make_request('users.keys.get',
             key_id=key_id)
         return self._get(request)
 
     def add(self, data):
+        """ Add a public key
+
+        :param dict data: Key (title and key attributes required)
+
+        ::
+
+            key_service.add(dict(title='host', key='ssh-rsa AAA...'))
+        """
         request = self.make_request('users.keys.add',
             body=data)
         return self._post(request)
 
     def update(self, key_id, data):
+        """ Update a public key
+
+        :param int key_id: Key id
+        :param dict data: Key (title and key attributes required)
+
+        ::
+
+            key_service.update(42, dict(title='host', key='ssh-rsa AAA...'))
+        """
         request = self.make_request('users.keys.update',
             key_id=key_id, body=data)
         return self._patch(request)
 
     def delete(self, key_id):
+        """ Delete a public key
+
+        :param int key_id: Key id
+
+        ::
+
+            key_service.delete(42)
+        """
         request = self.make_request('users.keys.delete',
             key_id=key_id)
         self._delete(request)
 
 
 class Followers(Service):
+    """ Consume `Followers API
+    <http://developer.github.com/v3/users/followers/>`_
+    """
 
     def list(self, user=None):
+        """ Get user's followers
+
+        :param str user: Username
+
+        It returns a :doc:`result`
+
+        If you call it without user and you are authenticated, get the
+        authenticated user's followers
+
+        .. warning::
+
+            If you aren't authenticated and call without user, it returns 403
+
+        ::
+
+            followers_service.list()
+            followers_service.list('octocat')
+        """
         request = self.make_request('users.followers.list', user=user)
         return self._get_result(request)
 
     def list_following(self, user=None):
+        """ Get who a user is following
+
+        :param str user: Username
+
+        It returns a :doc:`result`
+
+        If you call it without user and you are authenticated, get the
+        authenticated user's followings
+
+        .. warning::
+
+            If you aren't authenticated and call without user, it returns 403
+
+        ::
+
+            followers_service.list_following()
+            followers_service.list_following('octocat')
+        """
         request = self.make_request('users.followers.listfollowing', user=user)
         return self._get_result(request)
 
     def is_following(self, user):
+        """ Check if you are following a user
+
+        :param str user: Username
+
+        ::
+
+            followers_service.is_following('octocat')
+        """
         request = self.make_request('users.followers.isfollowing', user=user)
         return self._bool(request)
 
     def follow(self, user):
+        """ Follow a user
+
+        :param str user: Username
+
+        .. warning::
+
+            You must be authenticated
+
+        ::
+
+            followers_service.follow('octocat')
+        """
         request = self.make_request('users.followers.follow', user=user)
         self._put(request)
 
     def unfollow(self, user):
+        """ Unfollow a user
+
+        :param str user: Username
+
+        .. warning::
+
+            You must be authenticated
+
+        ::
+
+            followers_service.unfollow('octocat')
+        """
         request = self.make_request('users.followers.unfollow', user=user)
         self._delete(request)
 
 
 class Emails(Service):
+    """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_
+
+    .. warning::
+
+        You must be authenticated for all requests
+    """
 
     def list(self):
+        """ Get user's emails
+
+        It returns a :doc:`result`
+        """
         request = self.make_request('users.emails.list')
         return self._get_result(request)
 
     def add(self, *emails):
+        """ Add emails
+
+        :param list emails: Emails to add
+
+        .. note::
+
+            It reject non-valid emails
+
+        ::
+
+            email_service.add('test1@xample.com', 'test2@xample.com')
+        """
         request = self.make_request('users.emails.add', body=emails)
         return self._post(request)
 
     def delete(self, *emails):
+        """ Delete emails
+
+        :param list emails: List of emails
+
+        ::
+
+            email_service.delete('test1@xample.com', 'test2@xample.com')
+        """
         request = self.make_request('users.emails.delete', body=emails)
         self._delete(request)
 
 
 class User(Service):
+    """ Consume `Users API <http://developer.github.com/v3/users>`_ """
 
     def __init__(self, **config):
         self.keys = Keys(**config)
@@ -78,9 +223,33 @@ class User(Service):
         super(User, self).__init__(**config)
 
     def get(self, user=None):
+        """ Get a single user
+
+        :param str user: Username
+
+        If you call it without user and you are authenticated, get the
+        authenticated user.
+
+        .. warning::
+
+            If you aren't authenticated and call without user, it returns 403
+
+        ::
+
+            user_service.get('copitux')
+            user_service.get()
+        """
         request = self.make_request('users.get', user=user)
         return self._get(request)
 
     def update(self, data):
+        """ Update the authenticated user
+
+        :param dict data: Input to update
+
+        ::
+
+            user_service.update(dict(name='new_name', bio='new_bio'))
+        """
         request = self.make_request('users.update', body=data)
         return self._patch(request)
diff --git a/pygithub3/tests/services/test_repos.py b/pygithub3/tests/services/test_repos.py
index 6f4ed71..e11bef7 100644
--- a/pygithub3/tests/services/test_repos.py
+++ b/pygithub3/tests/services/test_repos.py
@@ -6,7 +6,7 @@ from unittest import TestCase
 import requests
 from mock import patch, Mock
 
-from pygithub3.services.repos import (Repo, Collaborator, Commits, Downloads,
+from pygithub3.services.repos import (Repo, Collaborators, Commits, Downloads,
                                       Forks, Keys, Watchers)
 from pygithub3.resources.base import json
 from pygithub3.tests.utils.base import (mock_response, mock_response_result,
@@ -146,7 +146,7 @@ class TestRepoService(TestCase):
 class TestCollaboratorsService(TestCase):
 
     def setUp(self):
-        self.cs = Collaborator()
+        self.cs = Collaborators()
         self.cs.set_user('octocat')
         self.cs.set_repo('oc_repo')