@@ -29,13 +29,24 @@ python-gitlab |
29 | 29 |
|
30 | 30 | It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``). |
31 | 31 |
|
32 | | -The client aims to let you write clean Python code when managing GitLab resources. |
33 | | -You can pass arbitrary parameters to the GitLab API - so you only need to |
34 | | -follow GitLab's current documentation on what parameters are available. |
| 32 | +.. _features: |
35 | 33 |
|
36 | | -It also provides lower-level API methods giving you a degree of control and |
37 | | -usability for any endpoint the moment it is available on GitLab.com or your |
38 | | -GitLab instance. |
| 34 | +Features |
| 35 | +-------- |
| 36 | + |
| 37 | +``python-gitlab`` enables you to: |
| 38 | + |
| 39 | +* write Pythonic code to manage your GitLab resources. |
| 40 | +* pass arbitrary parameters to the GitLab API. Simply follow GitLab's docs |
| 41 | + on what parameters are available. |
| 42 | +* access arbitrary endpoints as soon as they are available on GitLab, by using |
| 43 | + lower-level API methods. |
| 44 | +* use persistent requests sessions for authentication, proxy and certificate handling. |
| 45 | +* handle smart retries on network and server errors, with rate-limit handling. |
| 46 | +* flexible handling of paginated responses, including lazy iterators. |
| 47 | +* automatically URL-encode paths and parameters where needed. |
| 48 | +* automatically convert some complex data structures to API attribute types |
| 49 | +* merge configuration from config files, environment variables and arguments. |
39 | 50 |
|
40 | 51 | Installation |
41 | 52 | ------------ |
@@ -63,7 +74,6 @@ From GitLab: |
63 | 74 |
|
64 | 75 | $ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git |
65 | 76 |
|
66 | | -
|
67 | 77 | Using the docker images |
68 | 78 | ----------------------- |
69 | 79 |
|
|