Gitlab API 使用

python下操作gitlab的官方文件如下

http://python-gitlab.readthedocs.io/en/stable/

前期準備

建立Access Tokens

登陸公司Gitlab 平臺，以此選擇 “使用者”-->“settings”-->“Access Tokens” ，按照需求建立Access Tokens。

環境安裝

該文件使用python來執行相關操作，需要安裝python環境。

使用 python-gitlab模組來進行具體操作。

pip install python-gitlab
 

• 使用pip安裝最新的穩定版本

pip install --upgrade python-gitlab

• 開發版本可以在github上找到，使用git和pyhton setup.py來安裝

git clone https://github.com/python-gitlab/python-gitlab
cd python-gitlab
python setup.py install

gitlab CLI

python-gitlab提供了一個gitlab命令列工具來與GitLab伺服器進行互動，它使用配置檔案來定義如何連線到伺服器。

配置

gitlab預設情況下查詢2個配置檔案：

• /etc/python-gitlab.cfg : 系統範圍的配置檔案

• ~/.python-gitlab.cfg: 使用者配置檔案

可以使用--config-file選項的其他配置檔案

其他使用參考官網：http://python-gitlab.readthedocs.io/en/stable/cli.html

API 入門

python-gitlab支援GiaLab v3和v4 API。要使用v3，請確保安裝的為python-gitlab 1.4。

gitlab.Gitlab 類

要連線到Gitlab伺服器，需要建立一個gitlab.Gitlab物件。

import gitlab
# 私有令牌或個人令牌進行身份認證
gl = gitlab.Gitlab('http://10.9.151.194:9800/',private_token='U4oCoynMYPzDy_PUk-7W')
# oauth 令牌認證
gl = gitlab.Gitlab('http://10.0.0.1', oauth_token='my_long_token_here')
# 使用者名稱密碼認證 (for GitLab << 10.2)
gl = gitlab.Gitlab('http://10.0.0.1', email='jdoe', password='s3cr3t')
# 匿名認證，公共資源只讀
gl = gitlab.Gitlab('http://10.0.0.1')
# 建立一個API請求來建立gl.user物件，這是強制的
# 使用使用者名稱/密碼驗證
gl.auth()

還可以使用配置檔案來建立gitlab.Gitlab物件：

gl = gitlab.Gitlab.from_config('somewhere', ['/tmp/gl.cfg'])