Skip to content

Commit 28fd10c

Browse files
alexvhalexvh
committed
Update docs
1 parent 36a5ce8 commit 28fd10c

File tree

49 files changed

+633
-127
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+633
-127
lines changed

‎doc/api-objects.txt‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
gitlab3 gitlab3-module.html
2+
gitlab3.ACCESS_LEVEL_OWNER gitlab3-module.html#ACCESS_LEVEL_OWNER
23
gitlab3.ACCESS_LEVEL_GUEST gitlab3-module.html#ACCESS_LEVEL_GUEST
34
gitlab3.__package__ gitlab3-module.html#__package__
45
gitlab3.ACCESS_LEVEL_REPORTER gitlab3-module.html#ACCESS_LEVEL_REPORTER
@@ -9,11 +10,14 @@ gitlab3.GitLab.find_system_hook gitlab3.GitLab-class.html#find_system_hook
910
gitlab3.GitLab.Group gitlab3.GitLab.Group-class.html
1011
gitlab3.GitLab.delete_user gitlab3.GitLab-class.html#delete_user
1112
gitlab3.GitLab.find_group gitlab3.GitLab-class.html#find_group
13+
gitlab3.GitLab.delete_project gitlab3.GitLab-class.html#delete_project
1214
gitlab3.GitLab.SystemHook gitlab3.GitLab.SystemHook-class.html
1315
gitlab3.GitLab.add_system_hook gitlab3.GitLab-class.html#add_system_hook
1416
gitlab3.GitLab.Issue gitlab3.GitLab.Issue-class.html
1517
gitlab3.GitLab.__init__ gitlab3.GitLab-class.html#__init__
1618
gitlab3.GitLab.group gitlab3.GitLab-class.html#group
19+
gitlab3.GitLab.delete_group gitlab3.GitLab-class.html#delete_group
20+
gitlab3.GitLab.find_project_by_name gitlab3.GitLab-class.html#find_project_by_name
1721
gitlab3.GitLab.issues gitlab3.GitLab-class.html#issues
1822
gitlab3.GitLab.current_user gitlab3.GitLab-class.html#current_user
1923
gitlab3.GitLab.update_user gitlab3.GitLab-class.html#update_user
@@ -30,17 +34,17 @@ gitlab3.GitLab.projects gitlab3.GitLab-class.html#projects
3034
gitlab3.GitLab.delete_system_hook gitlab3.GitLab-class.html#delete_system_hook
3135
gitlab3.GitLab.find_project gitlab3.GitLab-class.html#find_project
3236
gitlab3.GitLab.find_team gitlab3.GitLab-class.html#find_team
33-
gitlab3.GitLab.add_user gitlab3.GitLab-class.html#add_user
3437
gitlab3.GitLab.find_user gitlab3.GitLab-class.html#find_user
3538
gitlab3.GitLab.teams gitlab3.GitLab-class.html#teams
3639
gitlab3.GitLab.project gitlab3.GitLab-class.html#project
3740
gitlab3.GitLab.add_group gitlab3.GitLab-class.html#add_group
3841
gitlab3.GitLab.User gitlab3.GitLab.User-class.html
3942
gitlab3.GitLab.team gitlab3.GitLab-class.html#team
4043
gitlab3.GitLab.login gitlab3.GitLab-class.html#login
41-
gitlab3.GitLab.CurrentUser gitlab3.GitLab.CurrentUser-class.html
4244
gitlab3.GitLab.find_issue gitlab3.GitLab-class.html#find_issue
4345
gitlab3.GitLab.CurrentUser gitlab3.GitLab.CurrentUser-class.html
46+
gitlab3.GitLab.add_user gitlab3.GitLab-class.html#add_user
47+
gitlab3.GitLab.CurrentUser gitlab3.GitLab.CurrentUser-class.html
4448
gitlab3.GitLab.CurrentUser.SSHKey gitlab3.GitLab.CurrentUser.SSHKey-class.html
4549
gitlab3.GitLab.CurrentUser.delete_ssh_key gitlab3.GitLab.CurrentUser-class.html#delete_ssh_key
4650
gitlab3.GitLab.CurrentUser.find_ssh_key gitlab3.GitLab.CurrentUser-class.html#find_ssh_key
@@ -50,7 +54,15 @@ gitlab3.GitLab.CurrentUser.ssh_keys gitlab3.GitLab.CurrentUser-class.html#ssh_ke
5054
gitlab3.GitLab.CurrentUser.SSHKey gitlab3.GitLab.CurrentUser.SSHKey-class.html
5155
gitlab3.GitLab.CurrentUser.SSHKey.delete gitlab3.GitLab.CurrentUser.SSHKey-class.html#delete
5256
gitlab3.GitLab.Group gitlab3.GitLab.Group-class.html
57+
gitlab3.GitLab.Group.find_member gitlab3.GitLab.Group-class.html#find_member
5358
gitlab3.GitLab.Group.transfer_project gitlab3.GitLab.Group-class.html#transfer_project
59+
gitlab3.GitLab.Group.delete_member gitlab3.GitLab.Group-class.html#delete_member
60+
gitlab3.GitLab.Group.add_member gitlab3.GitLab.Group-class.html#add_member
61+
gitlab3.GitLab.Group.Member gitlab3.GitLab.Group.Member-class.html
62+
gitlab3.GitLab.Group.members gitlab3.GitLab.Group-class.html#members
63+
gitlab3.GitLab.Group.delete gitlab3.GitLab.Group-class.html#delete
64+
gitlab3.GitLab.Group.Member gitlab3.GitLab.Group.Member-class.html
65+
gitlab3.GitLab.Group.Member.delete gitlab3.GitLab.Group.Member-class.html#delete
5466
gitlab3.GitLab.Issue gitlab3.GitLab.Issue-class.html
5567
gitlab3.GitLab.Project gitlab3.GitLab.Project-class.html
5668
gitlab3.GitLab.Project.find_member gitlab3.GitLab.Project-class.html#find_member
@@ -114,6 +126,7 @@ gitlab3.GitLab.Project.update_milestone gitlab3.GitLab.Project-class.html#update
114126
gitlab3.GitLab.Project.unprotect_branch gitlab3.GitLab.Project-class.html#unprotect_branch
115127
gitlab3.GitLab.Project.merge_request gitlab3.GitLab.Project-class.html#merge_request
116128
gitlab3.GitLab.Project.DeployKey gitlab3.GitLab.Project.DeployKey-class.html
129+
gitlab3.GitLab.Project.delete gitlab3.GitLab.Project-class.html#delete
117130
gitlab3.GitLab.Project.wall_notes gitlab3.GitLab.Project-class.html#wall_notes
118131
gitlab3.GitLab.Project.Hook gitlab3.GitLab.Project.Hook-class.html
119132
gitlab3.GitLab.Project.add_deploy_key gitlab3.GitLab.Project-class.html#add_deploy_key

