.. _f-gitlabhelper:

module ``loghelper.repositories.gitlab_helper``
===============================================





.. inheritance-diagram:: pyquickhelper.loghelper.repositories.gitlab_helper


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

module ``pyquickhelper.loghelper.repositories.gitlab_helper``

Wrapper around GitLab API.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                         | truncated documentation                                                                                                                |
+===============================================================================================+========================================================================================================================================+
| :class:`GitLabAPI <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabAPI>`             | Wrapper around GitLab Server. The API is defined at `gitlabhq/doc/api <https://github.com/gitlabhq/gitlabhq/tree/master/doc/api>`_ ... |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :class:`GitLabException <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabException>` | specific exception, stores the request                                                                                                 |
+-----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+










Methods
+++++++

+---------------------------------------------------------------------------------------------------+--------------------------------+
| method                                                                                            | truncated documentation        |
+===================================================================================================+================================+
| :py:meth:`__init__ <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabAPI.__init__>`       | constructor                    |
+---------------------------------------------------------------------------------------------------+--------------------------------+
| :py:meth:`__init__ <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabException.__init__>` |                                |
+---------------------------------------------------------------------------------------------------+--------------------------------+
| :py:meth:`__str__ <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabException.__str__>`   | usual                          |
+---------------------------------------------------------------------------------------------------+--------------------------------+
| :meth:`get_projects <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabAPI.get_projects>`  | returns a list of dictionaries |
+---------------------------------------------------------------------------------------------------+--------------------------------+
| :meth:`login <pyquickhelper.loghelper.repositories.gitlab_helper.GitLabAPI.login>`                | login                          |
+---------------------------------------------------------------------------------------------------+--------------------------------+


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

.. automodule:: pyquickhelper.loghelper.repositories.gitlab_helper
    :members:
    :special-members: __init__
    :show-inheritance: