summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-01-16 18:31:48 +0100
committerNejc Habjan <nejc.habjan@siemens.com>2022-01-16 18:31:48 +0100
commit68716a13dc90ee06498f0f8620e12a07fe44d72f (patch)
tree13e0a7fea8a816df4be5e6b349a2155b5140431f /README.rst
parent8af403cb2b1c48acd6e9ebd392554926835c3893 (diff)
downloadgitlab-docs/lower-level-api.tar.gz
docs(api): describe use of lower-level methodsdocs/lower-level-api
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 838943c..52dbfc4 100644
--- a/README.rst
+++ b/README.rst
@@ -26,6 +26,14 @@ python-gitlab
It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``).
+The client aims to let you write clean Python code when managing GitLab resources.
+You can pass arbitrary parameters to the GitLab API - so you only need to
+follow GitLab's current documentation on what parameters are available.
+
+It also provides lower-level API methods giving you a degree of control and
+usability for any endpoint the moment it is available on GitLab.com or your
+GitLab instance.
+
Installation
------------