‎doc/class-tree.html‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,32 +87,35 @@ <h1 class="epydoc">Class Hierarchy</h1>
8787
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Hook-class.html">gitlab3.GitLab.Project.Hook</a></strong>:
8888
<em class="summary">A project hook.</em>
8989
</li>
90-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Issue-class.html">gitlab3.GitLab.Issue</a></strong>:
91-
<em class="summary">An issue.</em>
92-
</li>
9390
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue-class.html">gitlab3.GitLab.Project.Issue</a></strong>:
9491
<em class="summary">A project issue.</em>
9592
</li>
96-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Team.Member-class.html">gitlab3.GitLab.Team.Member</a></strong>:
97-
<em class="summary">A member in a team.</em>
93+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Issue-class.html">gitlab3.GitLab.Issue</a></strong>:
94+
<em class="summary">An issue.</em>
9895
</li>
9996
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Member-class.html">gitlab3.GitLab.Project.Member</a></strong>:
10097
<em class="summary">A project member.</em>
10198
</li>
99+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Group.Member-class.html">gitlab3.GitLab.Group.Member</a></strong>:
100+
<em class="summary">A group member.</em>
101+
</li>
102+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Team.Member-class.html">gitlab3.GitLab.Team.Member</a></strong>:
103+
<em class="summary">A member in a team.</em>
104+
</li>
102105
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.MergeRequest-class.html">gitlab3.GitLab.Project.MergeRequest</a></strong>:
103106
<em class="summary">A merge request.</em>
104107
</li>
105108
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Milestone-class.html">gitlab3.GitLab.Project.Milestone</a></strong>:
106109
<em class="summary">A project milestone.</em>
107110
</li>
108-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.MergeRequest.Note-class.html">gitlab3.GitLab.Project.MergeRequest.Note</a></strong>:
109-
<em class="summary">A merge request note.</em>
111+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue.Note-class.html">gitlab3.GitLab.Project.Issue.Note</a></strong>:
112+
<em class="summary">An issue note.</em>
110113
</li>
111114
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Snippet.Note-class.html">gitlab3.GitLab.Project.Snippet.Note</a></strong>:
112115
<em class="summary">A snippet note.</em>
113116
</li>
114-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue.Note-class.html">gitlab3.GitLab.Project.Issue.Note</a></strong>:
115-
<em class="summary">An issue note.</em>
117+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.MergeRequest.Note-class.html">gitlab3.GitLab.Project.MergeRequest.Note</a></strong>:
118+
<em class="summary">A merge request note.</em>
116119
</li>
117120
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project-class.html">gitlab3.GitLab.Project</a></strong>:
118121
<em class="summary">A project.</em>
@@ -223,7 +226,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
223226
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
224227
<tr>
225228
<td align="left" class="footer">
226-
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
229+
Generated by Epydoc 3.0.1 on Tue Nov 12 15:03:49 2013
227230
</td>
228231
<td align="right" class="footer">
229232
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3-module.html‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,13 @@ <h1 class="epydoc">Package gitlab3</h1><p class="nomargin-top"></p>
138138
<a name="ACCESS_LEVEL_MASTER"></a><span class="summary-name">ACCESS_LEVEL_MASTER</span> = <code title="40">40</code>
139139
</td>
140140
</tr>
141+
<tr>
142+
<td width="15%" align="right" valign="top" class="summary">
143+
<span class="summary-type">&nbsp;</span>
144+
</td><td class="summary">
145+
<a name="ACCESS_LEVEL_OWNER"></a><span class="summary-name">ACCESS_LEVEL_OWNER</span> = <code title="50">50</code>
146+
</td>
147+
</tr>
141148
<tr>
142149
<td width="15%" align="right" valign="top" class="summary">
143150
<span class="summary-type">&nbsp;</span>
@@ -177,7 +184,7 @@ <h1 class="epydoc">Package gitlab3</h1><p class="nomargin-top"></p>
177184
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
178185
<tr>
179186
<td align="left" class="footer">
180-
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
187+
Generated by Epydoc 3.0.1 on Tue Nov 12 15:03:49 2013
181188
</td>
182189
<td align="right" class="footer">
183190
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab-class.html‎

