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
189
190
191
192
193
194
195
196
197
|
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
from pygithub3.services.base import Service
class Labels(Service):
""" Consume `Labels API
<http://developer.github.com/v3/issues/labels>`_ """
def list(self, user=None, repo=None):
""" Get repository's labels
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.list', user=user, repo=repo)
return self._get_result(request)
def get(self, name, user=None, repo=None):
""" Get a single label
:param str name: Label name
:param str user: Username
:param str repo: Repo name
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.get', user=user,
repo=repo, name=name)
return self._get(request)
def create(self, data, user=None, repo=None):
""" Create a label on an repo
:param dict data: Input. See `github labels doc`_
:param str user: Username
:param str repo: Repo name
.. warning::
You must be authenticated
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.create', user=user,
repo=repo, body=data)
return self._post(request)
def update(self, name, data, user=None, repo=None):
""" Update a label on an repo
:param str name: Label name
:param dict data: Input. See `github labels doc`_
:param str user: Username
:param str repo: Repo name
.. warning::
You must be authenticated
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.update', user=user,
repo=repo, name=name, body=data)
return self._patch(request)
def delete(self, name, user=None, repo=None):
""" Delete a label on an repo
:param str name: Label name
:param str user: Username
:param str repo: Repo name
.. warning::
You must be authenticated
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.delete', user=user,
repo=repo, name=name)
return self._delete(request)
def list_by_issue(self, number, user=None, repo=None):
""" List labels for an issue
:param int number: Issue number
:param str user: Username
:param str repo: Repo name
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.list_by_issue', user=user,
repo=repo, number=number)
return self._get(request)
def add_to_issue(self, number, labels, user=None, repo=None):
""" Add labels to issue
:param int number: Issue number
:param str user: Username
:param str repo: Repo name
:param list labels: Label names
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
::
labels_service.add_to_issue(2, user='github', repo='github',
'label1', 'label2', 'label3')
"""
request = self.make_request('issues.labels.add_to_issue', user=user,
repo=repo, number=number, body=map(str, labels))
return self._post(request)
def remove_from_issue(self, number, label, user=None, repo=None):
""" Remove a label from an issue
:param int number: Issue number
:param str label: Label name
:param str user: Username
:param str repo: Repo name
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.remove_from_issue',
user=user,
repo=repo,
number=number,
name=label)
return self._delete(request)
def replace_all(self, number, labels, user=None, repo=None):
""" Replace all labels for a issue
:param int number: Issue number
:param list labels: New labels
:param str user: Username
:param str repo: Repo name
:returns: A :doc:`result`
.. note::
If labels weren't especified, it'd remove all labels from the issue
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.replace_all',
user=user,
repo=repo,
number=number,
body=map(str, labels))
return self._put(request)
def remove_all(self, number, user=None, repo=None):
""" Remove all labels from a issue
:param int number: Issue number
:param str user: Username
:param str repo: Repo name
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.remove_all',
user=user,
repo=repo,
number=number,)
return self._delete(request)
def list_by_milestone(self, number, user=None, repo=None):
""" Get labels for every issue in a milestone
:param int number: Milestone ID
:param str user: Username
:param str repo: Repo name
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('issues.labels.list_by_milestone',
user=user, repo=repo, number=number)
return self._get_result(request)
|
