python-gitlab is a Python module providing access to the GitLab server API.

It supports the v3 api of GitLab.

A CLI tool is also provided (called gitlab).

python-gitlab depends on:

• python-requests.

python-gitlab >= 0.3 is considered stable.

Please report bugs and feature requests at https://github.com/gpocentek/python-gitlab/issues

• Improve documentation
• Write unit tests

# See https://github.com/gitlabhq/gitlabhq/tree/master/doc/api for the source.# Register a connection to a gitlab instance, using its URL and a user private# tokengl=Gitlab('http://192.168.123.107', 'JVNSESs8EwWRx5yDxM5q') # Connect to get the current usergl.auth() # Print the user informationsprintgl.user# Get a list of projectsforpingl.Project(): print (p.name) # get associated issuesissues=p.Issue() forissueinissues: closed=0ifnotissue.closedelse1print (" %d => %s (closed: %d)"% (issue.id, issue.title, closed)) # and close them allissue.closed=1issue.save() # Get the first 10 groups (pagination)forgingl.Group(page=1, per_page=10): print (g) # Create a new projectp=gl.Project({'name': 'myCoolProject', 'wiki_enabled': False}) p.save() printp

To use the command line tool, you need to define which GitLab server(s) can be accessed. this can be done in 2 files:

• /etc/python-gitlab.cfg
• ~/.python-gitlab.cfg

Here's an example of the syntax:

[global] default = local ssl_verify = true [local] url = http://10.0.3.2:8080 private_token = vTbFeqJYCY3sibBP7BZM [distant] url = https://some.whe.re private_token = thisisaprivatetoken ssl_verify = false 

The [global] section define which server is accesed by default. Each other section defines how to access a server. Only private token authentication is supported (not user/password).

The ssl_verify option defines if the server SSL certificate should be validated (use false for self signed certificates, only useful with https).

Choosing a different server than the default one can be done at run time:

gitlab --gitlab=distant [command] 

gitlab always requires 2 mandatory arguments.

The first argument is the object type on which we will act, the second one is the action:

gitlab project list 

Get help with:

# global help gitlab --help # object help gitlab project help 

Some examples:

# list all the projects: gitlab project list # limit to 5 items per request, display the 1st page only gitlab project list --page=1 --per-page=5 # get a specific project (id 2): gitlab project get --id=2 # get a list of snippets for this project: gitlab project-issue list --project-id=2 # delete a Snippet (id 3): gitlab project-snippet delete --id=3 --project-id=2 # update a Snippet: gitlab project-snippet update --id=4 --project-id=2 --code="My New Code"# create a Snippet: gitlab project-snippet create --project-id=2 Impossible to create object (Missing attribute(s): title, file-name, code) # oops, let's add the attributes: gitlab project-snippet create --project-id=2 --title="the title" --file-name="the name" --code="the code"