Package: python-gitlab
python-gitlabis a Python package providing access to the GitLab server API.It supports the v4 API of GitLab, and provides a CLI tool (gitlab).Featurespython-gitlabenables you to:write Pythonic code to manage your GitLab resources.pass arbitrary parameters to the GitLab API. Simply follow GitLab’s docs
on what parameters are available.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 typesmerge configuration from config files, environment variables and arguments.InstallationAs of 4.0.0,python-gitlabis compatible with Python 3.8+.Usepipto install the latest stable version ofpython-gitlab:$pipinstall--upgradepython-gitlabThe current development version is available on bothGitHub.comandGitLab.com, and can be
installed directly from the git repository:$pipinstallgit+https://github.com/python-gitlab/python-gitlab.gitFrom GitLab:$pipinstallgit+https://gitlab.com/python-gitlab/python-gitlab.gitUsing the docker imagespython-gitlabprovides Docker images in two flavors, based on the Alpine and Debian slim
pythonbase images. The default tag isalpine,
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-alpineregistry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseyeYou can run the Docker image directly from the GitLab registry:$dockerrun-it--rmregistry.gitlab.com/python-gitlab/python-gitlab:latest<command>...For example, to get a project on GitLab.com (without authentication):$dockerrun-it--rmregistry.gitlab.com/python-gitlab/python-gitlab:latestprojectget--idgitlab-org/gitlabYou can also mount your own config file:$dockerrun-it--rm-v/path/to/python-gitlab.cfg:/etc/python-gitlab.cfgregistry.gitlab.com/python-gitlab/python-gitlab:latest<command>...Building the imageTo build your own image from this repository, run:$dockerbuild-tpython-gitlab:latest.Run your own image:$dockerrun-it--rmpython-gitlab:latest<command>...Build a Debian slim-based image:$dockerbuild-tpython-gitlab:latest--build-argPYTHON_FLAVOR=slim-bullseye.Bug reportsPlease report bugs and feature requests athttps://github.com/python-gitlab/python-gitlab/issues.Gitter Community ChatWe have agittercommunity chat
available athttps://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!DocumentationThe full documentation for CLI and API is available onreadthedocs.Build the docsWe usetoxto manage our environment and build the documentation:pip install tox
tox -e docsContributingFor guidelines for contributing topython-gitlab, refer toCONTRIBUTING.rst.