gitpythonapi_Python Gitlab Api 使用方法

#-*- coding: utf-8 -*-

__Author__ = "xiewm"

__Date__ = '2017/12/26 13:46'

"""gitlab 经常使用到的api

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

LOCAL_PATH: C:\Python36\Lib\site-packages\gitlab"""

importgitlab

url= 'http://xxxxxxx'token= 'xxxxxxxxxxxxxx'

#登录

gl =gitlab.Gitlab(url, token)#---------------------------------------------------------------- ##获取第一页project

projects =gl.projects.list()#获取所有的project

projects = gl.projects.list(all=True)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取所有project的name,id

for p in gl.projects.list(all=True, as_list=False):print(p.name, p.id)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取第一页project的name,id

for p in gl.projects.list(page=1):print(p.name, p.id)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##通过指定id 获取 project 对象

project = gl.projects.get(501)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##查找项目

projects = gl.projects.list(search='keyword')#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##创建一个项目

project = gl.projects.create({'name':'project1'})#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取公开的项目

projects = gl.projects.list(visibility='public') #public, internal or private#---------------------------------------------------------------- #

#获取 project 对象是以下操作的基础

#---------------------------------------------------------------- ##通过指定project对象获取该项目的所有分支

branches =project.branches.list()print(branches)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取指定分支的属性

branch = project.branches.get('master')print(branch)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##创建分支

branch = project.branches.create({'branch_name': 'feature1','ref': 'master'})#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##删除分支

project.branches.delete('feature1')#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##分支保护/取消保护

branch.protect()

branch.unprotect()#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取指定项目的所有tags

tags =project.tags.list()#获取某个指定tag 的信息

tags = project.tags.list('1.0')#创建一个tag

tag = project.tags.create({'tag_name':'1.0', 'ref':'master'})#设置tags 说明:

tag.set_release_description('awesome v1.0 release')#删除tags

project.tags.delete('1.0')#or

tag.delete()#---------------------------------------------------------------- ##获取所有commit info

commits =project.commits.list()for c incommits:print(c.author_name, c.message, c.title)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取指定commit的info

commit = project.commits.get('e3d5a71b')#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取指定项目的所有merge request

mrs =project.mergerequests.list()print(mrs)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##获取 指定mr info

mr =project.mergerequests.get(mr_id)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##创建一个merge request

mr = project.mergerequests.create({'source_branch':'cool_feature','target_branch':'master','title':'merge cool feature', })#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##更新一个merge request 的描述

mr.description = 'New description'mr.save()#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##开关一个merge request (close or reopen):

mr.state_event = 'close' #or 'reopen'

mr.save()#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##Delete a MR:

project.mergerequests.delete(mr_id)#or

mr.delete()#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##Accept a MR:

mr.merge()#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##指定条件过滤 所有的merge request#state: state of the MR. It can be one of all, merged, opened or closed#order_by: sort by created_at or updated_at#sort: sort order (asc or desc)

mrs = project.mergerequests.list(state='merged', sort='asc') #all, merged, opened or closed#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##创建一个commit

data ={'branch_name': 'master', #v3

'commit_message': 'blah blah blah','actions': [

{'action': 'create','file_path': 'blah','content': 'blah'}

]

}

commit=project.commits.create(data)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##Compare two branches, tags or commits:

result = project.repository_compare('develop', 'feature-20180104')print(result)#get the commits

for commit in result['commits']:print(commit)#

#get the diffs

for file_diff in result['diffs']:print(file_diff)#---------------------------------------------------------------- #

#---------------------------------------------------------------- ##get the commits

for commit in result['commits']:print(commit)#

#get the diffs

for file_diff in result['diffs']:print(file_diff)#---------------------------------------------------------------- #