This repository was archived by the owner on Oct 24, 2022. It is now read-only.
forked from kennethreitz/python-github3
-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy path__init__.py
More file actions
224 lines (171 loc) · 6.76 KB
/
__init__.py
File metadata and controls
224 lines (171 loc) · 6.76 KB
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# -*- encoding: utf-8 -*-
from pygithub3.services.base import Service
from .collaborators import Collaborators
from .commits import Commits
from .downloads import Downloads
from .forks import Forks
from .keys import Keys
from .watchers import Watchers
from .stargazers import Stargazers
from .hooks import Hooks
from .statuses import Statuses
class Repo(Service):
""" Consume `Repos API <http://developer.github.com/v3/repos>`_ """
def __init__(self, **config):
self.collaborators = Collaborators(**config)
self.commits = Commits(**config)
self.downloads = Downloads(**config)
self.forks = Forks(**config)
self.keys = Keys(**config)
self.watchers = Watchers(**config)
self.stargazers = Stargazers(**config)
self.hooks = Hooks(**config)
self.statuses = Statuses(**config)
super(Repo, self).__init__(**config)
def list(self, user=None, type='all', sort='full_name', direction='desc'):
""" Get user's repositories
:param str user: Username
:param str type: *all*, owner, public, private, member
:param str sort: created, updated, pushed, *full_name*
:param str direction: asc or *desc*
:returns: A :doc:`result`
If you call it without user and you are authenticated, get the
authenticated user's repositories
.. warning::
If you aren't authenticated and call without user, it returns 403
::
repo_service.list('copitux', type='owner')
repo_service.list(type='private')
"""
request = self.request_builder('repos.list', user=user)
return self._get_result(request, type=type, sort=sort,
direction=direction)
def list_by_org(self, org, type='all'):
""" Get organization's repositories
:param str org: Organization name
:param str type: *all*, public, member, private
:returns: A :doc:`result`
::
repo_service.list_by_org('myorganization', type='member')
"""
request = self.make_request('repos.list_by_org', org=org)
return self._get_result(request, type=type)
def create(self, data, in_org=None):
""" Create a new repository
:param dict data: Input. See `github repos doc`_
:param str in_org: Organization where create the repository (optional)
.. warning::
You must be authenticated
If you use ``in_org`` arg, the authenticated user must be a member
of <in_org>
::
repo_service.create(dict(name='new_repo', description='desc'))
repo_service.create(dict(name='new_repo_in_org', team_id=2300),
in_org='myorganization')
"""
request = self.make_request('repos.create', org=in_org, body=data)
return self._post(request)
def delete(self, user=None, repo=None):
""" Delete a single repo
:param str user: Username
:param str repo: Repository
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.delete', user=user, repo=repo)
return self._delete(request)
def get(self, user=None, repo=None):
""" Get a single repo
:param str user: Username
:param str repo: Repository
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.get', user=user, repo=repo)
return self._get(request)
def update(self, data, user=None, repo=None):
""" Update a single repository
:param dict data: Input. See `github repos doc`_
:param str user: Username
:param str repo: Repository
.. note::
Remember :ref:`config precedence`
.. warning::
You must be authenticated
::
repo_service.update(dict(has_issues=True), user='octocat',
repo='oct_repo')
"""
request = self.make_request('repos.update', body=data,
user=user, repo=repo)
return self._patch(request)
def __list_contributors(self, user=None, repo=None, **kwargs):
request = self.make_request('repos.list_contributors',
user=user, repo=repo)
return self._get_result(request, **kwargs)
def list_contributors(self, user=None, repo=None):
""" Get repository's contributors
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
return self.__list_contributors(user, repo)
def list_contributors_with_anonymous(self, user=None, repo=None):
""" Like :attr:`~pygithub3.services.repos.Repo.list_contributors` plus
anonymous """
return self.__list_contributors(user, repo, anon=True)
def list_languages(self, user=None, repo=None):
""" Get repository's languages
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.list_languages',
user=user, repo=repo)
return self._get(request)
def list_teams(self, user=None, repo=None):
""" Get repository's teams
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.list_teams', user=user, repo=repo)
return self._get_result(request)
def list_tags(self, user=None, repo=None):
""" Get repository's tags
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.list_tags', user=user, repo=repo)
return self._get_result(request)
def list_branches(self, user=None, repo=None):
""" Get repository's branches
:param str user: Username
:param str repo: Repository
:returns: A :doc:`result`
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.list_branches',
user=user, repo=repo)
return self._get_result(request)
def get_branch(self, branchname, user=None, repo=None):
""" Get branch
:param str user: Username
:param str repo: Repository
:param str branchname
.. note::
Remember :ref:`config precedence`
"""
request = self.make_request('repos.get_branch', user=user,
repo=repo, branch=branchname)
return self._get(request)