gitlab的restFul Api

发表于 | 分类于 | 阅读次数: |
字数统计: 13k | 阅读时长 ≈ 13 mins.

gitlab官方文档

pip install python-gitlab

参考：
    https://docs.gitlab.com/ce/api/README.html

import

import gitlab

config param

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)

获取某个id的project下的某个文件的内容：

api:
    https://docs.gitlab.com/ce/api/repository_files.html#get-file-from-repository
    example:
        GET /projects/:id/repository/files/:file_path
        curl --request GET --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' 'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fmodels%2Fkey%2Erb?ref=master'

参考：
    https://blog.csdn.net/felix_yujing/article/details/52712925
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

>>> import gitlab
>>> private_token = 'xxx'
>>> host = 'https://git.xxx.yyy.com'
>>> port = '443'
>>> email = 'admin@example.com'
>>> branch = 'master'
>>> timeout = 60
>>> project_name = 'camera'
>>> file_path = '/execenv/execenv.yml'

>>> client = gitlab.Gitlab('{0}:{1}'.format(host, port), email, private_token, timeout)

>>> project_objects = client.projects.list(search = project_name)
>>> project_id = None
>>> for item in project_objects:
...     if item.name == project_name:
...         project_id = item.id
...     else:
...         continue
>>> project_id
64

>>> url = '{0}:{1}/api/v4/projects/{2}/repository/files?private_token={3}&file_path={4}&ref={5}'.format(host, port, project_id, private_token, file_path, branch)
>>> result = requests.get(url)
>>> data = result.json()
>>> content = base64.b64decode(data['content'])
>>> print content
---
os: linux
version: 1.0
appService: camera

exec:
  - type: java
    version: 1.8
    verify: java -version

更新某个id的project下的某个文件内容：

api:
    https://docs.gitlab.com/ce/api/repository_files.html#update-existing-file-in-repository

example:
    PUT /projects/:id/repository/files/:file_path
    curl --request PUT --header 'PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK' --header "Content-Type: application/json" \
         --data '{"branch": "master", "author_email": "author@example.com", "author_name": "Firstname Lastname", \
"content": "some content", "commit_message": "update file"}' \
         'https://gitlab.example.com/api/v4/projects/13083/repository/files/app%2Fproject%2Erb'
    response:
        {
            "file_path": "app/project.rb",
            "branch": "master"
        }

获取第一页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')

获取指定项目的所有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 in commits:
    print(c.author_name, c.message, c.title)

获取指定commit的info

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

创建一个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)

groups/project members’s api

参考：
    https://docs.gitlab.com/ce/api/members.html

待续