python-gitlab-api 0.2.26

Programmatic REST Client for GitLab

python-gitlab-api

A simple python class based implementation of the GitLab v4 API.

See the ARCHITECTURE file

Starting using the module is pretty easy:

• specify the endpoint, which is URL + authorization token (or anon access)
• use a resouce among the ones provided in gitlab.resource
• use a CRUD operation, among the ones supported for the resource
• pass paramters to the operation to filter the results

In this case it is used a predefined GitLab.com endpoint, with no token paramter passed. The Projects resource used with a Read operation will list some/all projects.

from gitlab.utils import ppjson
from gitlab.resources import Projects
from gitlab.endpoints import GitLabDotCom 

ppjson(Projects(GitLabDotCom()).read())

In this case it is used a predefined GitLab.com endpoint, with a token. The Projects resource used with a Read operation will list some/all projects.

from gitlab.utils import ppjson
from gitlab.resources import Projects
from gitlab.endpoints import GitLabDotCom 

ppjson(Projects(GitLabDotCom(token='SOME TOKEN')).read({'owned':True}))

## Tokens

Currently only personal access tokens are supported.

Feel free to suggest ways to introduce the support for OAuth2 contacting the author and then proposing a change with a merge request.

Contributions

All contribution are welcome, in the best open source tradition.

Before adding missing features, please contact the author first to discuss best ways to do it.

New resources can be added via merge requests directly, as they are supposed to be really easy to add.