Source code for pyquickhelper.loghelper.repositories.gitlab_helper

# -*- coding: utf-8 -*-
Wrapper around GitLab API.


import json

[docs]class GitLabException(Exception): """ specific exception, stores the request :githublink:`%|py|14` """
[docs] def __init__(self, mes, req=None): """ :param mes: message :param req: request which caused the failure :githublink:`%|py|20` """ Exception.__init__(self, mes) self.request = req
[docs] def __str__(self): """ usual :githublink:`%|py|27` """ if self.request is None: return Exception.__str__(self) else: return "{0}\nCODE: {1}\n[giterror]\n{2}".format( Exception.__str__(self), self.request.status_code, self.request.content)
[docs]class GitLabAPI: """ Wrapper around GitLab Server. The API is defined at `gitlabhq/doc/api <>`_ :githublink:`%|py|41` """
[docs] def __init__(self, host, verify_ssl=True): """ constructor :param host: git lab host :param verify_ssl: use_ssl (SSL connection) :githublink:`%|py|49` """ = host.rstrip("/") if not "https://") and not"http://"): raise GitLabException("host should start with https:// or http://") self.api_url = + "/api/v3" self.verify_ssl = verify_ssl
[docs] def login(self, user, password): """ login :param user: user :param password: password :githublink:`%|py|64` """ import requests data = {"login": user, "password": password} url = "{0}/Session".format(self.api_url) request =, data=data, verify=self.verify_ssl, headers={"connection": "close"}) if request.status_code == 201: self.token = json.loads( request.content.decode("utf-8"))['private_token'] self.headers = {"PRIVATE-TOKEN": self.token, "connection": "close"} elif request.status_code == 404: raise GitLabException("unable to login to " + url, request) else: msg = json.loads(request.content.decode("utf-8"))['message'] raise GitLabException( "unable to login to " + url + "\n" + msg, request)
[docs] def get_projects(self, page=1, per_page=100): """ returns a list of dictionaries :return: list of dictionaries :githublink:`%|py|86` """ import requests data = {'page': page, 'per_page': per_page} request = requests.get( self.api_url, params=data, headers=self.headers, verify=self.verify_ssl) if request.status_code == 200: return json.loads(request.content.decode("utf-8")) else: raise GitLabException( "unable to retreive the list of projects: {0}".format(request), request)