python-gitlab API reference

76 public APIs from python-gitlab (python-gitlab/python-gitlab) — 12 classes, 2 functions, 62 methods. Signatures extracted by static analysis of the actual source.

Repository: python-gitlab/python-gitlab

Kind	Count
Classes	12
Functions	2
Methods	62

API list

classgitlab.base.RESTManager

Base class for CRUD operations on objects.

classgitlab.base.RESTObject

Represents an object built from server data.

methodgitlab.base.RESTObject.get_id() -> int | str | None

Returns the id of the resource.

classgitlab.base.RESTObjectList

Generator object representing a list of RESTObject's.

methodgitlab.base.RESTObjectList.current_page() -> int

The current page number.

methodgitlab.base.RESTObjectList.next_page() -> int | None

The next page number.

methodgitlab.base.RESTObjectList.per_page() -> int | None

The number of items per page.

methodgitlab.base.RESTObjectList.prev_page() -> int | None

The previous page number.

methodgitlab.base.RESTObjectList.total() -> int | None

The total number of items.

methodgitlab.base.RESTObjectList.total_pages() -> int | None

The total number of pages.

classgitlab.client.Gitlab

Represents a GitLab server connection.

methodgitlab.client.Gitlab.api_url() -> str

The computed API base URL.

methodgitlab.client.Gitlab.api_version() -> str

The API version used (4 only).

methodgitlab.client.Gitlab.auth() -> None

Performs an authentication using private token.

methodgitlab.client.Gitlab.from_config(gitlab_id:str | None=None, config_files:list[str] | None=None, **kwargs:Any) -> Gitlab

Create a Gitlab connection from configuration files.

methodgitlab.client.Gitlab.get_license(**kwargs:Any) -> dict[str, str | dict[str, str]]

Retrieve information about the current license.

methodgitlab.client.Gitlab.http_delete(path:str, **kwargs:Any) -> requests.Response

Make a DELETE request to the Gitlab server.

method

gitlab.client.Gitlab.http_get(path:str, query_data:dict[str, Any] | None=None, streamed:bool=False, raw:bool=False, **kwargs:Any) -> dict[str, Any] | requests.Response

Make a GET request to the Gitlab server.

method

gitlab.client.Gitlab.http_head(path:str, query_data:dict[str, Any] | None=None, **kwargs:Any) -> requests.structures.CaseInsensitiveDict[Any]

Make a HEAD request to the Gitlab server.

method

gitlab.client.Gitlab.http_post(path:str, query_data:dict[str, Any] | None=None, post_data:dict[str, Any] | None=None, raw:bool=False, files:dict[str, Any] | None=None, **kwargs:Any) -> dict[str, Any] | requests.Response

Make a POST request to the Gitlab server.

methodgitlab.client.Gitlab.markdown(text:str, gfm:bool=False, project:str | None=None, **kwargs:Any) -> str

Render an arbitrary Markdown document.

methodgitlab.client.Gitlab.set_license(license:str, **kwargs:Any) -> dict[str, Any]

Add a new license.

methodgitlab.client.Gitlab.url() -> str

The user-provided server URL.

methodgitlab.client.Gitlab.version() -> tuple[str, str]

Returns the version and revision of the gitlab server.

classgitlab.client.GitlabList

Generator representing a list of remote objects.

methodgitlab.client.GitlabList.current_page() -> int

The current page number.

methodgitlab.client.GitlabList.next_page() -> int | None

The next page number.

methodgitlab.client.GitlabList.per_page() -> int | None

The number of items per page.

methodgitlab.client.GitlabList.prev_page() -> int | None

The previous page number.

methodgitlab.client.GitlabList.total() -> int | None

The total number of items.

methodgitlab.client.GitlabList.total_pages() -> int | None

The total number of pages.

classgitlab.const.GitlabEnum

An enum mixed in with str to make it JSON-serializable.

funcgitlab.exceptions.on_http_error(error:type[Exception]) -> Callable[[__F], __F]

Manage GitlabHttpError exceptions.

classgitlab.mixins.ObjectDeleteMixin

Mixin for RESTObject's that can be deleted.

methodgitlab.mixins.ObjectDeleteMixin.delete(**kwargs:Any) -> None

Delete the object from the server.

classgitlab.mixins.SaveMixin

Mixin for RESTObject's that can be updated.

methodgitlab.mixins.SaveMixin.save(**kwargs:Any) -> dict[str, Any] | None

Save the changes made to the object to the server.

methodgitlab.mixins.SetMixin.set(key:str, value:str, **kwargs:Any) -> base.TObjCls

Create or update the object.

classgitlab.utils.MaskingFormatter

A logging formatter that can mask credentials

funcgitlab.utils.get_base_url(url:str | None=None) -> str

Return the base URL with the trailing slash stripped.

classgitlab.v4.objects.artifacts.ProjectArtifact

Dummy object to manage custom actions on artifacts

methodgitlab.v4.objects.groups.Group.ldap_sync(**kwargs:Any) -> None

