Skip to main content

Interact with GitLab API

Project description

https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svg https://badge.fury.io/py/python-gitlab.svg https://readthedocs.org/projects/python-gitlab/badge/?version=latest 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/gitter/room/python-gitlab/Lobby.svg https://img.shields.io/badge/code%20style-black-000000.svg

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

It supports the v4 API of GitLab, and provides a CLI tool (gitlab).

Installation

As of 3.0.0, python-gitlab is compatible with Python 3.7+.

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 image

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> ...

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 -v python-gitlab:latest <command> ...

Bug reports

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

Gitter Community Chat

There is a gitter community chat available at https://gitter.im/python-gitlab/Lobby

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-gitlab-3.1.0.tar.gz (215.1 kB view hashes)

Uploaded Source

Built Distribution

python_gitlab-3.1.0-py3-none-any.whl (119.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page