python gitlab api

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'])