marine-tracker / docs /auth.html
narniagooooo's picture
Initial commit: marine mammal tracking dashboard and route prediction
27b6a20
Raw History Blame Contribute Delete
3.32 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: module auth</title>
</head><body>
<table class="heading">
<tr class="heading-text decor">
<td class="title">&nbsp;<br><strong class="title">auth</strong></td>
<td class="extra"><a href=".">index</a><br><a href="file:/Users/samuelveliveli/Downloads/marine-tracker/src/auth.py">/Users/samuelveliveli/Downloads/marine-tracker/src/auth.py</a></td></tr></table>
<p><span class="code">Optional&nbsp;Movebank&nbsp;credentials,&nbsp;loaded&nbsp;from&nbsp;environment&nbsp;variables.<br>
&nbsp;<br>
Movebank's&nbsp;live&nbsp;tracking&nbsp;API&nbsp;(www.movebank.org/movebank/service/direct-read)<br>
requires&nbsp;HTTP&nbsp;Basic&nbsp;Auth&nbsp;on&nbsp;every&nbsp;request,&nbsp;including&nbsp;study&nbsp;discovery&nbsp;--&nbsp;there<br>
is&nbsp;no&nbsp;anonymous&nbsp;tier.&nbsp;If&nbsp;MOVEBANK_USERNAME&nbsp;and&nbsp;MOVEBANK_PASSWORD&nbsp;are&nbsp;not&nbsp;set,<br>
callers&nbsp;should&nbsp;fall&nbsp;back&nbsp;to&nbsp;the&nbsp;Movebank&nbsp;Data&nbsp;Repository&nbsp;(a&nbsp;separate,&nbsp;fully<br>
public,&nbsp;DOI-archival&nbsp;system&nbsp;used&nbsp;by&nbsp;ingest.py&nbsp;for&nbsp;historical&nbsp;studies).<br>
&nbsp;<br>
Credentials&nbsp;are&nbsp;read&nbsp;from&nbsp;a&nbsp;local&nbsp;.env&nbsp;file&nbsp;(via&nbsp;python-dotenv)&nbsp;or&nbsp;from&nbsp;the<br>
shell&nbsp;environment.&nbsp;Never&nbsp;hardcode&nbsp;credentials&nbsp;in&nbsp;source.</span></p>
<p>
<table class="section">
<tr class="decor pkg-content-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Modules</strong></td></tr>
<tr><td class="decor pkg-content-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><table><tr><td class="multicolumn"><a href="os.html">os</a><br>
</td><td class="multicolumn"></td><td class="multicolumn"></td><td class="multicolumn"></td></tr></table></td></tr></table><p>
<table class="section">
<tr class="decor functions-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Functions</strong></td></tr>
<tr><td class="decor functions-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><dl><dt><a name="-get_auth"><strong>get_auth</strong></a>()</dt><dd><span class="code">Return&nbsp;a&nbsp;(username,&nbsp;password)&nbsp;tuple&nbsp;suitable&nbsp;for&nbsp;requests'&nbsp;`auth=`&nbsp;kwarg,&nbsp;or&nbsp;None.<br>
&nbsp;<br>
Returns&nbsp;None&nbsp;when&nbsp;no&nbsp;credentials&nbsp;are&nbsp;configured,&nbsp;signaling&nbsp;callers&nbsp;to&nbsp;use<br>
the&nbsp;public&nbsp;Data&nbsp;Repository&nbsp;fallback&nbsp;instead&nbsp;of&nbsp;the&nbsp;live&nbsp;API.</span></dd></dl>
<dl><dt><a name="-get_credentials"><strong>get_credentials</strong></a>()</dt><dd><span class="code">Return&nbsp;(username,&nbsp;password)&nbsp;from&nbsp;the&nbsp;environment,&nbsp;or&nbsp;(None,&nbsp;None)&nbsp;if&nbsp;unset.</span></dd></dl>
<dl><dt><a name="-has_live_credentials"><strong>has_live_credentials</strong></a>()</dt><dd><span class="code">Return&nbsp;True&nbsp;if&nbsp;both&nbsp;MOVEBANK_USERNAME&nbsp;and&nbsp;MOVEBANK_PASSWORD&nbsp;are&nbsp;set&nbsp;and&nbsp;non-empty.</span></dd></dl>
</td></tr></table>
</body></html>