diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..2fe702e --- /dev/null +++ b/README.rst @@ -0,0 +1,37 @@ +Python GitLab +============= + +``python-gitlab`` is a Python package providing access to the GitLab server API. + +It supports the v3 api of GitLab, and provides a CLI tool (``gitlab``). + +Installation +============ + +Requirements +------------ + +python-gitlab depends on: + +* `python-requests <http://docs.python-requests.org/en/latest/>`_ +* `six <https://pythonhosted.org/six/>`_ + +Install with pip +---------------- + +.. code-block:: console + + pip install python-gitlab + +Bug reports +=========== + +Please report bugs and feature requests at +https://github.com/gpocentek/python-gitlab/issues. + + +Documentation +============= + +The documentation for CLI and API is available on `readthedocs +<http://python-gitlab.readthedocs.org/en/stable/>`_. |