Sync LDAP groups.

methodgitlab.v4.objects.groups.Group.restore(**kwargs:Any) -> None

Restore a group marked for deletion..

methodgitlab.v4.objects.groups.Group.share(group_id:int, group_access:int, expires_at:str | None=None, **kwargs:Any) -> None

Share the group with a group.

methodgitlab.v4.objects.groups.Group.transfer_project(project_id:int, **kwargs:Any) -> None

Transfer a project to this group.

methodgitlab.v4.objects.groups.Group.unshare(group_id:int, **kwargs:Any) -> None

Delete a shared group link within a group.

method

gitlab.v4.objects.groups.GroupManager.import_group(file:BinaryIO, path:str, name:str, parent_id:int | str | None=None, **kwargs:Any) -> dict[str, Any] | requests.Response

Import a group from an archive file.

methodgitlab.v4.objects.projects.Project.archive(**kwargs:Any) -> None

Archive a project.

methodgitlab.v4.objects.projects.Project.delete_fork_relation(**kwargs:Any) -> None

Delete a forked relation between existing projects.

methodgitlab.v4.objects.projects.Project.housekeeping(**kwargs:Any) -> None

Start the housekeeping task.

methodgitlab.v4.objects.projects.Project.mirror_pull(**kwargs:Any) -> None

Start the pull mirroring process for the project.

methodgitlab.v4.objects.projects.Project.mirror_pull_details(**kwargs:Any) -> dict[str, Any]

Get a project's pull mirror details.

methodgitlab.v4.objects.projects.Project.restore(**kwargs:Any) -> None

Restore a project marked for deletion.

method

gitlab.v4.objects.projects.Project.share(group_id:int, group_access:int, expires_at:str | None=None, **kwargs:Any) -> None

Share the project with a group.

methodgitlab.v4.objects.projects.Project.star(**kwargs:Any) -> None

Star a project.

method

gitlab.v4.objects.projects.Project.trigger_pipeline(ref:str, token:str, variables:dict[str, Any] | None=None, inputs:dict[str, Any] | None=None, **kwargs:Any) -> ProjectPipeline

Trigger a CI build.

methodgitlab.v4.objects.projects.Project.unarchive(**kwargs:Any) -> None

Unarchive a project.

methodgitlab.v4.objects.projects.Project.unshare(group_id:int, **kwargs:Any) -> None

Delete a shared project link within a group.

methodgitlab.v4.objects.projects.Project.unstar(**kwargs:Any) -> None

Unstar a project.

classgitlab.v4.objects.sidekiq.SidekiqManager

Manager for the Sidekiq methods.

methodgitlab.v4.objects.sidekiq.SidekiqManager.compound_metrics(**kwargs:Any) -> dict[str, Any] | requests.Response

Return all available metrics and statistics.

methodgitlab.v4.objects.sidekiq.SidekiqManager.job_stats(**kwargs:Any) -> dict[str, Any] | requests.Response

Return statistics about the jobs performed.

methodgitlab.v4.objects.sidekiq.SidekiqManager.process_metrics(**kwargs:Any) -> dict[str, Any] | requests.Response

Return the registered sidekiq workers.

methodgitlab.v4.objects.sidekiq.SidekiqManager.queue_metrics(**kwargs:Any) -> dict[str, Any] | requests.Response

Return the registered queues information.

methodgitlab.v4.objects.todos.Todo.mark_as_done(**kwargs:Any) -> Dict[str, Any]

Mark the todo as done.

methodgitlab.v4.objects.users.User.activate(**kwargs:Any) -> dict[str, Any] | requests.Response

Activate the user.

methodgitlab.v4.objects.users.User.approve(**kwargs:Any) -> dict[str, Any] | requests.Response

Approve a user creation request.

methodgitlab.v4.objects.users.User.ban(**kwargs:Any) -> dict[str, Any] | requests.Response

Ban the user.

methodgitlab.v4.objects.users.User.block(**kwargs:Any) -> bool | None

Block the user.

methodgitlab.v4.objects.users.User.deactivate(**kwargs:Any) -> dict[str, Any] | requests.Response

Deactivate the user.

methodgitlab.v4.objects.users.User.follow(**kwargs:Any) -> dict[str, Any] | requests.Response

Follow the user.

methodgitlab.v4.objects.users.User.reject(**kwargs:Any) -> dict[str, Any] | requests.Response

Reject a user creation request.

methodgitlab.v4.objects.users.User.unban(**kwargs:Any) -> dict[str, Any] | requests.Response

Unban the user.

methodgitlab.v4.objects.users.User.unblock(**kwargs:Any) -> bool | None

Unblock the user.

methodgitlab.v4.objects.users.User.unfollow(**kwargs:Any) -> dict[str, Any] | requests.Response

Unfollow the user.

classgitlab.v4.objects.users.UserIdentityProviderManager

Manager for user identities.

About this data

These signatures were extracted from the public source of python-gitlab/python-gitlab using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries