This page describes important changes between python-gitlab releases.
Changes from 1.4 to 1.5¶
- APIv3 support has been removed. Use the 1.4 release/branch if you need v3 support.
- GitLab EE features are now supported: Geo nodes, issue links, LDAP groups, project/group boards, project mirror pulling, project push rules, EE license configuration, epics.
GetFromListMixinclass has been removed. The
get()method is not available anymore for the following managers: - UserKeyManager - DeployKeyManager - GroupAccessRequestManager - GroupIssueManager - GroupProjectManager - GroupSubgroupManager - IssueManager - ProjectCommitStatusManager - ProjectEnvironmentManager - ProjectLabelManager - ProjectPipelineJobManager - ProjectAccessRequestManager - TodoManager
ProjectPipelineJobdo not heritate from
ProjectJobanymore and thus can only be listed.
Changes from 1.3 to 1.4¶
1.4 is the last release supporting the v3 API, and the related code will be removed in the 1.5 version.
If you are using a Gitlab server version that does not support the v4 API you can:
- upgrade the server (recommended)
- make sure to use version 1.4 of python-gitlab (
pip install python-gitlab==1.4)
See also the Switching to GitLab API v4 documentation.
python-gitlab now handles the server rate limiting feature. It will pause for the required time when reaching the limit (documentation)
GetFromListMixin.get()method is deprecated and will be removed in the next python-gitlab version. The goal of this mixin/method is to provide a way to get an object by looping through a list for GitLab objects that don’t support the GET method. The method is broken and conflicts with the GET method now supported by some GitLab objects.
You can implement your own method with something like:
def get_from_list(self, id): for obj in self.list(as_list=False): if obj.get_id() == id: return obj
ProjectBoardManagermanagers now use the GET API from GitLab instead of the
Changes from 1.2 to 1.3¶
gitlab.Gitlabobjects can be used as context managers in a
Changes from 1.1 to 1.2¶
- python-gitlab now respects the
CURL_CA_BUNDLEenvironment variables (#352)
- The following deprecated methods and objects have been removed:
set_credentialsmethods. Once a Gitlab object has been created its URL and authentication information cannot be updated: create a new Gitlab object if you need to use new information
todo()method raises a
GitlabTodoErrorexception on error
Changes from 1.0.2 to 1.1¶
ProjectUserclass doesn’t inherit from
Useranymore, and the
GroupProjectclass doesn’t inherit from
Projectanymore. The Gitlab API doesn’t provide the same set of features for these objects, so python-gitlab objects shouldn’t try to workaround that.
You can create
GroupProjectobjects using the
for gr_project in group.projects.list(): # lazy object creation avoids a Gitlab API request project = gl.projects.get(gr_project.id, lazy=True) project.default_branch = 'develop' project.save()
Changes from 0.21 to 1.0.0¶
1.0.0 brings a stable python-gitlab API for the v4 Gitlab API. v3 is still used by default.
v4 is mostly compatible with the v3, but some important changes have been introduced. Make sure to read Switching to GitLab API v4.
The development focus will be v4 from now on. v3 has been deprecated by GitLab and will disappear from python-gitlab at some point.
Changes from 0.20 to 0.21¶
Initial support for the v4 API (experimental)
The support for v4 is stable enough to be tested, but some features might be broken. Please report issues to https://github.com/python-gitlab/python-gitlab/issues/
Be aware that the python-gitlab API for v4 objects might change in the next releases.
Consider defining explicitly which API version you want to use in the configuration files or in your
gitlab.Gitlabinstances. The default will change from v3 to v4 soon.
Several methods have been deprecated in the
credentials_auth()is deprecated and will be removed. Call
token_auth()is deprecated and will be removed. Call
set_url()is deprecated, create a new
Gitlabinstance if you need an updated URL.
set_token()is deprecated, use the
private_tokenargument of the
set_credentials()is deprecated, use the
passwordarguments of the
The service listing method (
ProjectServiceManager.list()) now returns a python list instead of a JSON string.
Changes from 0.19 to 0.20¶
Groupobjects is not a list of
Projectobjects anymore. It is a Manager object giving access to
GroupProjectobjects. To get the list of projects use:
Related issue: https://github.com/python-gitlab/python-gitlab/issues/209
Keyobjects are deprecated in favor of the new
DeployKeyobjects. They are exactly the same but the name makes more sense.
Related issue: https://github.com/python-gitlab/python-gitlab/issues/212