Interact with GitLab API
Project description
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
Built Distribution
Hashes for python_gitlab-3.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a7de39c8976db6d0db20031e71b3e43d262e99e64b471ef09bf00482cd3d9fa |
|
MD5 | 53d5ebfcd1bc078e4de9c0881ed74956 |
|
BLAKE2b-256 | 0173fbce17f1358e218192626e88dd58ee61bb8a8116b0418d665b59419a9e6f |