Lines changed: 72 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,23 @@ <h1 class="epydoc">Class GitLab</h1><p class="nomargin-top"></p>
278278
<td align="right" valign="top">
279279

280280

281+
</td>
282+
</tr>
283+
</table>
284+
285+
</td>
286+
</tr>
287+
<tr>
288+
<td width="15%" align="right" valign="top" class="summary">
289+
<span class="summary-type">&nbsp;</span>
290+
</td><td class="summary">
291+
<table width="100%" cellpadding="0" cellspacing="0" border="0">
292+
<tr>
293+
<td><span class="summary-sig"><a name="delete_group"></a><span class="summary-sig-name">delete_group</span>(<span class="summary-sig-arg">group</span>)</span><br />
294+
Equivalent to <i>group</i>.delete()</td>
295+
<td align="right" valign="top">
296+
297+
281298
</td>
282299
</tr>
283300
</table>
@@ -432,6 +449,23 @@ <h1 class="epydoc">Class GitLab</h1><p class="nomargin-top"></p>
432449
<td align="right" valign="top">
433450

434451

452+
</td>
453+
</tr>
454+
</table>
455+
456+
</td>
457+
</tr>
458+
<tr>
459+
<td width="15%" align="right" valign="top" class="summary">
460+
<span class="summary-type">&nbsp;</span>
461+
</td><td class="summary">
462+
<table width="100%" cellpadding="0" cellspacing="0" border="0">
463+
<tr>
464+
<td><span class="summary-sig"><a name="delete_project"></a><span class="summary-sig-name">delete_project</span>(<span class="summary-sig-arg">project</span>)</span><br />
465+
Equivalent to <i>project</i>.delete()</td>
466+
<td align="right" valign="top">
467+
468+
435469
</td>
436470
</tr>
437471
</table>
@@ -510,7 +544,9 @@ <h1 class="epydoc">Class GitLab</h1><p class="nomargin-top"></p>
510544
<span class="summary-sig-arg">projects_limit</span>=<span class="summary-sig-default">None</span>,
511545
<span class="summary-sig-arg">extern_uid</span>=<span class="summary-sig-default">None</span>,
512546
<span class="summary-sig-arg">provider</span>=<span class="summary-sig-default">None</span>,
513-
<span class="summary-sig-arg">bio</span>=<span class="summary-sig-default">None</span>)</span><br />
547+
<span class="summary-sig-arg">bio</span>=<span class="summary-sig-default">None</span>,
548+
<span class="summary-sig-arg">admin</span>=<span class="summary-sig-default">None</span>,
549+
<span class="summary-sig-arg">can_create_group</span>=<span class="summary-sig-default">None</span>)</span><br />
514550
Add a new user to GitLab</td>
515551
<td align="right" valign="top">
516552

