Movatterモバイル変換

[0]ホーム
URL:

Skip to main content
PyPI

python-gitlab 6.1.0

pip install python-gitlab

Latest version

Released:

The python wrapper for the GitLab REST and GraphQL APIs.

Verified details

These details have beenverified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for bufferoverflow from gravatar.combufferoverflowAvatar for max-wittig from gravatar.commax-wittigAvatar for nejch from gravatar.comnejch

Unverified details

These details havenot been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (LGPL-3.0-or-later)
  • Author:Gauvain Pocentek
  • Maintainer:John Villalovos
  • Tags api, client, gitlab, python, python-gitlab, wrapper
  • Requires: Python >=3.9.0
  • Provides-Extra:autocompletion,yaml,graphql

Project description

https://github.com/python-gitlab/python-gitlab/workflows/Test/badge.svghttps://badge.fury.io/py/python-gitlab.svghttps://readthedocs.org/projects/python-gitlab/badge/?version=latesthttps://codecov.io/github/python-gitlab/python-gitlab/coverage.svg?branch=mainhttps://img.shields.io/pypi/pyversions/python-gitlab.svghttps://img.shields.io/gitter/room/python-gitlab/Lobby.svghttps://img.shields.io/badge/code%20style-black-000000.svghttps://img.shields.io/github/license/python-gitlab/python-gitlab

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

It includes a client for GitLab’s v4 REST API, synchronous and asynchronous GraphQL APIclients, as well as a CLI tool (gitlab) wrapping REST API endpoints.

Features

python-gitlab enables you to:

  • write Pythonic code to manage your GitLab resources.

  • pass arbitrary parameters to the GitLab API. Simply follow GitLab’s docson what parameters are available.

  • use a synchronous or asynchronous client when using the GraphQL API.

  • access arbitrary endpoints as soon as they are available on GitLab, by usinglower-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 types

  • merge configuration from config files, environment variables and arguments.

Installation

As of 5.0.0,python-gitlab is compatible with Python 3.9+.

Usepip to install the latest stable version ofpython-gitlab:

$pipinstall--upgradepython-gitlab

The current development version is available on bothGitHub.com andGitLab.com, and can beinstalled directly from the git repository:

$pipinstallgit+https://github.com/python-gitlab/python-gitlab.git

From GitLab:

$pipinstallgit+https://gitlab.com/python-gitlab/python-gitlab.git

Using the docker images

python-gitlab provides Docker images in two flavors, based on the Alpine and Debian slimpythonbase 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 (currentlybased on-slim-bullseye) if you are running into issues or need a more complete environmentwith 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-alpine

  • registry.gitlab.com/python-gitlab/python-gitlab:v3.2.0-slim-bullseye

You 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/gitlab

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

Usage inside GitLab CI

If you want to use the Docker image directly inside your GitLab CI as animage, you will need to overridetheentrypoint,as noted in the official GitLab documentation:

Job Name:image:name:registry.gitlab.com/python-gitlab/python-gitlab:latestentrypoint:[""]before_script:gitlab --versionscript:gitlab <command>

Building the image

To 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 reports

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

Gitter Community Chat

We have agitter community chatavailable athttps://gitter.im/python-gitlab/Lobby, which you can alsodirectly 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 alsoencourage you to join and participate. You might discover new ideas anduse cases yourself!

Documentation

The full documentation for CLI and API is available onreadthedocs.

Build the docs

We usetox to manage our environment and build the documentation:

pip install toxtox -e docs

Contributing

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

Project details

Verified details

These details have beenverified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for bufferoverflow from gravatar.combufferoverflowAvatar for max-wittig from gravatar.commax-wittigAvatar for nejch from gravatar.comnejch

Unverified details

These details havenot been verified by PyPI
Project links
Meta
  • License: GNU Lesser General Public License v3 (LGPLv3) (LGPL-3.0-or-later)
  • Author:Gauvain Pocentek
  • Maintainer:John Villalovos
  • Tags api, client, gitlab, python, python-gitlab, wrapper
  • Requires: Python >=3.9.0
  • Provides-Extra:autocompletion,yaml,graphql

Release historyRelease notifications |RSS feed

Download files

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

Source Distribution

python_gitlab-6.1.0.tar.gz (397.7 kBview details)

UploadedSource

Built Distribution

python_gitlab-6.1.0-py3-none-any.whl (144.3 kBview details)

UploadedPython 3

File details

Details for the filepython_gitlab-6.1.0.tar.gz.

File metadata

  • Download URL:python_gitlab-6.1.0.tar.gz
  • Upload date:
  • Size: 397.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for python_gitlab-6.1.0.tar.gz
AlgorithmHash digest
SHA256062d6943699b09bce40f727f0d0906a0b254ca455593f81745bb1a352535ee77
MD59d47b4f25c2a50fe88a23d666500cf6c
BLAKE2b-256f98adf64bed28a9351ab76237d1566b5effb1faa8b60a399275e5ddf980a904e

See more details on using hashes here.

Provenance

The following attestation bundles were made forpython_gitlab-6.1.0.tar.gz:

Publisher:release.yml on python-gitlab/python-gitlab

Attestations:Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the filepython_gitlab-6.1.0-py3-none-any.whl.

File metadata

  • Download URL:python_gitlab-6.1.0-py3-none-any.whl
  • Upload date:
  • Size: 144.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for python_gitlab-6.1.0-py3-none-any.whl
AlgorithmHash digest
SHA256d36fb714cfde7773dcd6c19dd714bdb6e4dfb00a7ef694c8da176335da171b23
MD5d76526e0ae9620029ae57ee272c9d5d5
BLAKE2b-256273d258d0e8a116beac841e612d17b0ef4fc56c1d3b02c1791121f471c289b3d

See more details on using hashes here.

Provenance

The following attestation bundles were made forpython_gitlab-6.1.0-py3-none-any.whl:

Publisher:release.yml on python-gitlab/python-gitlab

Attestations:Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security SponsorDatadog MonitoringFastly CDNGoogle Download AnalyticsPingdom MonitoringSentry Error loggingStatusPage Status page
[8]ページ先頭
©2009-2025 Movatter.jp