beerbuddy/flask/documentation.html

38 lines
No EOL
3.5 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Python: module backend</title>
</head><body>
<table class="heading">
<tr class="heading-text decor">
<td class="title">&nbsp;<br><strong class="title">backend</strong></td>
<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="-fetchItem"><strong>fetchItem</strong></a>(store)</dt><dd><span class="code">Fetch&nbsp;an&nbsp;item&nbsp;from&nbsp;given&nbsp;store&nbsp;that&nbsp;matches&nbsp;request&nbsp;arguments</span></dd></dl>
<dl><dt><a name="-fetchItems"><strong>fetchItems</strong></a>(store)</dt><dd><span class="code">Fetch&nbsp;all&nbsp;items&nbsp;from&nbsp;a&nbsp;given&nbsp;store</span></dd></dl>
<dl><dt><a name="-fetchStore"><strong>fetchStore</strong></a>(key=None)</dt><dd><span class="code">Fetch&nbsp;a&nbsp;store&nbsp;with&nbsp;the&nbsp;given&nbsp;key.&nbsp;If&nbsp;no&nbsp;key&nbsp;is&nbsp;provided,&nbsp;fetch&nbsp;store&nbsp;based&nbsp;on&nbsp;location&nbsp;data&nbsp;in&nbsp;request&nbsp;arguments</span></dd></dl>
<dl><dt><a name="-get"><strong>get</strong></a>()</dt><dd><span class="code">Returns&nbsp;store&nbsp;based&nbsp;on&nbsp;request&nbsp;arguments.&nbsp;If&nbsp;no&nbsp;arguments&nbsp;are&nbsp;provided,&nbsp;returns&nbsp;all&nbsp;stores&nbsp;in&nbsp;database</span></dd></dl>
<dl><dt><a name="-getImage"><strong>getImage</strong></a>()</dt><dd><span class="code">Returns&nbsp;store&nbsp;image&nbsp;based&nbsp;on&nbsp;image&nbsp;key&nbsp;provided&nbsp;in&nbsp;request&nbsp;arguments</span></dd></dl>
<dl><dt><a name="-post"><strong>post</strong></a>()</dt><dd><span class="code">Adds&nbsp;a&nbsp;store&nbsp;or&nbsp;item&nbsp;to&nbsp;the&nbsp;database&nbsp;depending&nbsp;on&nbsp;request&nbsp;arguments</span></dd></dl>
<dl><dt><a name="-put"><strong>put</strong></a>()</dt><dd><span class="code">Updates&nbsp;item&nbsp;or&nbsp;store&nbsp;picture&nbsp;depending&nbsp;on&nbsp;request&nbsp;arguments</span></dd></dl>
<dl><dt><a name="-search"><strong>search</strong></a>()</dt><dd><span class="code">Returns&nbsp;items&nbsp;matching&nbsp;query&nbsp;string&nbsp;in&nbsp;searchable&nbsp;radius&nbsp;(currently&nbsp;50mi/80km)</span></dd></dl>
<dl><dt><a name="-updateCheapest"><strong>updateCheapest</strong></a>(item, store)</dt><dd><span class="code">Compare&nbsp;price&nbsp;of&nbsp;current&nbsp;item&nbsp;to&nbsp;other&nbsp;items&nbsp;in&nbsp;the&nbsp;given&nbsp;store&nbsp;and&nbsp;update&nbsp;store's&nbsp;cheapest&nbsp;item&nbsp;if&nbsp;this&nbsp;item&nbsp;is&nbsp;cheaper&nbsp;than&nbsp;the&nbsp;others</span></dd></dl>
</td></tr></table><p>
<table class="section">
<tr class="decor data-decor heading-text">
<td class="section-title" colspan=3>&nbsp;<br><strong class="bigsection">Data</strong></td></tr>
<tr><td class="decor data-decor"><span class="code">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td><td>&nbsp;</td>
<td class="singlecolumn"><strong>RADIUS</strong> = 80000<br>
<strong>app</strong> = &lt;Flask 'backend'&gt;<br>
<strong>deta</strong> = &lt;deta.Deta object&gt;<br>
<strong>drive</strong> = &lt;deta.drive._Drive object&gt;<br>
<strong>itemsDB</strong> = &lt;deta.base._Base object&gt;<br>
<strong>request</strong> = &lt;LocalProxy unbound&gt;<br>
<strong>storesDB</strong> = &lt;deta.base._Base object&gt;</td></tr></table>
</body></html>