Python调用GitLab API完整指南：配置与代码示例

小岛来信

发布时间：2026-10-13| 6人浏览过

原创

本文详解如何使用python-gitlab模块调用GitLab API进行项目管理。内容涵盖模块安装、配置文件（~/.python-gitlab.cfg）中private_token的安全设置、从配置加载连接的代码示例，以及获取项目列表和自定义脚本提取仓库地址的完整实现。

本文深入解析利用Python操作GitLab API的具体流程，通过详细的示例代码展示如何高效管理GitLab资源，为开发者的学习与工作提供具有实际价值的参考。

Python操作GitLab API概述

核心工具为python-gitlab模块，该模块封装了GitLab API接口，便于通过Python脚本直接管理GitLab平台。

模块安装与环境配置

安装步骤


pip install python-gitlab
# 如果是安装到Python3使用可以使用如下命令
pip3 install python-gitlab

环境配置

出于安全考虑，API所需的private_token不应硬编码在代码中，而应存储于系统配置文件中。

配置文件通常位于 /etc/python-gitlab.cfg 或用户目录下的 ~/.python-gitlab.cfg。

以下是配置文件的典型示例：


root@pts/1 $ cat ~/.python-gitlab.cfg
[global]
default = kaishugit
ssh_verify = False
timeout = 8

[kaishugit]
url = http://10.0.0.6
private_token = xxxxx-V4Yxxxxxxks7u
api_version = 3

程序调用与示例代码

在Python程序中调用API

编写程序时，可通过以下代码片段直接调用已配置的GitLab实例：


## login
gl = gitlab.Gitlab.from_config('kaishugit', ['~/.python-gitlab.cfg'])

更多示例


## 得到第一页project列表
projects = gl.projects.list()
## 得到所有project
projects = gl.projects.list(all=True)
projects = gl.projects.all()

自定义脚本获取仓库地址

补充说明

可通过自定义脚本获取指定用户、分组或全部代码仓库的地址列表。


#!/usr/bin/env python3
# encoding: utf-8
#

__Author__ = 'Colin'
__Date__ = '2018-06-20'

import gitlab

import os
import sys

class GitlabAPI(object):
  def __init__(self, *args, **kwargs):
    if os.path.exists('/etc/python-gitlab.cfg'):
      self.gl = gitlab.Gitlab.from_config('kaishugit', ['/etc/python-gitlab.cfg'])
    elif os.path.exists(os.getenv('HOME') + '/.python-gitlab.cfg'):
      self.gl = gitlab.Gitlab.from_config('kaishugit', [os.getenv('HOME') + '/.python-gitlab.cfg'])
    else:
      print('You need to make sure there is a file named "/etc/python-gitlab.cfg" or "~/.python-gitlab.cfg"')
      sys.exit(5)

  def get_user_id(self, username):
    user = self.gl.users.get_by_username(username)
    return user.id

  def get_group_id(self, groupname):
    group = self.gl.users.search(groupname)
    return group[0].id

  def get_all_projects(self):
    projects = self.gl.projects.list(all=True)
    result_list = []
    for project in projects:
      result_list.append(project.http_url_to_repo)
    return result_list

  def get_user_projects(self, userid):
    projects = self.gl.projects.owned(userid=userid, all=True)
    result_list = []
    for project in projects:
      result_list.append(project.http_url_to_repo)
    return result_list

  def get_group_projects(self, groupname):
    projects = self.gl.projects.owned(groupname=groupname, all=True)
    result_list = []
    for project in projects:
      result_list.append(project.http_url_to_repo)
    return result_list

if __name__ == '__main__':
  username='caichenyu'
  git = GitlabAPI()
  userid = git.get_user_id(username)
  print(username + '->' + str(userid))
  userprojects = git.get_user_projects(userid)
  print(userprojects)

以上内容为本文的全部分享，希望能为各位的学习带来帮助，同时也欢迎持续关注本站以获取更多技术资讯。