Release notes

This page describes important changes between python-gitlab releases.

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)
The 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
```
The GroupMemberManager, NamespaceManager and ProjectBoardManager managers now use the GET API from GitLab instead of the GetFromListMixin.get() method.

python-gitlab now respects the *_proxy, REQUESTS_CA_BUNDLE and CURL_CA_BUNDLE environment variables (#352)
The following deprecated methods and objects have been removed:
- gitlab.v3.object Key and KeyManager objects: use DeployKey and DeployKeyManager instead
- gitlab.v3.objects.Project archive_ and unarchive_ methods
- gitlab.Gitlab credentials_auth, token_auth, set_url, set_token and set_credentials methods. 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
The todo() method raises a GitlabTodoError exception on error

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.

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.Gitlab instances. The default will change from v3 to v4 soon.
Several methods have been deprecated in the gitlab.Gitlab class:
- credentials_auth() is deprecated and will be removed. Call auth().
- token_auth() is deprecated and will be removed. Call auth().
- set_url() is deprecated, create a new Gitlab instance if you need an updated URL.
- set_token() is deprecated, use the private_token argument of the Gitlab constructor.
- set_credentials() is deprecated, use the email and password arguments of the Gitlab constructor.
The service listing method (ProjectServiceManager.list()) now returns a python list instead of a JSON string.

The projects attribute of Group objects is not a list of Project objects anymore. It is a Manager object giving access to GroupProject objects. 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 Key objects are deprecated in favor of the new DeployKey objects. 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