.. _f-githubapi:

module ``loghelper.github_api``
===============================





.. inheritance-diagram:: pyquickhelper.loghelper.github_api


Short summary
+++++++++++++

module ``pyquickhelper.loghelper.github_api``

Calls :epkg:`github` API.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------------+---------------------------------------------------------+
| class                                                                               | truncated documentation                                 |
+=====================================================================================+=========================================================+
| :class:`GitHubApiException <pyquickhelper.loghelper.github_api.GitHubApiException>` | Exception raised when a call to github rest api failed. |
+-------------------------------------------------------------------------------------+---------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------+--------------------------------------------------------------+
| function                                                                     | truncated documentation                                      |
+==============================================================================+==============================================================+
| :func:`call_github_api <pyquickhelper.loghelper.github_api.call_github_api>` | Calls `GitHub REST API <https://developer.github.com/v3/>`_. |
+------------------------------------------------------------------------------+--------------------------------------------------------------+








Methods
+++++++

+--------------------------------------------------------------------------------------+----------------------------------+
| method                                                                               | truncated documentation          |
+======================================================================================+==================================+
| :py:meth:`__init__ <pyquickhelper.loghelper.github_api.GitHubApiException.__init__>` | Merges everything into a string. |
+--------------------------------------------------------------------------------------+----------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.loghelper.github_api
    :members:
    :special-members: __init__
    :show-inheritance: