@@ -25,23 +25,17 @@ Reference
25
25
Examples
26
26
--------
27
27
28
- List the groups:
28
+ List the groups::
29
29
30
- .. literalinclude :: groups.py
31
- :start-after: # list
32
- :end-before: # end list
30
+ groups = gl.groups.list()
33
31
34
- Get a group's detail:
32
+ Get a group's detail::
35
33
36
- .. literalinclude :: groups.py
37
- :start-after: # get
38
- :end-before: # end get
34
+ group = gl.groups.get(group_id)
39
35
40
- List a group's projects:
36
+ List a group's projects::
41
37
42
- .. literalinclude :: groups.py
43
- :start-after: # projects list
44
- :end-before: # end projects list
38
+ projects = group.projects.list()
45
39
46
40
You can filter and sort the result using the following parameters:
47
41
@@ -54,23 +48,20 @@ You can filter and sort the result using the following parameters:
54
48
* ``sort ``: sort order: ``asc `` or ``desc ``
55
49
* ``ci_enabled_first ``: return CI enabled groups first
56
50
57
- Create a group:
51
+ Create a group::
58
52
59
- .. literalinclude :: groups.py
60
- :start-after: # create
61
- :end-before: # end create
53
+ group = gl.groups.create({'name': 'group1', 'path': 'group1'})
62
54
63
- Update a group:
55
+ Update a group::
64
56
65
- .. literalinclude :: groups.py
66
- :start-after: # update
67
- :end-before: # end update
57
+ group.description = 'My awesome group'
58
+ group.save()
68
59
69
- Remove a group:
60
+ Remove a group::
70
61
71
- .. literalinclude :: groups.py
72
- :start-after: # delete
73
- :end-before: # end delete
62
+ gl.group.delete(group_id)
63
+ # or
64
+ group. delete()
74
65
75
66
Subgroups
76
67
=========
@@ -91,6 +82,12 @@ List the subgroups for a group::
91
82
92
83
subgroups = group.subgroups.list()
93
84
85
+ # The GroupSubgroup objects don't expose the same API as the Group
86
+ # objects. If you need to manipulate a subgroup as a group, create a new
87
+ # Group object:
88
+ real_group = gl.groups.get(subgroup_id, lazy=True)
89
+ real_group.issues.list()
90
+
94
91
Group custom attributes
95
92
=======================
96
93
@@ -164,32 +161,26 @@ Reference
164
161
Examples
165
162
--------
166
163
167
- List group members:
164
+ List group members::
168
165
169
- .. literalinclude :: groups.py
170
- :start-after: # member list
171
- :end-before: # end member list
166
+ members = group.members.list()
172
167
173
- Get a group member:
168
+ Get a group member::
174
169
175
- .. literalinclude :: groups.py
176
- :start-after: # member get
177
- :end-before: # end member get
170
+ members = group.members.get(member_id)
178
171
179
- Add a member to the group:
172
+ Add a member to the group::
180
173
181
- .. literalinclude :: groups.py
182
- :start-after: # member create
183
- :end-before: # end member create
174
+ member = group.members.create({'user_id': user_id,
175
+ 'access_level': gitlab.GUEST_ACCESS})
184
176
185
- Update a member (change the access level):
177
+ Update a member (change the access level)::
186
178
187
- .. literalinclude :: groups.py
188
- :start-after: # member update
189
- :end-before: # end member update
179
+ member.access_level = gitlab.DEVELOPER_ACCESS
180
+ member.save()
190
181
191
- Remove a member from the group:
182
+ Remove a member from the group::
192
183
193
- .. literalinclude :: groups.py
194
- :start-after: # member delete
195
- :end-before: # end member delete
184
+ group.members.delete(member_id)
185
+ # or
186
+ member. delete()
0 commit comments