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