python-gitlab is a Python package providing access to the GitLab server API.
It supports the v4 API of GitLab, and provides a CLI tool (
python-gitlab depends on:
Install with pip
pip install python-gitlab
Using the python-gitlab docker image
How to build
docker build -t python-gitlab:TAG .
How to use
docker run -it --rm -e GITLAB_PRIVATE_TOKEN=<your token> -v /path/to/python-gitlab.cfg:/python-gitlab.cfg python-gitlab <command> ...
To change the GitLab URL, use -e GITLAB_URL=<your url>
Bring your own config file:
docker run -it --rm -v /path/to/python-gitlab.cfg:/python-gitlab.cfg -e GITLAB_CFG=/python-gitlab.cfg python-gitlab <command> ...
Please report bugs and feature requests at https://github.com/python-gitlab/python-gitlab/issues.
The full documentation for CLI and API is available on readthedocs.
Build the docs
You can build the documentation using
pip install sphinx python setup.py build_sphinx
You can contribute to the project in multiple ways:
- Write documentation
- Implement features
- Fix bugs
- Add unit and functional tests
- Everything else you can think of
Provide your patches as github pull requests. Thanks!
Running unit tests
Before submitting a pull request make sure that the tests still succeed with your change. Unit tests and functional tests run using the travis service and passing tests are mandatory to get merge requests accepted.
You need to install
tox to run unit tests and documentation builds locally:
# run the unit tests for python 2/3, and the pep8 tests: tox # run tests in one environment only: tox -epy35 # build the documentation, the result will be generated in # build/sphinx/html/ tox -edocs
Running integration tests
Two scripts run tests against a running gitlab instance, using a docker container. You need to have docker installed on the test machine, and your user must have the correct permissions to talk to the docker daemon.
To run these tests:
# run the CLI tests: ./tools/functional_tests.sh # run the python API tests: ./tools/py_functional_tests.sh
You can also build a test environment using the following command:
A freshly configured gitlab container will be available at
root / password
5iveL!fe). A configuration
for python-gitlab will be written in
To cleanup the environment delete the container:
docker rm -f gitlab-test