@@ -649,6 +685,26 @@ <h1 class="epydoc">Class GitLab</h1><p class="nomargin-top"></p>
649685
<td align="right" valign="top">
650686

651687

688+
</td>
689+
</tr>
690+
</table>
691+
692+
</td>
693+
</tr>
694+
<tr>
695+
<td width="15%" align="right" valign="top" class="summary">
696+
<span class="summary-type">&nbsp;</span>
697+
</td><td class="summary">
698+
<table width="100%" cellpadding="0" cellspacing="0" border="0">
699+
<tr>
700+
<td><span class="summary-sig"><a name="find_project_by_name"></a><span class="summary-sig-name">find_project_by_name</span>(<span class="summary-sig-arg">query</span>,
701+
<span class="summary-sig-arg">per_page</span>=<span class="summary-sig-default">None</span>,
702+
<span class="summary-sig-arg">page</span>=<span class="summary-sig-default">None</span>)</span><br />
703+
Use GitLab's API for finding projects by name (more efficient than
704+
<i>find_project(name='&lt;name&gt;')</i>).</td>
705+
<td align="right" valign="top">
706+
707+
652708
</td>
653709
</tr>
654710
</table>
@@ -662,9 +718,11 @@ <h1 class="epydoc">Class GitLab</h1><p class="nomargin-top"></p>
662718
<table width="100%" cellpadding="0" cellspacing="0" border="0">
663719
<tr>
664720
<td><span class="summary-sig"><a href="gitlab3.GitLab-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
665-
<span class="summary-sig-arg">url</span>,
721+
<span class="summary-sig-arg">gitlab_url</span>,
666722
<span class="summary-sig-arg">token</span>=<span class="summary-sig-default">None</span>,
667-
<span class="summary-sig-arg">convert_dates</span>=<span class="summary-sig-default">True</span>)</span><br />
723+
<span class="summary-sig-arg">convert_dates</span>=<span class="summary-sig-default">True</span>,
724+
<span class="summary-sig-arg">ssl_verify</span>=<span class="summary-sig-default">None</span>,
725+
<span class="summary-sig-arg">ssl_cert</span>=<span class="summary-sig-default">None</span>)</span><br />
668726
Initialize a GitLab connection and optionally supply auth token.</td>
669727
<td align="right" valign="top">
670728

