The full documentation for CLI and API is available on `readthedocs

Contributing

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 will run using the travis service and passing tests are

mandatory.

You need to install ``tox`` to run unit tests and documentation builds:

.. code-block:: bash

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:

.. code-block:: bash

You can also build a test environment using the following command:

.. code-block:: bash

A freshly configured gitlab container will be available at

http://localhost:8080 (login ``root`` / password ``5iveL!fe``). A configuration

for python-gitlab will be written in ``/tmp/python-gitlab.cfg``.

To cleanup the environement delete the container:

.. code-block:: bash