Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitb4d53f1

Browse files
nejchJohnVillalovos
authored andcommitted
docs(readme): add a basic feature list
1 parentb7a6874 commitb4d53f1

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

‎README.rst‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,24 @@ python-gitlab
2929

3030
It supports the v4 API of GitLab, and provides a CLI tool (``gitlab``).
3131

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:
3533

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.
3950

4051
Installation
4152
------------
@@ -63,7 +74,6 @@ From GitLab:
6374
6475
$ pip install git+https://gitlab.com/python-gitlab/python-gitlab.git
6576
66-
6777
Using the docker images
6878
-----------------------
6979

‎docs/api-levels.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Lower-level API - HTTP methods
2222
At this point, python-gitlab will no longer take care of URL-encoding and other transformations
2323
needed to correctly pass API parameter types. You have to construct these correctly yourself.
2424

25+
However, you still benefit from many of the client's:ref:`features` such as authentication,
26+
requests and retry handling.
27+
2528
..important::
2629

2730
If you've found yourself at this section because of an endpoint not yet implemented in

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp