[ Web Proxy ]
URL:
Viewing: https://pypi.python.org/project/python-gitlab/6.2.0/ [Back]  [Original]

python-gitlab PyPI Skip to main content Switch to mobile version
PyPI [PyPI]
Type '/' to search projects:

python-gitlab

https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg [https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg] https://badge.fury.io/py/python-gitlab.svg [https://badge.fury.io/py/python-gitlab.svg] https://readthedocs.org/projects/python-gitlab/badge/?version=latest [https://readthedocs.org/projects/python-gitlab/badge/?version=latest] https://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=main [https://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=main] https://img.shields.io/pypi/pyversions/python-gitlab.svg [https://img.shields.io/pypi/pyversions/python-gitlab.svg] https://img.shields.io/gitter/room/python-gitlab/Lobby.svg [https://img.shields.io/gitter/room/python-gitlab/Lobby.svg] https://img.shields.io/badge/code%20style-black-000000.svg [https://img.shields.io/badge/code%20style-black-000000.svg] https://img.shields.io/github/license/python-gitlab/python-gitlab [https://img.shields.io/github/license/python-gitlab/python-gitlab]

python-gitlab is a Python package providing access to the GitLab APIs.

It includes a client for GitLabs v4 REST API, synchronous and asynchronous GraphQL API clients, as well as a CLI tool (gitlab) wrapping REST API endpoints.

Features

python-gitlab enables you to:

  • write Pythonic code to manage your GitLab resources.

  • pass arbitrary parameters to the GitLab API. Simply follow GitLabs docs on what parameters are available.

  • use a synchronous or asynchronous client when using the GraphQL API.

  • access arbitrary endpoints as soon as they are available on GitLab, by using lower-level API methods.

  • use persistent requests sessions for authentication, proxy and certificate handling.

  • handle smart retries on network and server errors, with rate-limit handling.

  • flexible handling of paginated responses, including lazy iterators.

  • automatically URL-encode paths and parameters where needed.

  • automatically convert some complex data structures to API attribute types

  • merge configuration from config files, environment variables and arguments.

Installation

As of 5.0.0, python-gitlab is compatible with Python 3.9+.

Use pip to install the latest stable version of python-gitlab:

$ pip install --upgrade python-gitlab

The current development version is available on both GitHub.com and GitLab.com, and can be installed directly from the git repository:

$ pip install git+https://github.com/python-gitlab/python-gitlab.git

From GitLab:

$ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git

Using the docker images

python-gitlab provides Docker images in two flavors, based on the Alpine and Debian slim python base images. The default tag is alpine, but you can explicitly use the alias (see below).

The alpine image is smaller, but you may want to use the Debian-based slim tag (currently based on -slim-bullseye) if you are running into issues or need a more complete environment with a bash shell, such as in CI jobs.

The images are published on the GitLab registry, for example:

  • registry.gitlab.com/python-gitlab/python-gitlab:latest (latest, alpine alias)

  • registry.gitlab.com/python-gitlab/python-gitlab:alpine (latest alpine)

  • registry.gitlab.com/python-gitlab/python-gitlab:slim-bullseye (latest slim-bullseye)

  • registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0 (alpine alias)

  • registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-alpine

  • registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye

You can run the Docker image directly from the GitLab registry:

$ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest <command> ...

For example, to get a project on GitLab.com (without authentication):

$ docker run -it --rm registry.gitlab.com/python-gitlab/python-gitlab:latest project get --id gitlab-org/gitlab

You can also mount your own config file:

$ docker run -it --rm -v /path/to/python-gitlab.cfg:/etc/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest <command> ...

Usage inside GitLab CI

If you want to use the Docker image directly inside your GitLab CI as an image, you will need to override the entrypoint, as noted in the official GitLab documentation:

Job Name:
   image:
      name: registry.gitlab.com/python-gitlab/python-gitlab:latest
      entrypoint: [""]
   before_script:
      gitlab --version
   script:
      gitlab <command>

Building the image

To build your own image from this repository, run:

$ docker build -t python-gitlab:latest .

Run your own image:

$ docker run -it --rm python-gitlab:latest <command> ...

Build a Debian slim-based image:

$ docker build -t python-gitlab:latest --build-arg PYTHON_FLAVOR=slim-bullseye .

Bug reports

Please report bugs and feature requests at https://github.com/python-gitlab/python-gitlab/issues.

Gitter Community Chat

We have a gitter community chat available at https://gitter.im/python-gitlab/Lobby, which you can also directly access via the Open Chat button below.

If you have a simple question, the community might be able to help already, without you opening an issue. If you regularly use python-gitlab, we also encourage you to join and participate. You might discover new ideas and use cases yourself!

Documentation

The full documentation for CLI and API is available on readthedocs.

Build the docs

We use tox to manage our environment and build the documentation:

pip install tox
tox -e docs

Contributing

For guidelines for contributing to python-gitlab, refer to CONTRIBUTING.rst.

Metadata

Release files for python-gitlab 6.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-gitlab 6.2.0
File Size Uploaded Provenance
python_gitlab-6.2.0.tar.gz 397.6 kB Jul 28, 2025 With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for python-gitlab 6.2.0
File Interpreter ABI Platform Reset
python_gitlab-6.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 541.9 kB

Release files / python_gitlab-6.2.0.tar.gz

Download URL python_gitlab-6.2.0.tar.gz
Size 397.6 kB
Tags Source
SHA-256 checksum
How to use checksums
b88c79cea65dd2425922c829730ea95827ed7132d869b8532b90a8c7199cc1a6
BLAKE2b-256 checksum
How to use checksums
30328b1f293d106ec69033eb29dc998ff8a86fdbce5eebc1f6af8835b2faef61
Upload date Jul 28, 2025
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

[] []

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2025.

Transparency log

Release files / python_gitlab-6.2.0-py3-none-any.whl

Download URL python_gitlab-6.2.0-py3-none-any.whl
Size 144.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8adf2bbf1ac8a5224ee04a456d318da0d15128606711e8c8e1a2ff050968432b
BLAKE2b-256 checksum
How to use checksums
414baa99112a09c2898e17b88245a1d2e5bfcc71016f3cbdc24b6d870de38cf9
Upload date Jul 28, 2025
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

[] []

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2025.

Transparency log

Security for python-gitlab 6.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files
  • With provenance python_gitlab-6.2.0.tar.gz Jul 28, 2025
  • With provenance python_gitlab-6.2.0-py3-none-any.whl Jul 28, 2025

Attestation for python_gitlab-6.2.0.tar.gz

[] []

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 28, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release
[]

6.2.0 This release

Jul 28, 2025 2 release files Full provenance

[]
[]

0.12

Feb 3, 2016

[] Anthropic, PBC Visionary sponsor [] Bloomberg Visionary sponsor [] Hudson River Trading Visionary sponsor [] Meta Visionary sponsor [] NVIDIA Visionary sponsor [] Microsoft Sustainability sponsor [] Depot Continuous Integration [] AWS Cloud computing and Security Sponsor [] Datadog Monitoring [] Fastly CDN [] Google Download Analytics [] Sentry Error logging [] StatusPage Status page

Web Proxy Viewer  |  New URL  |  Original Page