generated from fastai/nbdev_template
/
auth.html
499 lines (326 loc) · 13.2 KB
/
auth.html
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
---
title: Authentication
keywords: fastai
sidebar: home_sidebar
summary: "Helpers for creating GitHub API tokens"
description: "Helpers for creating GitHub API tokens"
nb_path: "02_auth.ipynb"
---
<!--
#################################################
### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
#################################################
# file to edit: 02_auth.ipynb
# command to build the docs after a change: nbdev_build_docs
-->
<div class="container" id="notebook-container">
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<h2 id="Scopes">Scopes<a class="anchor-link" href="#Scopes"> </a></h2>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="scope_str" class="doc_header"><code>scope_str</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L25" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>scope_str</code>(<strong>*<code>scopes</code></strong>)</p>
</blockquote>
<p>Convert <code>scopes</code> into a comma-separated string</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">scope_str</span><span class="p">(</span><span class="n">Scope</span><span class="o">.</span><span class="n">repo</span><span class="p">,</span><span class="n">Scope</span><span class="o">.</span><span class="n">admin_public_key</span><span class="p">,</span><span class="n">Scope</span><span class="o">.</span><span class="n">public_repo</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>'repo,admin:public_key,public_repo'</pre>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h2 id="GhDeviceAuth" class="doc_header"><code>class</code> <code>GhDeviceAuth</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L33" class="source_link" style="float:right">[source]</a></h2><blockquote><p><code>GhDeviceAuth</code>(<strong><code>client_id</code></strong>=<em><code>'771f3c3af93face45f52'</code></em>, <strong>*<code>scopes</code></strong>) :: <code>GetAttrBase</code></p>
</blockquote>
<p>Get an oauth token using the GitHub API device flow</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Creating a <a href="/auth.html#GhDeviceAuth"><code>GhDeviceAuth</code></a> will complete the first step in the GitHub API device flow, getting device and user codes.</p>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">ghauth</span> <span class="o">=</span> <span class="n">GhDeviceAuth</span><span class="p">()</span>
<span class="n">ghauth</span><span class="o">.</span><span class="n">device_code</span><span class="p">,</span><span class="n">ghauth</span><span class="o">.</span><span class="n">user_code</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_text output_subarea output_execute_result">
<pre>('466da70dae0a30102cd6df6436b57a6a5c58701a', 'CA0C-C4AE')</pre>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="GhDeviceAuth.url_docs" class="doc_header"><code>GhDeviceAuth.url_docs</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L44" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhDeviceAuth.url_docs</code>()</p>
</blockquote>
<p>Default instructions on how to authenticate</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>You can provide your own instructions on how to authenticate, or just print this out:</p>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">ghauth</span><span class="o">.</span><span class="n">url_docs</span><span class="p">())</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_subarea output_stream output_stdout output_text">
<pre>First copy your one-time code: CA0C-C4AE
Then visit https://github.com/login/device in your browser, and paste the code when prompted.
</pre>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="GhDeviceAuth.open_browser" class="doc_header"><code>GhDeviceAuth.open_browser</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L51" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhDeviceAuth.open_browser</code>()</p>
</blockquote>
<p>Open a web browser with the verification URL</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>This uses Python's <code>webbrowser.open</code>, which will use the user's default web browser. This won't work well if the user is using a remote terminal.</p>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="GhDeviceAuth.auth" class="doc_header"><code>GhDeviceAuth.auth</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L57" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhDeviceAuth.auth</code>()</p>
</blockquote>
<p>Return token if authentication complete, or <code>None</code> otherwise</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>Until the user has completed authentication in the browser, this will return None. Normally, you won't call this directly, but will call <code>wait</code> (see below), which will repeatedly call <a href="/auth.html"><code>auth</code></a> until authentication is complete.</p>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="nb">print</span><span class="p">(</span><span class="n">ghauth</span><span class="o">.</span><span class="n">auth</span><span class="p">())</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_subarea output_stream output_stdout output_text">
<pre>None
</pre>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="GhDeviceAuth.wait" class="doc_header"><code>GhDeviceAuth.wait</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L70" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhDeviceAuth.wait</code>(<strong><code>cb</code></strong>:<code>callable</code>=<em><code>None</code></em>, <strong><code>n_polls</code></strong>=<em><code>9999</code></em>)</p>
</blockquote>
<p>Wait up to <code>n_polls</code> times for authentication to complete, calling <code>cb</code> after each poll, if passed</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>If you pass a callback to <code>cb</code>, it will be called after each unsuccessful check for user authentication. For instance, to print a <code>.</code> to the screen after each poll, and store the token in a variable <code>token</code> when complete, you could use:</p>
<div class="highlight"><pre><span></span><span class="n">token</span> <span class="o">=</span> <span class="n">ghauth</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="nb">print</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">''</span><span class="p">))</span>
</pre></div>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_markdown rendered_html output_subarea ">
<h4 id="github_auth_device" class="doc_header"><code>github_auth_device</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/auth.py#L82" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>github_auth_device</code>(<strong><code>wb</code></strong>=<em><code>''</code></em>, <strong><code>n_polls</code></strong>=<em><code>9999</code></em>)</p>
</blockquote>
<p>Authenticate with GitHub, polling up to <code>n_polls</code> times to wait for completion</p>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
</div>
{% endraw %}
<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
<div class="text_cell_render border-box-sizing rendered_html">
<p>When we run this we'll be shown a URL to visit and a code to enter in order to authenticate. Normally we'll be prompted to open a browser, and the function will wait for authentication to complete -- for demonstrating here we'll skip both of these steps:</p>
</div>
</div>
</div>
{% raw %}
<div class="cell border-box-sizing code_cell rendered">
<div class="input">
<div class="inner_cell">
<div class="input_area">
<div class=" highlight hl-ipython3"><pre><span></span><span class="n">github_auth_device</span><span class="p">(</span><span class="s1">'n'</span><span class="p">,</span><span class="n">n_polls</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="output_wrapper">
<div class="output">
<div class="output_area">
<div class="output_subarea output_stream output_stdout output_text">
<pre>First copy your one-time code: <span class="ansi-yellow-fg">DD47-0B67</span>
Then visit https://github.com/login/device in your browser, and paste the code when prompted.
Waiting for authorization...Authentication not complete!
</pre>
</div>
</div>
</div>
</div>
</div>
{% endraw %}
</div>