This repository was archived by the owner on May 22, 2021. It is now read-only.
forked from sigmavirus24/github3.py
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgithub.pyi
More file actions
232 lines (203 loc) · 4.94 KB
/
Copy pathgithub.pyi
File metadata and controls
232 lines (203 loc) · 4.94 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
225
226
227
228
229
230
231
232
"""This module contains the type stubs for github3.github."""
from typing import (
Any,
Dict,
List,
Optional,
TypeVar,
Union,
)
from . import auths
from . import decorators
from . import events
from . import models
from . import orgs
from . import structs
from . import users
from .gists import gist
from .issues import issue
from .repos import repo
T = TypeVar('T', bound='GitHub')
class GitHub(models.GitHubCore):
def __init__(
self: T,
username: str='',
password: str='',
token: str='',
) -> None:
...
@decorators.requires_auth
def add_email_addresses(
self: T,
addresses: List[str]=[],
) -> List[users.Email]:
...
def all_events(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[events.Event]:
...
def all_organizations(
self: T,
number: int=-1,
since: Optional[int]=None,
etag: Optional[str]=None,
per_page: Optional[int]=None,
) -> structs.GitHubIterator[orgs.ShortOrganization]:
...
def all_repositories(
self: T,
number: int=-1,
since: Optional[int]=None,
etag: Optional[str]=None,
per_page: Optional[int]=None,
) -> structs.GitHubIterator[repo.ShortRepository]:
...
def all_users(
self: T,
number: int=-1,
etag: Optional[str]=None,
per_page: Optional[int]=None,
since: Optional[int]=None,
) -> structs.GitHubIterator[users.ShortUser]:
...
@decorators.requires_basic_auth
def authorization(
self: T,
id_num: Union[int, str],
) -> auths.Authorization:
...
def authorizations(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[auths.Authorization]:
...
def authorize(
self: T,
username: str,
password: str,
scopes: Optional[List[str]]=None,
note: str='',
note_url: str='',
client_id: str='',
client_secret: str='',
) -> auths.Authorization:
...
def check_authorization(
self: T,
access_token: str,
) -> bool:
...
def create_gist(
self: T,
description: str,
files: Dict[str, Dict[str, str]],
public: bool=True,
) -> gist.Gist:
...
@decorators.requires_auth
def create_issue(
self: T,
owner: str,
repository: str,
title: str,
body: Optional[str]=None,
assignee: Optional[str]=None,
milestone: Optional[int]=None,
labels: List[str]=[],
assignees: Optional[List[str]]=None,
) -> issue.ShortIssue:
...
@decorators.requires_auth
def create_key(
self: T,
title: str,
key: str,
read_only: bool=False,
) -> users.Key:
...
@decorators.requires_auth
def create_repository(
self: T,
name: str,
description: str='',
homepage: str='',
private: bool=False,
has_issues: bool=True,
has_wiki: bool=True,
auto_init: bool=False,
gitignore_template: str='',
) -> repo.Repository:
...
@decorators.requires_auth
def delete_email_addresses(
self: T,
addresses: List[str],
) -> bool:
...
@decorators.requires_auth
def emails(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[users.Email]:
...
def emojis(self: T) -> Dict[str, str]:
...
def feeds(self: T) -> Dict[str, Any]:
...
@decorators.requires_auth
def follow(
self: T,
username: str
) -> bool:
...
def followed_by(
self: T,
username: str,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[users.ShortUser]:
...
@decorators.requires_auth
def followers(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[users.ShortUser]:
...
def followers_of(
self: T,
username: str,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[users.ShortUser]:
...
@decorators.requires_auth
def following(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[users.ShortUser]:
...
def gist(
self: T,
id_num: int,
) -> gist.Gist:
...
@decorators.requires_auth
def gists(
self: T,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[gist.ShortGist]:
...
def gists_by(
self: T,
username: str,
number: int=-1,
etag: Optional[str]=None,
) -> structs.GitHubIterator[gist.ShortGist]:
...