Repository files navigation

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

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

Usepip to install the latest stable version ofpython-gitlab:

$pip install --upgrade python-gitlab

The current development version is available on bothGitHub.com andGitLab.com, and can beinstalled 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

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

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

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

There is agitter community chatavailable athttps://gitter.im/python-gitlab/Lobby

The full documentation for CLI and API is available onreadthedocs.

We usetox to manage our environment and build the documentation:

pip install toxtox -e docs

For guidelines for contributing topython-gitlab, refer toCONTRIBUTING.rst.