@@ -1139,7 +1197,9 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">add_user</span>(<spa
11391197
<span class="sig-arg">projects_limit</span>=<span class="sig-default">None</span>,
11401198
<span class="sig-arg">extern_uid</span>=<span class="sig-default">None</span>,
11411199
<span class="sig-arg">provider</span>=<span class="sig-default">None</span>,
1142-
<span class="sig-arg">bio</span>=<span class="sig-default">None</span>)</span>
1200+
<span class="sig-arg">bio</span>=<span class="sig-default">None</span>,
1201+
<span class="sig-arg">admin</span>=<span class="sig-default">None</span>,
1202+
<span class="sig-arg">can_create_group</span>=<span class="sig-default">None</span>)</span>
11431203
</h3>
11441204
</td><td align="right" valign="top"
11451205
>&nbsp;
@@ -1253,9 +1313,11 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">add_team</span>(<spa
12531313
<table width="100%" cellpadding="0" cellspacing="0" border="0">
12541314
<tr valign="top"><td>
12551315
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
1256-
<span class="sig-arg">url</span>,
1316+
<span class="sig-arg">gitlab_url</span>,
12571317
<span class="sig-arg">token</span>=<span class="sig-default">None</span>,
1258-
<span class="sig-arg">convert_dates</span>=<span class="sig-default">True</span>)</span>
1318+
<span class="sig-arg">convert_dates</span>=<span class="sig-default">True</span>,
1319+
<span class="sig-arg">ssl_verify</span>=<span class="sig-default">None</span>,
1320+
<span class="sig-arg">ssl_cert</span>=<span class="sig-default">None</span>)</span>
12591321
<br /><em class="fname">(Constructor)</em>
12601322
</h3>
12611323
</td><td align="right" valign="top"
@@ -1265,7 +1327,9 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<spa
12651327

12661328
<p>Initialize a GitLab connection and optionally supply auth token.
12671329
<i>convert_dates</i> can be set to <i>False</i> to disable automatic
1268-
conversion of date strings to <i>datetime</i> objects.</p>
1330+
conversion of date strings to <i>datetime</i> objects. <i>ssl_verify</i>
1331+
and <i>ssl_cert</i> are passed to python-requests as the <i>verify</i>
1332+
and <i>cert</i> arguments, respectively.</p>
12691333
<dl class="fields">
12701334
</dl>
12711335
</td></tr></table>
@@ -1324,7 +1388,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">login</span>(<span c
13241388
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
13251389
<tr>
13261390
<td align="left" class="footer">
1327-
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
1391+
Generated by Epydoc 3.0.1 on Tue Nov 12 15:03:49 2013
13281392
</td>
13291393
<td align="right" class="footer">
13301394
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.CurrentUser-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">add_ssh_key</span>(<
345345
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
346346
<tr>
347347
<td align="left" class="footer">
348-
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
348+
Generated by Epydoc 3.0.1 on Tue Nov 12 15:03:49 2013
349349
</td>
350350
<td align="right" class="footer">
351351
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.CurrentUser.SSHKey-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h1 class="epydoc">Class SSHKey</h1><p class="nomargin-top"></p>
134134
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
135135
<tr>
136136
<td align="left" class="footer">
137-
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
137+
Generated by Epydoc 3.0.1 on Tue Nov 12 15:03:49 2013
138138
</td>
139139
<td align="right" class="footer">
140140
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)