.. _githubex:

GitHub
======

.. module:: github3
.. module:: github3.github

This part of the documentation covers the :class:`GitHub <GitHub>` object. A
large portion of what you will likely want to do can be found in this class. If
you're looking for anonymous functions, you're most likely looking for the
:ref:`API <api>`.

Examples
--------

Examples utilizing this object can be found here_.

GitHub Object
-------------

.. autoclass:: GitHub
    :inherited-members:

.. links
.. _here: examples/githubex.html

GitHubEnterprise Object
-----------------------

This has all of the same attributes ass the :class:`GitHub <GitHub>` object so 
for brevity's sake, I'm not listing all of it's inherited members.

.. autoclass:: GitHubEnterprise
    :members:

GitHubStatus Object
-------------------

.. autoclass:: GitHubStatus
    :members: