Merge branch 'docs'

10 files changed, 756 insertions, 0 deletions

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..7b87720
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,244 @@
+# -*- 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 = '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..ae4941b
--- /dev/null
+++ b/docs/github.rst
@@ -0,0 +1,7 @@
+Github
+========
+
+This is the main entrance of **pygithub3**
+
+.. autoclass:: pygithub3.Github
+    :members:
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..71f377c
--- /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
+    result
+    resources
+
+.. _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..2b58f32
--- /dev/null
+++ b/docs/repos.rst
@@ -0,0 +1,143 @@
+.. _Repos service:
+
+Repos's services
+===================
+
+**Fast sample**::
+
+    from pygithub3 import Github
+
+    gh = Github()
+
+    django_compressor = gh.repos.get(user='jezdez', repo='django_compressor')
+    requests_collaborators = gh.repos.collaborators(user='kennethreitz',
+        repo='requests')
+
+.. _config precedence:
+
+Config precedence
+------------------
+
+Some request always need ``user`` and ``repo`` parameters, both, to identify
+a `repository`. Because there are a lot of requests which need that parameters,
+you can :ref:`config each service` with ``user`` and ``repo`` globally.
+
+So several requests follow a simple precedence
+``user_in_arg > user_in_config | repo_in_arg > repo_in_config``
+
+You can see it better with an example: ::
+
+    from pygithub3 import Github
+
+    gh = Github(user='octocat', repo='oct_repo')
+    oct_repo = gh.repos.get()
+    another_repo_from_octocat = gh.repos.get(repo='another_repo')
+
+    django_compressor = gh.repos.get(user='jezdez', repo='django_compressor')
+
+.. note::
+
+    Remember that each service is isolated from the rest ::
+
+        # continue example...
+        gh.repos.commits.set_user('copitux')
+        oct_repo = gh.repos.get()
+        oct_repo_collaborators = gh.repos.collaborators.list().all()
+
+        # Fail because copitux/oct_repo doesn't exist
+        gh.repos.commits.list_comments()
+
+Repo
+-------
+
+.. autoclass:: pygithub3.services.repos.Repos
+    :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
+--------------
+
+.. autoclass:: pygithub3.services.repos.Collaborators
+    :members:
+
+.. _Commits service:
+
+Commits
+----------
+
+.. autoclass:: pygithub3.services.repos.Commits
+    :members:
+
+.. _Downloads service:
+
+Downloads
+------------
+
+.. autoclass:: pygithub3.services.repos.Downloads
+    :members:
+
+
+.. _Forks service:
+
+Forks
+---------
+
+.. autoclass:: pygithub3.services.repos.Forks
+    :members:
+
+
+.. _RepoKeys service:
+
+Keys
+----------
+
+.. autoclass:: pygithub3.services.repos.Keys
+    :members:
+
+
+.. _Watchers service:
+
+Watchers
+---------
+
+.. autoclass:: pygithub3.services.repos.Watchers
+    :members:
+
+.. _Hooks service:
+
+Hooks
+---------
+
+.. _github repos doc: http://developer.github.com/v3/repos
+.. _github collaborators doc: http://developer.github.com/v3/repos/collaborators
+.. _github commits doc: http://developer.github.com/v3/repos/commits
+.. _github downloads doc: http://developer.github.com/v3/repos/downloads
+.. _github forks doc: http://developer.github.com/v3/repos/forks
+.. _github keys doc: http://developer.github.com/v3/repos/keys
+.. _github watching doc: http://developer.github.com/v3/repos/watching
+.. _github hooks doc: http://developer.github.com/v3/repos/hooks
diff --git a/docs/resources.rst b/docs/resources.rst
new file mode 100644
index 0000000..24189e2
--- /dev/null
+++ b/docs/resources.rst
@@ -0,0 +1,2 @@
+Resources
+==========
diff --git a/docs/result.rst b/docs/result.rst
new file mode 100644
index 0000000..f084807
--- /dev/null
+++ b/docs/result.rst
@@ -0,0 +1,9 @@
+
+Result
+=======
+
+Some requests returns multiple :doc:`resources`, for that reason the
+``Github API`` paginate it and **pygithub3** too
+
+.. autoclass:: pygithub3.core.result.Result
+
diff --git a/docs/services.rst b/docs/services.rst
new file mode 100644
index 0000000..a0fd894
--- /dev/null
+++ b/docs/services.rst
@@ -0,0 +1,65 @@
+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:
+
+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:
+
+.. _mimetypes-section:
+
+MimeTypes
+----------
+
+Some services supports `mimetypes`_
+
+With them the :doc:`resources` will have ``body``, ``body_text``, ``body_html``
+attributes or all of them.
+
+.. autoclass:: pygithub3.services.base.MimeTypeMixin
+    :members:
+
+List of services
+-------------------
+
+.. toctree::
+    :maxdepth: 2
+
+    users
+    repos
+
+.. _mimetypes: http://developer.github.com/v3/mime
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: