blob: 294c3f2f8aa28e15a6b34452016de9b0cff2e358 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
########
Projects
########
Use :class:`~gitlab.objects.Project` objects to manipulate projects. The
:attr:`gitlab.Gitlab.projects` manager objects provides helper functions.
Examples
========
List projects:
The API provides several filtering parameters for the listing methods:
* ``archived``: if ``True`` only archived projects will be returned
* ``visibility``: returns only projects with the specified visibility (can be
``public``, ``internal`` or ``private``)
* ``search``: returns project matching the given pattern
Results can also be sorted using the following parameters:
* ``order_by``: sort using the given argument. Valid values are ``id``,
``name``, ``path``, ``created_at``, ``updated_at`` and ``last_activity_at``.
The default is to sort by ``created_at``
* ``sort``: sort order (``asc`` or ``desc``)
.. literalinclude:: projects.py
:start-after: # list
:end-before: # end list
Get a single project:
.. literalinclude:: projects.py
:start-after: # get
:end-before: # end get
Create a project:
.. literalinclude:: projects.py
:start-after: # create
:end-before: # end create
Create a project for a user (admin only):
.. literalinclude:: projects.py
:start-after: # user create
:end-before: # end user create
Update a project:
.. literalinclude:: projects.py
:start-after: # update
:end-before: # end update
Delete a project:
.. literalinclude:: projects.py
:start-after: # delete
:end-before: # end delete
Fork a project:
.. literalinclude:: projects.py
:start-after: # fork
:end-before: # end fork
Create/delete a fork relation between projects (requires admin permissions):
.. literalinclude:: projects.py
:start-after: # forkrelation
:end-before: # end forkrelation
Star/unstar a project:
.. literalinclude:: projects.py
:start-after: # star
:end-before: # end star
Archive/unarchive a project:
.. literalinclude:: projects.py
:start-after: # archive
:end-before: # end archive
.. note::
The underscore character at the end of the methods is used to workaround a
conflict with a previous misuse of the ``archive`` method (deprecated but
not yet removed).
Events
------
Use :class:`~gitlab.objects.ProjectEvent` objects to manipulate events. The
:attr:`gitlab.Gitlab.project_events` and :attr:`Project.events
<gitlab.objects.Project.events>` manager objects provide helper functions.
List the project events:
.. literalinclude:: projects.py
:start-after: # events list
:end-before: # end events list
Team members
------------
Use :class:`~gitlab.objects.ProjectMember` objects to manipulate projects
members. The :attr:`gitlab.Gitlab.project_members` and :attr:`Project.members
<gitlab.objects.Projects.members>` manager objects provide helper functions.
List the project members:
.. literalinclude:: projects.py
:start-after: # members list
:end-before: # end members list
Search project members matching a query string:
.. literalinclude:: projects.py
:start-after: # members search
:end-before: # end members search
Get a single project member:
.. literalinclude:: projects.py
:start-after: # members get
:end-before: # end members get
Add a project member:
.. literalinclude:: projects.py
:start-after: # members add
:end-before: # end members add
Modify a project member (change the access level):
.. literalinclude:: projects.py
:start-after: # members update
:end-before: # end members update
Remove a member from the project team:
.. literalinclude:: projects.py
:start-after: # members delete
:end-before: # end members delete
Share the project with a group:
.. literalinclude:: projects.py
:start-after: # share
:end-before: # end share
Hooks
-----
Use :class:`~gitlab.objects.ProjectHook` objects to manipulate projects
hooks. The :attr:`gitlab.Gitlab.project_hooks` and :attr:`Project.hooks
<gitlab.objects.Projects.hooks>` manager objects provide helper functions.
List the project hooks:
.. literalinclude:: projects.py
:start-after: # hook list
:end-before: # end hook list
Get a project hook
.. literalinclude:: projects.py
:start-after: # hook get
:end-before: # end hook get
Create a project hook:
.. literalinclude:: projects.py
:start-after: # hook create
:end-before: # end hook create
Update a project hook:
.. literalinclude:: projects.py
:start-after: # hook update
:end-before: # end hook update
Delete a project hook:
.. literalinclude:: projects.py
:start-after: # hook delete
:end-before: # end hook delete
|
