Incremented version number

This commit is contained in:
Mike Young
2020-01-01 09:55:47 -05:00
parent 16aab465b7
commit 964e8dc20a
57 changed files with 4988 additions and 776 deletions

View File

@@ -0,0 +1,220 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.storage.Storage Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">pyShelf Open Source Ebook Server
&#160;<span id="projectnumber">0.4.0</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>lib</b></li><li class="navelem"><b>storage</b></li><li class="navelem"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html">Storage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">src.backend.lib.storage.Storage Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0ed6b941570b53aa8666104204fdd3b6"><td class="memItemLeft" align="right" valign="top"><a id="a0ed6b941570b53aa8666104204fdd3b6"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, config)</td></tr>
<tr class="separator:a0ed6b941570b53aa8666104204fdd3b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41c3c4f5708364ac134cef63fe54c221"><td class="memItemLeft" align="right" valign="top"><a id="a41c3c4f5708364ac134cef63fe54c221"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>check_ownership</b> (self, table=None)</td></tr>
<tr class="separator:a41c3c4f5708364ac134cef63fe54c221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0fdacb661febbfa3cba95e578ad2112"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html#ae0fdacb661febbfa3cba95e578ad2112">create_tables</a> (self)</td></tr>
<tr class="separator:ae0fdacb661febbfa3cba95e578ad2112"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a912a5030c1277bb9b635eb4bb5c97c40"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html#a912a5030c1277bb9b635eb4bb5c97c40">insert_book</a> (self, book)</td></tr>
<tr class="separator:a912a5030c1277bb9b635eb4bb5c97c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5c8e584946dd5e4ff6e9b1379bc3c6b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html#aa5c8e584946dd5e4ff6e9b1379bc3c6b">book_paths_list</a> (self)</td></tr>
<tr class="separator:aa5c8e584946dd5e4ff6e9b1379bc3c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a394cfed178f5fd150ed5f1bca13dfc05"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html#a394cfed178f5fd150ed5f1bca13dfc05">commit</a> (self)</td></tr>
<tr class="separator:a394cfed178f5fd150ed5f1bca13dfc05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a112f9b3fbb18b9475fdeba6245d90fdf"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html#a112f9b3fbb18b9475fdeba6245d90fdf">close</a> (self)</td></tr>
<tr class="separator:a112f9b3fbb18b9475fdeba6245d90fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a590a49f74a9d7afac613ee447e8056d7"><td class="memItemLeft" align="right" valign="top"><a id="a590a49f74a9d7afac613ee447e8056d7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sql</b></td></tr>
<tr class="separator:a590a49f74a9d7afac613ee447e8056d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8163ce045eb3cf6e2ac26797ec712b7d"><td class="memItemLeft" align="right" valign="top"><a id="a8163ce045eb3cf6e2ac26797ec712b7d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>user</b></td></tr>
<tr class="separator:a8163ce045eb3cf6e2ac26797ec712b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dd09d87e35603506a37b61a68c98d43"><td class="memItemLeft" align="right" valign="top"><a id="a5dd09d87e35603506a37b61a68c98d43"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>password</b></td></tr>
<tr class="separator:a5dd09d87e35603506a37b61a68c98d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1f7326b0de7f089d60564af42311aa1"><td class="memItemLeft" align="right" valign="top"><a id="aa1f7326b0de7f089d60564af42311aa1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_host</b></td></tr>
<tr class="separator:aa1f7326b0de7f089d60564af42311aa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26ddd4bc23e668c5cba6473366e1e107"><td class="memItemLeft" align="right" valign="top"><a id="a26ddd4bc23e668c5cba6473366e1e107"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_port</b></td></tr>
<tr class="separator:a26ddd4bc23e668c5cba6473366e1e107"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acaa876b609e0c23b0433b7fad92fcdde"><td class="memItemLeft" align="right" valign="top"><a id="acaa876b609e0c23b0433b7fad92fcdde"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db</b></td></tr>
<tr class="separator:acaa876b609e0c23b0433b7fad92fcdde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a289524152eea2c6f87ebe75b57702f8e"><td class="memItemLeft" align="right" valign="top"><a id="a289524152eea2c6f87ebe75b57702f8e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>config</b></td></tr>
<tr class="separator:a289524152eea2c6f87ebe75b57702f8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26daf3e02f41856cbab2c4a0a2ac392c"><td class="memItemLeft" align="right" valign="top"><a id="a26daf3e02f41856cbab2c4a0a2ac392c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>cursor</b></td></tr>
<tr class="separator:a26daf3e02f41856cbab2c4a0a2ac392c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">Contains all methods for system storage</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa5c8e584946dd5e4ff6e9b1379bc3c6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5c8e584946dd5e4ff6e9b1379bc3c6b">&#9670;&nbsp;</a></span>book_paths_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.storage.Storage.book_paths_list </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Get file paths from database for comparison to system files
</pre>
</div>
</div>
<a id="a112f9b3fbb18b9475fdeba6245d90fdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a112f9b3fbb18b9475fdeba6245d90fdf">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.storage.Storage.close </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Close database connection
</pre>
</div>
</div>
<a id="a394cfed178f5fd150ed5f1bca13dfc05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394cfed178f5fd150ed5f1bca13dfc05">&#9670;&nbsp;</a></span>commit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.storage.Storage.commit </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Commit database transactions
</pre>
</div>
</div>
<a id="ae0fdacb661febbfa3cba95e578ad2112"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0fdacb661febbfa3cba95e578ad2112">&#9670;&nbsp;</a></span>create_tables()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.storage.Storage.create_tables </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Create table structure</pre>
</div>
</div>
<a id="a912a5030c1277bb9b635eb4bb5c97c40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a912a5030c1277bb9b635eb4bb5c97c40">&#9670;&nbsp;</a></span>insert_book()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.storage.Storage.insert_book </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>book</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Insert book in database
:returns: True if succeeds False if not
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/lib/<a class="el" href="../../">storage.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>