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

python-gitlab depends on:

• python-requests

pip install python-gitlab

docker build -t python-gitlab:TAG .

docker run -it --rm -e GITLAB_PRIVATE_TOKEN=<your token> -v /path/to/python-gitlab.cfg:/python-gitlab.cfg python-gitlab <command> ...

or run it directly from the upstream image:

docker run -it --rm -e GITLAB_PRIVATE_TOKEN=<your token> -v /path/to/python-gitlab.cfg:/python-gitlab.cfg registry.gitlab.com/python-gitlab/python-gitlab:latest <command> ...

To change the GitLab URL, use -e GITLAB_URL=<your url>

Bring your own config file:docker run -it --rm -v /path/to/python-gitlab.cfg:/python-gitlab.cfg -e GITLAB_CFG=/python-gitlab.cfg python-gitlab <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.

You can build the documentation usingsphinx:

pip install sphinxpython setup.py build_sphinx

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