@@ -25,23 +25,17 @@ Reference
2525Examples
2626--------
2727
28- List the groups:
28+ List the groups::
2929
30- .. literalinclude :: groups.py
31- :start-after: # list
32- :end-before: # end list
30+ groups = gl.groups.list()
3331
34- Get a group's detail:
32+ Get a group's detail::
3533
36- .. literalinclude :: groups.py
37- :start-after: # get
38- :end-before: # end get
34+ group = gl.groups.get(group_id)
3935
40- List a group's projects:
36+ List a group's projects::
4137
42- .. literalinclude :: groups.py
43- :start-after: # projects list
44- :end-before: # end projects list
38+ projects = group.projects.list()
4539
4640You can filter and sort the result using the following parameters:
4741
@@ -54,23 +48,20 @@ You can filter and sort the result using the following parameters:
5448* ``sort ``: sort order: ``asc `` or ``desc ``
5549* ``ci_enabled_first ``: return CI enabled groups first
5650
57- Create a group:
51+ Create a group::
5852
59- .. literalinclude :: groups.py
60- :start-after: # create
61- :end-before: # end create
53+ group = gl.groups.create({'name': 'group1', 'path': 'group1'})
6254
63- Update a group:
55+ Update a group::
6456
65- .. literalinclude :: groups.py
66- :start-after: # update
67- :end-before: # end update
57+ group.description = 'My awesome group'
58+ group.save()
6859
69- Remove a group:
60+ Remove a group::
7061
71- .. literalinclude :: groups.py
72- :start-after: # delete
73- :end-before: # end delete
62+ gl.group.delete(group_id)
63+ # or
64+ group. delete()
7465
7566Subgroups
7667=========
@@ -91,6 +82,12 @@ List the subgroups for a group::
9182
9283 subgroups = group.subgroups.list()
9384
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+
9491Group custom attributes
9592=======================
9693
@@ -164,32 +161,26 @@ Reference
164161Examples
165162--------
166163
167- List group members:
164+ List group members::
168165
169- .. literalinclude :: groups.py
170- :start-after: # member list
171- :end-before: # end member list
166+ members = group.members.list()
172167
173- Get a group member:
168+ Get a group member::
174169
175- .. literalinclude :: groups.py
176- :start-after: # member get
177- :end-before: # end member get
170+ members = group.members.get(member_id)
178171
179- Add a member to the group:
172+ Add a member to the group::
180173
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})
184176
185- Update a member (change the access level):
177+ Update a member (change the access level)::
186178
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()
190181
191- Remove a member from the group:
182+ Remove a member from the group::
192183
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