pyapi-gitlab is a python wrapper for the Gitlab API.
- requests
pyapi-gitlab has its own versioning in which the 2 first numbers indicates the Gitlab version that its supported for that library. a 7.5 version means that its compatible with the Gitlab 7.5 and lower API versions.
pyapi-gitlab is now on Pypi!
Depending on the gitlab version you are using (check it on your help section on gitlab) you will need a different version.
Latest version
Gitlab 7.5.2:
pip install pyapi-gitlab=="7.5.2"Old versions not maintained:
Gitlab 5.4:
pip install pyapi-gitlab=="5.4-0"Gitlab 6.0 or 6.1:
pip install pyapi-gitlab=="6.1.6"Gitlab 6.2:
pip install pyapi-gitlab=="6.2.3"pyapi-gitlab supports python version 2.6, 2.7, 3.3 and 3.4
-
Support for the full Gitlab 7.5 API
-
All methods have documentation (Inside the library only, the docs are lagging a bit behind).
-
New fork api that allows to actually fork a project instead of doing fork relations
-
New label methods (getlabel, createlabel, editlabel, deletelabel)
-
All get* methods that return more than one item support pagination. Check page and per_page args. Default to first page and 20 items per page.
-
BREAKING CHANGE: Old sudo arg in methods to execute as other user is gone. Now there is a method setsudo(user_id/user_username) which will setup the header, so all the subsequent API calls will be done as that user. To get back to your user just do a setsudo() and the sudo parameter will be cleared
-
BREAKING CHANGE: Some methods were returning True or False instead of the object created. Now all the methods in which there is something returning from the server is returned as a dictionary/list of dictionaries to the user
-
BREAKING CHANGE: Some methods now use kwargs for the optional parameters so the code is more easy and readable. Methods affected: createproject, createprojectuser, createmilestone, editmilestone, updatemergerequest
-
BREAKING CHANGE: Project wallnotes does not exist anymore, seems that they have been moved to project snippets (getsnippets, getsnippet, createsnippet, deletesnippet)
-
BREAKING CHANGE: Removed getreadme method as its not part of the gitlab api, nor was it ever.
-
BREAKING CHANGE: Old methods that started with list* are not get*. This is done in order to have a proper naming convention instead of having mixed listsomething and then getsomething. The actual
-
BREAKING CHANGE: Old methods with new names: getownprojects -> getprojectsowned, getallprojects -> getprojectsall
Check the docs at readthedocs.org
pyapi-gitlab is licensed under the GPL3. Check the LICENSE file.
Thanks to Jetbrains for giving me an Open Source license for PyCharm, it has helped making development much faster!
