Python中GitlabApi怎么用

这篇文章给大家分享的是有关Python中Gitlab Api怎么用的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。

安装

pip install python-gitlab

环境: py3

DEMO

# -*- coding: utf-8 -*-
__Author__ = "xiewm"
__Date__ = &＃39;2017/12/26 13:46&＃39;

"""
gitlab 经常使用到的api
DOC_URL: http://python-gitlab.readthedocs.io/en/stable/
LOCAL_PATH: C:\Python36\Lib\site-packages\gitlab
"""

import gitlab

url = &＃39;http://xxxxxxx&＃39;
token = &＃39;xxxxxxxxxxxxxx&＃39;

# 登录
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=&＃39;keyword&＃39;)
# ---------------------------------------------------------------- #

# ---------------------------------------------------------------- #
# 创建一个项目
project = gl.projects.create({&＃39;name&＃39;:&＃39;project1&＃39;})
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 获取公开的项目
projects = gl.projects.list(visibility=&＃39;public&＃39;) # public, internal or private
# ---------------------------------------------------------------- #


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


# ---------------------------------------------------------------- #
# 通过指定project对象获取该项目的所有分支
branches = project.branches.list()
print(branches)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 获取指定分支的属性
branch = project.branches.get(&＃39;master&＃39;)
print(branch)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 创建分支
branch = project.branches.create({&＃39;branch_name&＃39;: &＃39;feature1&＃39;,
                 &＃39;ref&＃39;: &＃39;master&＃39;})
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 删除分支
project.branches.delete(&＃39;feature1&＃39;)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 分支保护/取消保护
branch.protect()
branch.unprotect()
# ---------------------------------------------------------------- #





# ---------------------------------------------------------------- #
# 获取指定项目的所有tags
tags = project.tags.list()

# 获取某个指定tag 的信息
tags = project.tags.list(&＃39;1.0&＃39;)

# 创建一个tag
tag = project.tags.create({&＃39;tag_name&＃39;:&＃39;1.0&＃39;, &＃39;ref&＃39;:&＃39;master&＃39;})

# 设置tags 说明:
tag.set_release_description(&＃39;awesome v1.0 release&＃39;)

# 删除tags
project.tags.delete(&＃39;1.0&＃39;)
# or
tag.delete()

# ---------------------------------------------------------------- #
# 获取所有commit info
commits = project.commits.list()
for c in commits:
  print(c.author_name, c.message, c.title)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 获取指定commit的info
commit = project.commits.get(&＃39;e3d5a71b&＃39;)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 获取指定项目的所有merge request
mrs = project.mergerequests.list()
print(mrs)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 获取 指定mr info
mr = project.mergerequests.get(mr_id)
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 创建一个merge request
mr = project.mergerequests.create({&＃39;source_branch&＃39;:&＃39;cool_feature&＃39;,
                  &＃39;target_branch&＃39;:&＃39;master&＃39;,
                  &＃39;title&＃39;:&＃39;merge cool feature&＃39;, })
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 更新一个merge request 的描述
mr.description = &＃39;New description&＃39;
mr.save()
# ---------------------------------------------------------------- #


# ---------------------------------------------------------------- #
# 开关一个merge request (close or reopen):
mr.state_event = &＃39;close&＃39; # or &＃39;reopen&＃39;
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=&＃39;merged&＃39;, sort=&＃39;asc&＃39;) # all, merged, opened or closed
# ---------------------------------------------------------------- #



# ---------------------------------------------------------------- #
# 创建一个commit
data = {
  &＃39;branch_name&＃39;: &＃39;master&＃39;, # v3
  &＃39;commit_message&＃39;: &＃39;blah blah blah&＃39;,
  &＃39;actions&＃39;: [
    {
      &＃39;action&＃39;: &＃39;create&＃39;,
      &＃39;file_path&＃39;: &＃39;blah&＃39;,
      &＃39;content&＃39;: &＃39;blah&＃39;
    }
  ]
}
commit = project.commits.create(data)
# ---------------------------------------------------------------- #



# ---------------------------------------------------------------- #
# Compare two branches, tags or commits:
result = project.repository_compare(&＃39;develop&＃39;, &＃39;feature-20180104&＃39;)
print(result)
# get the commits

for commit in result[&＃39;commits&＃39;]:
  print(commit)
#
# get the diffs
for file_diff in result[&＃39;diffs&＃39;]:
  print(file_diff)
# ---------------------------------------------------------------- #





# ---------------------------------------------------------------- #
# get the commits
for commit in result[&＃39;commits&＃39;]:
  print(commit)
#
# get the diffs
for file_diff in result[&＃39;diffs&＃39;]:
  print(file_diff)
# ---------------------------------------------------------------- #

感谢各位的阅读！关于“Python中Gitlab Api怎么用”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！