This page describes important changes between python-gitlab releases.
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.
Warning
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
gitlab.Gitlabclass:credentials_auth()is deprecated and will be removed. Callauth().token_auth()is deprecated and will be removed. Callauth().set_url()is deprecated, create a newGitlabinstance if you need an updated URL.set_token()is deprecated, use theprivate_tokenargument of theGitlabconstructor.set_credentials()is deprecated, use theemailandpasswordarguments of theGitlabconstructor.
The service listing method (
ProjectServiceManager.list()) now returns a python list instead of a JSON string.
The
projectsattribute ofGroupobjects is not a list ofProjectobjects anymore. It is a Manager object giving access toGroupProjectobjects. To get the list of projects use:group.projects.list()
Documentation: http://python-gitlab.readthedocs.io/en/stable/gl_objects/groups.html#examples
Related issue: python-gitlab#209
The
Keyobjects are deprecated in favor of the newDeployKeyobjects. They are exactly the same but the name makes more sense.Documentation: http://python-gitlab.readthedocs.io/en/stable/gl_objects/deploy_keys.html
Related issue: python-gitlab#212