th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Versioning

Browse Source
This commit is contained in:
th3r00t
2020-02-02 08:13:32 -05:00
parent 19706668d2
commit 5a0c19128e
99 changed files with 472 additions and 4316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/html/HTML/D/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

0
docs/html/HTML/FILEMAP vendored
View File

1
docs/html/HTML/GTAGSROOT vendored
View File

@@ -1 +0,0 @@
/home/raelon/Projects/pyShelf/src/backend

1
docs/html/HTML/I/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

1
docs/html/HTML/J/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

1
docs/html/HTML/R/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

1
docs/html/HTML/S/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

1
docs/html/HTML/Y/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

13
docs/html/HTML/defines.html vendored
View File

@@ -1,13 +0,0 @@
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>DEFINITIONS</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.3' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='style.css' />
</head>
<body>
<h2 class='header'>DEFINITIONS</h2>
</body>
</html>

1
docs/html/HTML/defines/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

15
docs/html/HTML/files.html vendored
View File

@@ -1,15 +0,0 @@
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>FILES</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.3' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='style.css' />
</head>
<body>
<h2 class='header'><a href='files.html'>FILES</a></h2>
<ol>
</ol>
</body>
</html>

1
docs/html/HTML/files/index.html vendored
View File

@@ -1 +0,0 @@
<html xmlns='http://www.w3.org/1999/xhtml'></html>

24
docs/html/HTML/help.html vendored
View File

@@ -1,24 +0,0 @@
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>HELP</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.3' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='style.css' />
</head>
<body>
<h2 class='header'>Usage of Links</h2>
<pre>/* [&lt;][&gt;][^][v][top][bottom][index][help] */</pre>
<dl>
<dt>[&lt;]</dt><dd>Previous definition.</dd>
<dt>[&gt;]</dt><dd>Next definition.</dd>
<dt>[^]</dt><dd>First definition in this file.</dd>
<dt>[v]</dt><dd>Last definition in this file.</dd>
<dt>[top]</dt><dd>Top of this file.</dd>
<dt>[bottom]</dt><dd>Bottom of this file.</dd>
<dt>[index]</dt><dd>Return to index page.</dd>
<dt>[help]</dt><dd>You are seeing now.</dd>
</dl>
</body>
</html>

28
docs/html/HTML/index.html vendored
View File

@@ -1,28 +0,0 @@
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pyShelf Open Source Ebook Server-0.4.0</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.3' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='style.css' />
</head>
<body>
<h1 class='title'>pyShelf Open Source Ebook Server-0.4.0</h1>
<div class='poweredby'>
Last updated Wed Jan 01 09:54:41 EST 2020<br />
Powered by <a href='http://www.gnu.org/software/global/' title='Go to the GLOBAL project page.'>GLOBAL-6.6.3</a>.<br />
</div>
<hr />
<h2 class='header'>MAINS</h2>
<pre>
</pre>
<hr />
<h2 class='header'>DEFINITIONS</h2>
<hr />
<h2 class='header'>FILES</h2>
<ol>
</ol>
<hr />
</body>
</html>

28
docs/html/HTML/mains.html vendored
View File

@@ -1,28 +0,0 @@
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pyShelf Open Source Ebook Server-0.4.0</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.6.3' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='style.css' />
</head>
<body>
<h1 class='title'>pyShelf Open Source Ebook Server-0.4.0</h1>
<div class='poweredby'>
Last updated Wed Jan 01 09:54:41 EST 2020<br />
Powered by <a href='http://www.gnu.org/software/global/' title='Go to the GLOBAL project page.'>GLOBAL-6.6.3</a>.<br />
</div>
<hr />
<h2 class='header'>MAINS</h2>
<pre>
</pre>
<hr />
<h2 class='header'>DEFINITIONS</h2>
<hr />
<h2 class='header'>FILES</h2>
<ol>
</ol>
<hr />
</body>
</html>

8
docs/html/HTML/rebuild.sh vendored
View File

@@ -1,8 +0,0 @@
#!/bin/sh
#
# rebuild.sh: rebuild hypertext with the previous context.
#
# Usage:
# % sh rebuild.sh
#
cd /home/raelon/Projects/pyShelf/src/backend && GTAGSCONF=':langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:skip=HTML/,HTML.pub/,tags,TAGS,ID,y.tab.c,y.tab.h,gtags.files,cscope.files,cscope.out,cscope.po.out,cscope.in.out,SCCS/,RCS/,CVS/,CVSROOT/,{arch}/,autom4te.cache/,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*_flymake.*,*_flymake,*.o,*.a,*.so,*.lo,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz,*.min.js,*min.css:' htags -g -s -a -n -v -w -t 'pyShelf Open Source Ebook Server-0.4.0' /home/raelon/Projects/pyShelf/docs/html

77
docs/html/HTML/style.css vendored
View File

@@ -1,77 +0,0 @@
/*
* Copyright (c) 2005, 2010, 2011 Tama Communications Corporation
*
* This file is free software; as a special exception the author gives
* unlimited permission to copy and/or distribute it, with or without
* modifications, as long as this notice is preserved.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/
/*
* Souce code
*/
body { color: #191970; background-color: #f5f5dc; }
a.visited { color: gray; }
.title { color: #cc0000; }
.poweredby { text-align: right; }
.error { color: red; }
.loading { color: white; background-color: red; }
.cvs { font-size: 90%; }
.caution { text-align: center; margin: 1em 40px; }
img.icon { vertical-align: top; border: 0; }
.curline:hover { background-color:lightgray; }
table.flist { border-spacing: 2px; width: 100%; }
/*
* Parts
*/
em { font-style: normal; }
em.comment { color: green; font-style: italic; }
em.sharp { color: #8b0000; }
em.brace { color: red; }
em.warned { background-color: yellow; }
em.string { text-decoration: underline; }
strong.reserved { font-weight: bold; }
/*
* Tag list using table (--table-list)
*/
th, td { white-space: nowrap; }
th.tag { text-align: left; }
th.line { text-align: right; }
th.file { text-align: left; }
th.code { text-align: left; }
td.tag { text-align: left; }
td.line { text-align: right; }
td.file { text-align: left; }
td.code { text-align: left; }
/* end of TAG LIST */
/*
* Fixed guide (--fixed-guide)
*/
#guide {
height: 35px;
position: fixed;
bottom:0px; left:0px; right:0px;
background: #f5f5dc;
border: 1px solid #ccc;
}
#guide ul {
height: 25px;
margin: 5px;
width: 90%;
}
#guide ul li {
float: left;
display: inline;
margin: 1px 1px;
}
#guide a {
line-height: 24px;
}
#guide ul li.standout span {
margin: 0px 4px;
font-size: 115%;
font-weight: bold;
}
/* end of FIXED GUIDE */

10
docs/html/annotated.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -74,9 +74,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/classes.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Class Index</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -82,9 +82,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.display.TerminalDisplay Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -121,9 +121,9 @@ Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

76
docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html vendored
View File

@@ -1,76 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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>config</b></li><li class="navelem"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">Config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.config.Config Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#acc3a283ef348aaf2fc0dbaa4bd1ad3c9">__init__</a>(self, root)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>auto_scan</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>book_path</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>book_shelf</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>catalogue_db</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>db_host</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>db_port</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>file_array</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#a9dbecd1e259e7bd71ab24b55d4093513">open_file</a>(self, _cp)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>password</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>root</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>TITLE</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>user</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>VERSION</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

77
docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html vendored
View File

@@ -1,77 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">Test_Config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.Test_Config Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">pyShelf.src.backend.tests.library_test.Test_Config</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self) (defined in <a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">pyShelf.src.backend.tests.library_test.Test_Config</a>)</td><td class="entry"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">pyShelf.src.backend.tests.library_test.Test_Config</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#acc3a283ef348aaf2fc0dbaa4bd1ad3c9">pyShelf::src::backend::lib::config::Config.__init__</a>(self, root)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>auto_scan</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>book_path</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>book_shelf</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>catalogue_db</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>db_host</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>db_port</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>file_array</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#ae3bfa4633a2bf86c86d40151b56688b8">open_file</a>(self, root=&quot;config.json&quot;)</td><td class="entry"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">pyShelf.src.backend.tests.library_test.Test_Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>password</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>root</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>TITLE</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>user</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>VERSION</b> (defined in <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a>)</td><td class="entry"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">pyShelf.src.backend.lib.config.Config</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

10
docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -56,9 +56,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

214
docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html vendored
View File

@@ -1,214 +0,0 @@
<!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: pyShelf.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.3.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>pyShelf</b></li><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="../../d2/d53/classpyShelf_1_1src_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="../../dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.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:a91cd4a032d59e27f251602767663ba8c"><td class="memItemLeft" align="right" valign="top"><a id="a91cd4a032d59e27f251602767663ba8c"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, db_pointer, config)</td></tr>
<tr class="separator:a91cd4a032d59e27f251602767663ba8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7532f4b2a2af0f7100253642f8af4597"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a7532f4b2a2af0f7100253642f8af4597">create_tables</a> (self)</td></tr>
<tr class="separator:a7532f4b2a2af0f7100253642f8af4597"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad08ae5682a3e3e66658eee723084fe2a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#ad08ae5682a3e3e66658eee723084fe2a">insert_book</a> (self, book)</td></tr>
<tr class="separator:ad08ae5682a3e3e66658eee723084fe2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a27348bc85856956bade10ec39d51b77e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a27348bc85856956bade10ec39d51b77e">book_paths_list</a> (self)</td></tr>
<tr class="separator:a27348bc85856956bade10ec39d51b77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92c651d41e130c97e73703eb608c82c4"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a92c651d41e130c97e73703eb608c82c4">commit</a> (self)</td></tr>
<tr class="separator:a92c651d41e130c97e73703eb608c82c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea7868ca9c943e107e2454871c730555"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#aea7868ca9c943e107e2454871c730555">close</a> (self)</td></tr>
<tr class="separator:aea7868ca9c943e107e2454871c730555"><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:a75fe7e19d117f581ab9c64e8c8222117"><td class="memItemLeft" align="right" valign="top"><a id="a75fe7e19d117f581ab9c64e8c8222117"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>sql</b></td></tr>
<tr class="separator:a75fe7e19d117f581ab9c64e8c8222117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d5ef3dbb0c2098218ef827c1f802d95"><td class="memItemLeft" align="right" valign="top"><a id="a0d5ef3dbb0c2098218ef827c1f802d95"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>user</b></td></tr>
<tr class="separator:a0d5ef3dbb0c2098218ef827c1f802d95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b6ec6036bc242c1071bf5a7e5bb9a2f"><td class="memItemLeft" align="right" valign="top"><a id="a8b6ec6036bc242c1071bf5a7e5bb9a2f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>password</b></td></tr>
<tr class="separator:a8b6ec6036bc242c1071bf5a7e5bb9a2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ec30ede190deb5ac506353296ee1688"><td class="memItemLeft" align="right" valign="top"><a id="a7ec30ede190deb5ac506353296ee1688"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_host</b></td></tr>
<tr class="separator:a7ec30ede190deb5ac506353296ee1688"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ebe78f76f168a704bfc1db557498dbc"><td class="memItemLeft" align="right" valign="top"><a id="a5ebe78f76f168a704bfc1db557498dbc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_port</b></td></tr>
<tr class="separator:a5ebe78f76f168a704bfc1db557498dbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae09691f51c6080036606130d45e342e8"><td class="memItemLeft" align="right" valign="top"><a id="ae09691f51c6080036606130d45e342e8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db</b></td></tr>
<tr class="separator:ae09691f51c6080036606130d45e342e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c6f8923f7accceb114495cb783a3216"><td class="memItemLeft" align="right" valign="top"><a id="a1c6f8923f7accceb114495cb783a3216"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>cursor</b></td></tr>
<tr class="separator:a1c6f8923f7accceb114495cb783a3216"><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="a27348bc85856956bade10ec39d51b77e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a27348bc85856956bade10ec39d51b77e">&#9670;&nbsp;</a></span>book_paths_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.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="aea7868ca9c943e107e2454871c730555"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7868ca9c943e107e2454871c730555">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.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="a92c651d41e130c97e73703eb608c82c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92c651d41e130c97e73703eb608c82c4">&#9670;&nbsp;</a></span>commit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.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="a7532f4b2a2af0f7100253642f8af4597"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7532f4b2a2af0f7100253642f8af4597">&#9670;&nbsp;</a></span>create_tables()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.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="ad08ae5682a3e3e66658eee723084fe2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad08ae5682a3e3e66658eee723084fe2a">&#9670;&nbsp;</a></span>insert_book()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.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 Sun Dec 15 2019 12:54:07 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>

206
docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html vendored
View File

@@ -1,206 +0,0 @@
<!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: pyShelf.src.backend.lib.pyShelf.BookDisplay 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.3.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>pyShelf</b></li><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>pyShelf</b></li><li class="navelem"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">BookDisplay</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="../../dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.pyShelf.BookDisplay 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:a0498af17fbd47db504acada242b14fad"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a0498af17fbd47db504acada242b14fad">__init__</a> (self, **kwargs)</td></tr>
<tr class="separator:a0498af17fbd47db504acada242b14fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a6ed64b1b2f5de6d4b3b21674d61ce2"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a7a6ed64b1b2f5de6d4b3b21674d61ce2">nextPage</a> (self)</td></tr>
<tr class="separator:a7a6ed64b1b2f5de6d4b3b21674d61ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a614c79a2ed8f5c5b0f184858dfebc71e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a614c79a2ed8f5c5b0f184858dfebc71e">previousPage</a> (self)</td></tr>
<tr class="separator:a614c79a2ed8f5c5b0f184858dfebc71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac41a7eaf5b19bc7fcbd37c3a82fbcfc9"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#ac41a7eaf5b19bc7fcbd37c3a82fbcfc9">booksPerPage</a> (self, screen_size)</td></tr>
<tr class="separator:ac41a7eaf5b19bc7fcbd37c3a82fbcfc9"><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:a55b877b6e4829d5d0f78b04d387c0dc1"><td class="memItemLeft" align="right" valign="top"><a id="a55b877b6e4829d5d0f78b04d387c0dc1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>books_per_page</b></td></tr>
<tr class="separator:a55b877b6e4829d5d0f78b04d387c0dc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16bb6fea5df0b3b8a23869a2b241bf88"><td class="memItemLeft" align="right" valign="top"><a id="a16bb6fea5df0b3b8a23869a2b241bf88"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>current_page</b></td></tr>
<tr class="separator:a16bb6fea5df0b3b8a23869a2b241bf88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fc686651865b7185e783c4e98c0dac9"><td class="memItemLeft" align="right" valign="top"><a id="a2fc686651865b7185e783c4e98c0dac9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>thumbnail_size</b></td></tr>
<tr class="separator:a2fc686651865b7185e783c4e98c0dac9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa75542dcf41aa0bd5fedc1c59aaa4c55"><td class="memItemLeft" align="right" valign="top"><a id="aa75542dcf41aa0bd5fedc1c59aaa4c55"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>thumbnail_scale</b></td></tr>
<tr class="separator:aa75542dcf41aa0bd5fedc1c59aaa4c55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a036a667c977eb35eb659ca570d1b5c28"><td class="memItemLeft" align="right" valign="top"><a id="a036a667c977eb35eb659ca570d1b5c28"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>total_pages</b></td></tr>
<tr class="separator:a036a667c977eb35eb659ca570d1b5c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e5a5d1040bdef41c3e0f479bdc0ce5b"><td class="memItemLeft" align="right" valign="top"><a id="a9e5a5d1040bdef41c3e0f479bdc0ce5b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>screen_size</b></td></tr>
<tr class="separator:a9e5a5d1040bdef41c3e0f479bdc0ce5b"><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">All functions related to displaying book information in the HTML UI</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0498af17fbd47db504acada242b14fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0498af17fbd47db504acada242b14fad">&#9670;&nbsp;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.pyShelf.BookDisplay.__init__ </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>kwargs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initialize class variables
:return: None
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac41a7eaf5b19bc7fcbd37c3a82fbcfc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac41a7eaf5b19bc7fcbd37c3a82fbcfc9">&#9670;&nbsp;</a></span>booksPerPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.pyShelf.BookDisplay.booksPerPage </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>screen_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">## TODO Remove me
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
</pre>
</div>
</div>
<a id="a7a6ed64b1b2f5de6d4b3b21674d61ce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a6ed64b1b2f5de6d4b3b21674d61ce2">&#9670;&nbsp;</a></span>nextPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.pyShelf.BookDisplay.nextPage </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">## TODO Remove me
Goto next book page
:return: new current_page
</pre>
</div>
</div>
<a id="a614c79a2ed8f5c5b0f184858dfebc71e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a614c79a2ed8f5c5b0f184858dfebc71e">&#9670;&nbsp;</a></span>previousPage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage </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">## TODO Remove me
Goto previous book page
:return: new current_page
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/lib/<a class="el" href="../../">pyShelf.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

12
docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.tests.library_test.Test_Config Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -148,7 +148,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens config.json and reads in configuration options
</pre>
</pre>
<p>Reimplemented from <a class="el" href="../../d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html#a2a99caf1885585c5baeacad038272fdb">src.backend.lib.config.Config</a>.</p>
</div>
@@ -159,9 +159,9 @@ Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d3/d4a/classsrc_1_1backend_1_1lib_1_1config_1_1Config-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -71,9 +71,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d3/d95/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -57,9 +57,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -71,9 +71,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

407
docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html vendored
View File

@@ -1,407 +0,0 @@
<!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: pyShelf.src.backend.lib.library.Catalogue 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.3.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>pyShelf</b></li><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>library</b></li><li class="navelem"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">Catalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.library.Catalogue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Inheritance diagram for pyShelf.src.backend.lib.library.Catalogue:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png" usemap="#pyShelf.src.backend.lib.library.Catalogue_map" alt=""/>
<map id="pyShelf.src.backend.lib.library.Catalogue_map" name="pyShelf.src.backend.lib.library.Catalogue_map">
<area href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html" alt="pyShelf.src.backend.tests.library_test.Test_Catalogue" shape="rect" coords="0,56,316,80"/>
</map>
</div></div>
<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:a4c31e22a5646223f0964c560d5b4eb28"><td class="memItemLeft" align="right" valign="top"><a id="a4c31e22a5646223f0964c560d5b4eb28"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, config)</td></tr>
<tr class="separator:a4c31e22a5646223f0964c560d5b4eb28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a18784d69536167a50258ce9b1737b1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a5a18784d69536167a50258ce9b1737b1">scan_folder</a> (self, _path=None)</td></tr>
<tr class="separator:a5a18784d69536167a50258ce9b1737b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4ba5b4c097789855ded4e7cb05ee0db"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#ab4ba5b4c097789855ded4e7cb05ee0db">filter_books</a> (self)</td></tr>
<tr class="separator:ab4ba5b4c097789855ded4e7cb05ee0db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97f42f90efb06225637e28555b37ca01"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a97f42f90efb06225637e28555b37ca01">extract_metadata</a> (self, book)</td></tr>
<tr class="separator:a97f42f90efb06225637e28555b37ca01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa292917545d1569ddb8caf65577a8a57"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aa292917545d1569ddb8caf65577a8a57">extract_content</a> (self, book_zip, book)</td></tr>
<tr class="separator:aa292917545d1569ddb8caf65577a8a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c306bfe05990039b81731992b6f31d6"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a4c306bfe05990039b81731992b6f31d6">extract_cover_html</a> (self, book_zip, book)</td></tr>
<tr class="separator:a4c306bfe05990039b81731992b6f31d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeffa733c446b5a367a4225d6a6b5a1e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abeffa733c446b5a367a4225d6a6b5a1e">extract_cover_image</a> (self, book_zip, book)</td></tr>
<tr class="separator:abeffa733c446b5a367a4225d6a6b5a1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1463e646d864f5ee4710bec71990995a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a1463e646d864f5ee4710bec71990995a">compare_shelf_current</a> (self)</td></tr>
<tr class="separator:a1463e646d864f5ee4710bec71990995a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10be990c40894e3ec45b475e2d89fe96"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a10be990c40894e3ec45b475e2d89fe96">import_books</a> (self, list=None)</td></tr>
<tr class="separator:a10be990c40894e3ec45b475e2d89fe96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a84b765167953466756502d0071c69331"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a84b765167953466756502d0071c69331">process_book</a> (book)</td></tr>
<tr class="separator:a84b765167953466756502d0071c69331"><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:a1f3ebef642b34188c7ad49cff076db55"><td class="memItemLeft" align="right" valign="top"><a id="a1f3ebef642b34188c7ad49cff076db55"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>file_list</b></td></tr>
<tr class="separator:a1f3ebef642b34188c7ad49cff076db55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b23b2c4bfa2d4bb2e2b369cbf8833f9"><td class="memItemLeft" align="right" valign="top"><a id="a2b23b2c4bfa2d4bb2e2b369cbf8833f9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>opf_regx</b></td></tr>
<tr class="separator:a2b23b2c4bfa2d4bb2e2b369cbf8833f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbffe01e963e4ece27a608da5fb49e32"><td class="memItemLeft" align="right" valign="top"><a id="acbffe01e963e4ece27a608da5fb49e32"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>cover_regx</b></td></tr>
<tr class="separator:acbffe01e963e4ece27a608da5fb49e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2891f397d927169a8650847f615d402"><td class="memItemLeft" align="right" valign="top"><a id="ad2891f397d927169a8650847f615d402"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>html_regx</b></td></tr>
<tr class="separator:ad2891f397d927169a8650847f615d402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b3da5a79b942fb03f151d65c673a8f"><td class="memItemLeft" align="right" valign="top"><a id="ac8b3da5a79b942fb03f151d65c673a8f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root_dir</b></td></tr>
<tr class="separator:ac8b3da5a79b942fb03f151d65c673a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a519afd6144e843d57172d7aad5020919"><td class="memItemLeft" align="right" valign="top"><a id="a519afd6144e843d57172d7aad5020919"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_folder</b></td></tr>
<tr class="separator:a519afd6144e843d57172d7aad5020919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04708cf94a0d4391d125b932200b9a79"><td class="memItemLeft" align="right" valign="top"><a id="a04708cf94a0d4391d125b932200b9a79"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_shelf</b></td></tr>
<tr class="separator:a04708cf94a0d4391d125b932200b9a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a159ee5951ae71faeae71a52b662f502c"><td class="memItemLeft" align="right" valign="top"><a id="a159ee5951ae71faeae71a52b662f502c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>books</b></td></tr>
<tr class="separator:a159ee5951ae71faeae71a52b662f502c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1064beb1ffc07daf754eab4ca59d2575"><td class="memItemLeft" align="right" valign="top"><a id="a1064beb1ffc07daf754eab4ca59d2575"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_pointer</b></td></tr>
<tr class="separator:a1064beb1ffc07daf754eab4ca59d2575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a603e0c7f6f867b54cb8255c2b0bb650b"><td class="memItemLeft" align="right" valign="top"><a id="a603e0c7f6f867b54cb8255c2b0bb650b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>config</b></td></tr>
<tr class="separator:a603e0c7f6f867b54cb8255c2b0bb650b"><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">Decodes book metadata for storage
</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1463e646d864f5ee4710bec71990995a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1463e646d864f5ee4710bec71990995a">&#9670;&nbsp;</a></span>compare_shelf_current()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current </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">Calls storage system, gets list of books stored and compares against files on disk
</pre>
</div>
</div>
<a id="aa292917545d1569ddb8caf65577a8a57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa292917545d1569ddb8caf65577a8a57">&#9670;&nbsp;</a></span>extract_content()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_content </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_zip</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">Opens epub as zip file filters then stores as list any files matching opf_regx
</pre>
</div>
</div>
<a id="a4c306bfe05990039b81731992b6f31d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c306bfe05990039b81731992b6f31d6">&#9670;&nbsp;</a></span>extract_cover_html()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_cover_html </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_zip</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">Opens epub as zip file filters then stores as list any files matching html_regx
</pre>
</div>
</div>
<a id="abeffa733c446b5a367a4225d6a6b5a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeffa733c446b5a367a4225d6a6b5a1e">&#9670;&nbsp;</a></span>extract_cover_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_cover_image </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_zip</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">Opens epub as zip file filters then stores as list any files matching cover_regx
</pre>
</div>
</div>
<a id="a97f42f90efb06225637e28555b37ca01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97f42f90efb06225637e28555b37ca01">&#9670;&nbsp;</a></span>extract_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_metadata </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">Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
</pre>
</div>
</div>
<a id="ab4ba5b4c097789855ded4e7cb05ee0db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4ba5b4c097789855ded4e7cb05ee0db">&#9670;&nbsp;</a></span>filter_books()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.filter_books </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">Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
</pre>
<p>Reimplemented in <a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html#aa2a6c936f7902c6e9287f551fa274edf">pyShelf.src.backend.tests.library_test.Test_Catalogue</a>.</p>
</div>
</div>
<a id="a10be990c40894e3ec45b475e2d89fe96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10be990c40894e3ec45b475e2d89fe96">&#9670;&nbsp;</a></span>import_books()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.import_books </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>list</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
</pre>
</div>
</div>
<a id="a84b765167953466756502d0071c69331"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84b765167953466756502d0071c69331">&#9670;&nbsp;</a></span>process_book()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.process_book </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>book</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return dictionary of epub file contents</pre>
</div>
</div>
<a id="a5a18784d69536167a50258ce9b1737b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a18784d69536167a50258ce9b1737b1">&#9670;&nbsp;</a></span>scan_folder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.scan_folder </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>_path</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Scan folder by _path, allows recurisive scanning
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/lib/<a class="el" href="../../">library.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

BIN
docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.2 KiB

462
docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html vendored
View File

@@ -1,462 +0,0 @@
<!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: pyShelf.src.backend.tests.library_test.Test_Catalogue 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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">Test_Catalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="../../d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Catalogue:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png" usemap="#pyShelf.src.backend.tests.library_5Ftest.Test_5FCatalogue_map" alt=""/>
<map id="pyShelf.src.backend.tests.library_5Ftest.Test_5FCatalogue_map" name="pyShelf.src.backend.tests.library_5Ftest.Test_5FCatalogue_map">
<area href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html" alt="pyShelf.src.backend.lib.library.Catalogue" shape="rect" coords="0,0,316,24"/>
</map>
</div></div>
<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:a1efda7a2db594af425f24b186f7a39b0"><td class="memItemLeft" align="right" valign="top"><a id="a1efda7a2db594af425f24b186f7a39b0"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</td></tr>
<tr class="separator:a1efda7a2db594af425f24b186f7a39b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2a6c936f7902c6e9287f551fa274edf"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html#aa2a6c936f7902c6e9287f551fa274edf">filter_books</a> (self)</td></tr>
<tr class="separator:aa2a6c936f7902c6e9287f551fa274edf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a18784d69536167a50258ce9b1737b1"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a5a18784d69536167a50258ce9b1737b1">scan_folder</a> (self, _path=None)</td></tr>
<tr class="separator:a5a18784d69536167a50258ce9b1737b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97f42f90efb06225637e28555b37ca01"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a97f42f90efb06225637e28555b37ca01">extract_metadata</a> (self, book)</td></tr>
<tr class="separator:a97f42f90efb06225637e28555b37ca01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa292917545d1569ddb8caf65577a8a57"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aa292917545d1569ddb8caf65577a8a57">extract_content</a> (self, book_zip, book)</td></tr>
<tr class="separator:aa292917545d1569ddb8caf65577a8a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c306bfe05990039b81731992b6f31d6"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a4c306bfe05990039b81731992b6f31d6">extract_cover_html</a> (self, book_zip, book)</td></tr>
<tr class="separator:a4c306bfe05990039b81731992b6f31d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeffa733c446b5a367a4225d6a6b5a1e"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abeffa733c446b5a367a4225d6a6b5a1e">extract_cover_image</a> (self, book_zip, book)</td></tr>
<tr class="separator:abeffa733c446b5a367a4225d6a6b5a1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1463e646d864f5ee4710bec71990995a"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a1463e646d864f5ee4710bec71990995a">compare_shelf_current</a> (self)</td></tr>
<tr class="separator:a1463e646d864f5ee4710bec71990995a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10be990c40894e3ec45b475e2d89fe96"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a10be990c40894e3ec45b475e2d89fe96">import_books</a> (self, list=None)</td></tr>
<tr class="separator:a10be990c40894e3ec45b475e2d89fe96"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a84b765167953466756502d0071c69331"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a84b765167953466756502d0071c69331">process_book</a> (book)</td></tr>
<tr class="separator:a84b765167953466756502d0071c69331"><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:afc2ac20fb58c372546c69df0e5556a5d"><td class="memItemLeft" align="right" valign="top"><a id="afc2ac20fb58c372546c69df0e5556a5d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_shelf</b></td></tr>
<tr class="separator:afc2ac20fb58c372546c69df0e5556a5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f3ebef642b34188c7ad49cff076db55"><td class="memItemLeft" align="right" valign="top"><a id="a1f3ebef642b34188c7ad49cff076db55"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>file_list</b></td></tr>
<tr class="separator:a1f3ebef642b34188c7ad49cff076db55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b23b2c4bfa2d4bb2e2b369cbf8833f9"><td class="memItemLeft" align="right" valign="top"><a id="a2b23b2c4bfa2d4bb2e2b369cbf8833f9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>opf_regx</b></td></tr>
<tr class="separator:a2b23b2c4bfa2d4bb2e2b369cbf8833f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbffe01e963e4ece27a608da5fb49e32"><td class="memItemLeft" align="right" valign="top"><a id="acbffe01e963e4ece27a608da5fb49e32"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>cover_regx</b></td></tr>
<tr class="separator:acbffe01e963e4ece27a608da5fb49e32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2891f397d927169a8650847f615d402"><td class="memItemLeft" align="right" valign="top"><a id="ad2891f397d927169a8650847f615d402"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>html_regx</b></td></tr>
<tr class="separator:ad2891f397d927169a8650847f615d402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b3da5a79b942fb03f151d65c673a8f"><td class="memItemLeft" align="right" valign="top"><a id="ac8b3da5a79b942fb03f151d65c673a8f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root_dir</b></td></tr>
<tr class="separator:ac8b3da5a79b942fb03f151d65c673a8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a519afd6144e843d57172d7aad5020919"><td class="memItemLeft" align="right" valign="top"><a id="a519afd6144e843d57172d7aad5020919"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_folder</b></td></tr>
<tr class="separator:a519afd6144e843d57172d7aad5020919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a159ee5951ae71faeae71a52b662f502c"><td class="memItemLeft" align="right" valign="top"><a id="a159ee5951ae71faeae71a52b662f502c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>books</b></td></tr>
<tr class="separator:a159ee5951ae71faeae71a52b662f502c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1064beb1ffc07daf754eab4ca59d2575"><td class="memItemLeft" align="right" valign="top"><a id="a1064beb1ffc07daf754eab4ca59d2575"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_pointer</b></td></tr>
<tr class="separator:a1064beb1ffc07daf754eab4ca59d2575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a603e0c7f6f867b54cb8255c2b0bb650b"><td class="memItemLeft" align="right" valign="top"><a id="a603e0c7f6f867b54cb8255c2b0bb650b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>config</b></td></tr>
<tr class="separator:a603e0c7f6f867b54cb8255c2b0bb650b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1463e646d864f5ee4710bec71990995a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1463e646d864f5ee4710bec71990995a">&#9670;&nbsp;</a></span>compare_shelf_current()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Calls storage system, gets list of books stored and compares against files on disk
</pre>
</div>
</div>
<a id="aa292917545d1569ddb8caf65577a8a57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa292917545d1569ddb8caf65577a8a57">&#9670;&nbsp;</a></span>extract_content()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_content </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_zip</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching opf_regx
</pre>
</div>
</div>
<a id="a4c306bfe05990039b81731992b6f31d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c306bfe05990039b81731992b6f31d6">&#9670;&nbsp;</a></span>extract_cover_html()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_cover_html </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_zip</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching html_regx
</pre>
</div>
</div>
<a id="abeffa733c446b5a367a4225d6a6b5a1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abeffa733c446b5a367a4225d6a6b5a1e">&#9670;&nbsp;</a></span>extract_cover_image()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_cover_image </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_zip</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching cover_regx
</pre>
</div>
</div>
<a id="a97f42f90efb06225637e28555b37ca01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97f42f90efb06225637e28555b37ca01">&#9670;&nbsp;</a></span>extract_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.extract_metadata </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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
</pre>
</div>
</div>
<a id="aa2a6c936f7902c6e9287f551fa274edf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2a6c936f7902c6e9287f551fa274edf">&#9670;&nbsp;</a></span>filter_books()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.tests.library_test.Test_Catalogue.filter_books </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">Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
</pre>
<p>Reimplemented from <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#ab4ba5b4c097789855ded4e7cb05ee0db">pyShelf.src.backend.lib.library.Catalogue</a>.</p>
</div>
</div>
<a id="a10be990c40894e3ec45b475e2d89fe96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10be990c40894e3ec45b475e2d89fe96">&#9670;&nbsp;</a></span>import_books()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.import_books </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>list</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
</pre>
</div>
</div>
<a id="a84b765167953466756502d0071c69331"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84b765167953466756502d0071c69331">&#9670;&nbsp;</a></span>process_book()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.process_book </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>book</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return dictionary of epub file contents</pre>
</div>
</div>
<a id="a5a18784d69536167a50258ce9b1737b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a18784d69536167a50258ce9b1737b1">&#9670;&nbsp;</a></span>scan_folder()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.library.Catalogue.scan_folder </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>_path</em> = <code>None</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Scan folder by _path, allows recurisive scanning
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/tests/<a class="el" href="../../">library_test.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

BIN
docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.2 KiB

65
docs/html/d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html vendored
View File

@@ -1,65 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">TestCatalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.TestCatalogue Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>config</b> (defined in <a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a>)</td><td class="entry"><a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>root</b> (defined in <a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a>)</td><td class="entry"><a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>test_filter_books</b>(self) (defined in <a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a>)</td><td class="entry"><a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">pyShelf.src.backend.tests.library_test.TestCatalogue</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

83
docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html vendored
View File

@@ -1,83 +0,0 @@
<!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: pyShelf.src.backend.tests.library_test.TestCatalogue 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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html">TestCatalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="../../d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.TestCatalogue 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:a65ea548a48e1b220dcb5f43a13d4f95d"><td class="memItemLeft" align="right" valign="top"><a id="a65ea548a48e1b220dcb5f43a13d4f95d"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>test_filter_books</b> (self)</td></tr>
<tr class="separator:a65ea548a48e1b220dcb5f43a13d4f95d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a9aa16463d94be2855e9f4f099b34c7da"><td class="memItemLeft" align="right" valign="top"><a id="a9aa16463d94be2855e9f4f099b34c7da"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root</b> = os.path.abspath(os.path.curdir)</td></tr>
<tr class="separator:a9aa16463d94be2855e9f4f099b34c7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83394261c59140d10be6e558c6f75bdd"><td class="memItemLeft" align="right" valign="top"><a id="a83394261c59140d10be6e558c6f75bdd"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>config</b> = <a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">Test_Config</a>()</td></tr>
<tr class="separator:a83394261c59140d10be6e558c6f75bdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/tests/<a class="el" href="../../">library_test.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

28
docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.library.Catalogue Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -144,7 +144,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Calls storage system, gets list of books stored and compares against files on disk
</pre>
</pre>
</div>
</div>
<a id="a0993bce2b4fe64a46d96a5eba1d5af50"></a>
@@ -179,7 +179,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching opf_regx
</pre>
</pre>
</div>
</div>
<a id="abcf0dc2d816393afbfb07ea9f5c152f9"></a>
@@ -214,7 +214,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching html_regx
</pre>
</pre>
</div>
</div>
<a id="abd1c3b416586faaabb37515705588a89"></a>
@@ -249,7 +249,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching cover_regx
</pre>
</pre>
</div>
</div>
<a id="abab8649249ef71103f314aa29644a739"></a>
@@ -280,7 +280,7 @@ Public Attributes</h2></td></tr>
<pre class="fragment">Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
</pre>
</pre>
</div>
</div>
<a id="a9dec8499f181aee506861142004d002d"></a>
@@ -302,7 +302,7 @@ book['files'] == list of files from self.process_book(book)
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
</pre>
</pre>
<p>Reimplemented in <a class="el" href="../../db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html#ad708c5a24143ca6fb38733f62396ee21">src.backend.tests.library_test.Test_Catalogue</a>.</p>
</div>
@@ -335,7 +335,7 @@ Proceeds to call process_book
<pre class="fragment">Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
</pre>
</pre>
</div>
</div>
<a id="aedf70ab79105f8251d36848fb790fb9f"></a>
@@ -361,7 +361,7 @@ Iterates over list and inserts new books into database.
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return dictionary of epub file contents</pre>
<pre class="fragment">Return dictionary of epub file contents</pre>
</div>
</div>
<a id="a204c5171b7de8ddd199563fd1b252032"></a>
@@ -390,7 +390,7 @@ Iterates over list and inserts new books into database.
</table>
</div><div class="memdoc">
<pre class="fragment">Scan folder by _path, allows recurisive scanning
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -399,9 +399,9 @@ Iterates over list and inserts new books into database.
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -72,9 +72,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d5/dee/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -58,9 +58,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/d6/d20/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -74,9 +74,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

20
docs/html/d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<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"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -117,7 +117,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Get file paths from database for comparison to system files
</pre>
</pre>
</div>
</div>
<a id="a112f9b3fbb18b9475fdeba6245d90fdf"></a>
@@ -136,7 +136,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Close database connection
</pre>
</pre>
</div>
</div>
<a id="a394cfed178f5fd150ed5f1bca13dfc05"></a>
@@ -155,7 +155,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Commit database transactions
</pre>
</pre>
</div>
</div>
<a id="ae0fdacb661febbfa3cba95e578ad2112"></a>
@@ -173,7 +173,7 @@ Public Attributes</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Create table structure</pre>
<pre class="fragment">Create table structure</pre>
</div>
</div>
<a id="a912a5030c1277bb9b635eb4bb5c97c40"></a>
@@ -203,7 +203,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<pre class="fragment">Insert book in database
:returns: True if succeeds False if not
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -212,9 +212,9 @@ Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

158
docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html vendored
View File

@@ -1,158 +0,0 @@
<!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: pyShelf.src.backend.tests.library_test.Test_Config 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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html">Test_Config</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="../../d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.Test_Config Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Config:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png" usemap="#pyShelf.src.backend.tests.library_5Ftest.Test_5FConfig_map" alt=""/>
<map id="pyShelf.src.backend.tests.library_5Ftest.Test_5FConfig_map" name="pyShelf.src.backend.tests.library_5Ftest.Test_5FConfig_map">
<area href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html" alt="pyShelf.src.backend.lib.config.Config" shape="rect" coords="0,0,296,24"/>
</map>
</div></div>
<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:a70f3ba260f8af27a7db86141dc27085e"><td class="memItemLeft" align="right" valign="top"><a id="a70f3ba260f8af27a7db86141dc27085e"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</td></tr>
<tr class="separator:a70f3ba260f8af27a7db86141dc27085e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3bfa4633a2bf86c86d40151b56688b8"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#ae3bfa4633a2bf86c86d40151b56688b8">open_file</a> (self, root=&quot;config.json&quot;)</td></tr>
<tr class="separator:ae3bfa4633a2bf86c86d40151b56688b8"><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:a7454c270924a276016f903e369b829a5"><td class="memItemLeft" align="right" valign="top"><a id="a7454c270924a276016f903e369b829a5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_path</b></td></tr>
<tr class="separator:a7454c270924a276016f903e369b829a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a1fefa92e72aa11ec4438faba2f7feb"><td class="memItemLeft" align="right" valign="top"><a id="a3a1fefa92e72aa11ec4438faba2f7feb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TITLE</b></td></tr>
<tr class="separator:a3a1fefa92e72aa11ec4438faba2f7feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6feb1951a00ca1fc82a70634bacbd558"><td class="memItemLeft" align="right" valign="top"><a id="a6feb1951a00ca1fc82a70634bacbd558"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>VERSION</b></td></tr>
<tr class="separator:a6feb1951a00ca1fc82a70634bacbd558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb4cc0414b96bc1f8868da69b669706"><td class="memItemLeft" align="right" valign="top"><a id="aebb4cc0414b96bc1f8868da69b669706"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_shelf</b></td></tr>
<tr class="separator:aebb4cc0414b96bc1f8868da69b669706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acee8b31f64a0ea29907c0b36b884c8c0"><td class="memItemLeft" align="right" valign="top"><a id="acee8b31f64a0ea29907c0b36b884c8c0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>catalogue_db</b></td></tr>
<tr class="separator:acee8b31f64a0ea29907c0b36b884c8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc37158cf6f6f0c7dc9d5f51e6d9b405"><td class="memItemLeft" align="right" valign="top"><a id="acc37158cf6f6f0c7dc9d5f51e6d9b405"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>user</b></td></tr>
<tr class="separator:acc37158cf6f6f0c7dc9d5f51e6d9b405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a973054b07100dc03a1ecf8f759e8b663"><td class="memItemLeft" align="right" valign="top"><a id="a973054b07100dc03a1ecf8f759e8b663"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>password</b></td></tr>
<tr class="separator:a973054b07100dc03a1ecf8f759e8b663"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01f7ce652a23290596d81e8048ab5bad"><td class="memItemLeft" align="right" valign="top"><a id="a01f7ce652a23290596d81e8048ab5bad"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_host</b></td></tr>
<tr class="separator:a01f7ce652a23290596d81e8048ab5bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8e332f443a740092cfd73bd61d02e36"><td class="memItemLeft" align="right" valign="top"><a id="ad8e332f443a740092cfd73bd61d02e36"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_port</b></td></tr>
<tr class="separator:ad8e332f443a740092cfd73bd61d02e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc103fb3d969e1e6ada5c1d39ec92e21"><td class="memItemLeft" align="right" valign="top"><a id="abc103fb3d969e1e6ada5c1d39ec92e21"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>file_array</b></td></tr>
<tr class="separator:abc103fb3d969e1e6ada5c1d39ec92e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a477a1b22bada1944ba5d8ac5bfca0567"><td class="memItemLeft" align="right" valign="top"><a id="a477a1b22bada1944ba5d8ac5bfca0567"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root</b></td></tr>
<tr class="separator:a477a1b22bada1944ba5d8ac5bfca0567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f39a470c9963035a112acca935b29fc"><td class="memItemLeft" align="right" valign="top"><a id="a9f39a470c9963035a112acca935b29fc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>auto_scan</b></td></tr>
<tr class="separator:a9f39a470c9963035a112acca935b29fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae3bfa4633a2bf86c86d40151b56688b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3bfa4633a2bf86c86d40151b56688b8">&#9670;&nbsp;</a></span>open_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.tests.library_test.Test_Config.open_file </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>_cp</em> = <code>&quot;config.json&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens config.json and reads in configuration options
</pre>
<p>Reimplemented from <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#a9dbecd1e259e7bd71ab24b55d4093513">pyShelf.src.backend.lib.config.Config</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/tests/<a class="el" href="../../">library_test.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

BIN
docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.1 KiB

10
docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -64,9 +64,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

83
docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html vendored
View File

@@ -1,83 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>library_test</b></li><li class="navelem"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">Test_Catalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.library_test.Test_Catalogue Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self) (defined in <a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>__init__</b>(self, config) (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>book_folder</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>book_shelf</b> (defined in <a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>books</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a1463e646d864f5ee4710bec71990995a">compare_shelf_current</a>(self)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>config</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>cover_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>db_pointer</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aa292917545d1569ddb8caf65577a8a57">extract_content</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a4c306bfe05990039b81731992b6f31d6">extract_cover_html</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abeffa733c446b5a367a4225d6a6b5a1e">extract_cover_image</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a97f42f90efb06225637e28555b37ca01">extract_metadata</a>(self, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>file_list</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html#aa2a6c936f7902c6e9287f551fa274edf">filter_books</a>(self)</td><td class="entry"><a class="el" href="../../d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html">pyShelf.src.backend.tests.library_test.Test_Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>html_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a10be990c40894e3ec45b475e2d89fe96">import_books</a>(self, list=None)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>opf_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a84b765167953466756502d0071c69331">process_book</a>(book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>root_dir</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a5a18784d69536167a50258ce9b1737b1">scan_folder</a>(self, _path=None)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

12
docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.api_hooks.DuckDuckGo Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -96,7 +96,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<pre class="fragment">Returns json containing url to image
:param _key: &amp;t=h_&amp;iar=images&amp;iax=images&amp;ia=images&amp;format=json&amp;pretty=1
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -105,9 +105,9 @@ Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

188
docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html vendored
View File

@@ -1,188 +0,0 @@
<!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: pyShelf.src.backend.lib.config.Config 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.3.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>pyShelf</b></li><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>config</b></li><li class="navelem"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">Config</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="../../d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.config.Config Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="../../closed.png" alt="+"/> Inheritance diagram for pyShelf.src.backend.lib.config.Config:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png" usemap="#pyShelf.src.backend.lib.config.Config_map" alt=""/>
<map id="pyShelf.src.backend.lib.config.Config_map" name="pyShelf.src.backend.lib.config.Config_map">
<area href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html" alt="pyShelf.src.backend.tests.library_test.Test_Config" shape="rect" coords="0,56,296,80"/>
</map>
</div></div>
<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:acc3a283ef348aaf2fc0dbaa4bd1ad3c9"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#acc3a283ef348aaf2fc0dbaa4bd1ad3c9">__init__</a> (self, root)</td></tr>
<tr class="separator:acc3a283ef348aaf2fc0dbaa4bd1ad3c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9dbecd1e259e7bd71ab24b55d4093513"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html#a9dbecd1e259e7bd71ab24b55d4093513">open_file</a> (self, _cp)</td></tr>
<tr class="separator:a9dbecd1e259e7bd71ab24b55d4093513"><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:a7454c270924a276016f903e369b829a5"><td class="memItemLeft" align="right" valign="top"><a id="a7454c270924a276016f903e369b829a5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_path</b></td></tr>
<tr class="separator:a7454c270924a276016f903e369b829a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a1fefa92e72aa11ec4438faba2f7feb"><td class="memItemLeft" align="right" valign="top"><a id="a3a1fefa92e72aa11ec4438faba2f7feb"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>TITLE</b></td></tr>
<tr class="separator:a3a1fefa92e72aa11ec4438faba2f7feb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6feb1951a00ca1fc82a70634bacbd558"><td class="memItemLeft" align="right" valign="top"><a id="a6feb1951a00ca1fc82a70634bacbd558"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>VERSION</b></td></tr>
<tr class="separator:a6feb1951a00ca1fc82a70634bacbd558"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb4cc0414b96bc1f8868da69b669706"><td class="memItemLeft" align="right" valign="top"><a id="aebb4cc0414b96bc1f8868da69b669706"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>book_shelf</b></td></tr>
<tr class="separator:aebb4cc0414b96bc1f8868da69b669706"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acee8b31f64a0ea29907c0b36b884c8c0"><td class="memItemLeft" align="right" valign="top"><a id="acee8b31f64a0ea29907c0b36b884c8c0"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>catalogue_db</b></td></tr>
<tr class="separator:acee8b31f64a0ea29907c0b36b884c8c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc37158cf6f6f0c7dc9d5f51e6d9b405"><td class="memItemLeft" align="right" valign="top"><a id="acc37158cf6f6f0c7dc9d5f51e6d9b405"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>user</b></td></tr>
<tr class="separator:acc37158cf6f6f0c7dc9d5f51e6d9b405"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a973054b07100dc03a1ecf8f759e8b663"><td class="memItemLeft" align="right" valign="top"><a id="a973054b07100dc03a1ecf8f759e8b663"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>password</b></td></tr>
<tr class="separator:a973054b07100dc03a1ecf8f759e8b663"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01f7ce652a23290596d81e8048ab5bad"><td class="memItemLeft" align="right" valign="top"><a id="a01f7ce652a23290596d81e8048ab5bad"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_host</b></td></tr>
<tr class="separator:a01f7ce652a23290596d81e8048ab5bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8e332f443a740092cfd73bd61d02e36"><td class="memItemLeft" align="right" valign="top"><a id="ad8e332f443a740092cfd73bd61d02e36"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>db_port</b></td></tr>
<tr class="separator:ad8e332f443a740092cfd73bd61d02e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc103fb3d969e1e6ada5c1d39ec92e21"><td class="memItemLeft" align="right" valign="top"><a id="abc103fb3d969e1e6ada5c1d39ec92e21"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>file_array</b></td></tr>
<tr class="separator:abc103fb3d969e1e6ada5c1d39ec92e21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a477a1b22bada1944ba5d8ac5bfca0567"><td class="memItemLeft" align="right" valign="top"><a id="a477a1b22bada1944ba5d8ac5bfca0567"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root</b></td></tr>
<tr class="separator:a477a1b22bada1944ba5d8ac5bfca0567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f39a470c9963035a112acca935b29fc"><td class="memItemLeft" align="right" valign="top"><a id="a9f39a470c9963035a112acca935b29fc"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>auto_scan</b></td></tr>
<tr class="separator:a9f39a470c9963035a112acca935b29fc"><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">Main System Configuration
</pre> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acc3a283ef348aaf2fc0dbaa4bd1ad3c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc3a283ef348aaf2fc0dbaa4bd1ad3c9">&#9670;&nbsp;</a></span>__init__()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.config.Config.__init__ </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>root</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initialize main configuration options
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9dbecd1e259e7bd71ab24b55d4093513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9dbecd1e259e7bd71ab24b55d4093513">&#9670;&nbsp;</a></span>open_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.config.Config.open_file </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>_cp</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens config.json and reads in configuration options
</pre>
<p>Reimplemented in <a class="el" href="../../d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#ae3bfa4633a2bf86c86d40151b56688b8">pyShelf.src.backend.tests.library_test.Test_Config</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/lib/<a class="el" href="../../">config.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

BIN
docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png vendored
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 1.1 KiB

10
docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.tests.library_test.TestCatalogue Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -75,9 +75,9 @@ Static Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

14
docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.config.Config Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -148,7 +148,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Initialize main configuration options
</pre>
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -178,7 +178,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens config.json and reads in configuration options
</pre>
</pre>
<p>Reimplemented in <a class="el" href="../../d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html#a03e5a6c59bffd93c1e81ddc52a84254f">src.backend.tests.library_test.Test_Config</a>.</p>
</div>
@@ -189,9 +189,9 @@ Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

82
docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html vendored
View File

@@ -1,82 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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>library</b></li><li class="navelem"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">Catalogue</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.library.Catalogue Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self, config) (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>book_folder</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>book_shelf</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>books</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a1463e646d864f5ee4710bec71990995a">compare_shelf_current</a>(self)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>config</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>cover_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>db_pointer</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aa292917545d1569ddb8caf65577a8a57">extract_content</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a4c306bfe05990039b81731992b6f31d6">extract_cover_html</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abeffa733c446b5a367a4225d6a6b5a1e">extract_cover_image</a>(self, book_zip, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a97f42f90efb06225637e28555b37ca01">extract_metadata</a>(self, book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>file_list</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#ab4ba5b4c097789855ded4e7cb05ee0db">filter_books</a>(self)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>html_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a10be990c40894e3ec45b475e2d89fe96">import_books</a>(self, list=None)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>opf_regx</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a84b765167953466756502d0071c69331">process_book</a>(book)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>root_dir</b> (defined in <a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a>)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a5a18784d69536167a50258ce9b1737b1">scan_folder</a>(self, _path=None)</td><td class="entry"><a class="el" href="../../d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html">pyShelf.src.backend.lib.library.Catalogue</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

12
docs/html/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.InitFiles Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -88,7 +88,7 @@ def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, fi
</table>
</div><div class="memdoc">
<pre class="fragment">Checks if file exists and creates it if not
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -97,9 +97,9 @@ def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, fi
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

64
docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html vendored
View File

@@ -1,64 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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>pyShelf</b></li><li class="navelem"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">InitFiles</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.pyShelf.InitFiles Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">pyShelf.src.backend.lib.pyShelf.InitFiles</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self, file_array) (defined in <a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">pyShelf.src.backend.lib.pyShelf.InitFiles</a>)</td><td class="entry"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">pyShelf.src.backend.lib.pyShelf.InitFiles</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html#a614e5bc5f38f75680bba3f1b103c9bb4">CreateFile</a>(self, _pointer)</td><td class="entry"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">pyShelf.src.backend.lib.pyShelf.InitFiles</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

18
docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.BookDisplay Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -114,7 +114,7 @@ Public Attributes</h2></td></tr>
</div><div class="memdoc">
<pre class="fragment">Initialize class variables
:return: None
</pre>
</pre>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
@@ -147,7 +147,7 @@ Public Attributes</h2></td></tr>
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
</pre>
</pre>
</div>
</div>
<a id="a5dd3965776e63d09dfb0f887f88a9582"></a>
@@ -168,7 +168,7 @@ Set books per page
<pre class="fragment">## TODO Remove me
Goto next book page
:return: new current_page
</pre>
</pre>
</div>
</div>
<a id="a59098e1427ae89dba07ea0790dd8e0ed"></a>
@@ -189,7 +189,7 @@ Goto next book page
<pre class="fragment">## TODO Remove me
Goto previous book page
:return: new current_page
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -198,9 +198,9 @@ Goto previous book page
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -69,9 +69,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

28
docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.tests.library_test.Test_Catalogue Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -151,7 +151,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Calls storage system, gets list of books stored and compares against files on disk
</pre>
</pre>
</div>
</div>
<a id="a0993bce2b4fe64a46d96a5eba1d5af50"></a>
@@ -194,7 +194,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching opf_regx
</pre>
</pre>
</div>
</div>
<a id="abcf0dc2d816393afbfb07ea9f5c152f9"></a>
@@ -237,7 +237,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching html_regx
</pre>
</pre>
</div>
</div>
<a id="abd1c3b416586faaabb37515705588a89"></a>
@@ -280,7 +280,7 @@ Public Attributes</h2></td></tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Opens epub as zip file filters then stores as list any files matching cover_regx
</pre>
</pre>
</div>
</div>
<a id="abab8649249ef71103f314aa29644a739"></a>
@@ -319,7 +319,7 @@ Public Attributes</h2></td></tr>
<pre class="fragment">Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
</pre>
</pre>
</div>
</div>
<a id="ad708c5a24143ca6fb38733f62396ee21"></a>
@@ -341,7 +341,7 @@ book['files'] == list of files from self.process_book(book)
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
</pre>
</pre>
<p>Reimplemented from <a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a9dec8499f181aee506861142004d002d">src.backend.lib.library.Catalogue</a>.</p>
</div>
@@ -382,7 +382,7 @@ Proceeds to call process_book
<pre class="fragment">Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
</pre>
</pre>
</div>
</div>
<a id="aedf70ab79105f8251d36848fb790fb9f"></a>
@@ -408,7 +408,7 @@ Iterates over list and inserts new books into database.
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Return dictionary of epub file contents</pre>
<pre class="fragment">Return dictionary of epub file contents</pre>
</div>
</div>
<a id="a204c5171b7de8ddd199563fd1b252032"></a>
@@ -445,7 +445,7 @@ Iterates over list and inserts new books into database.
</table>
</div><div class="memdoc">
<pre class="fragment">Scan folder by _path, allows recurisive scanning
</pre>
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
@@ -454,9 +454,9 @@ Iterates over list and inserts new books into database.
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

75
docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html vendored
View File

@@ -1,75 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">Storage</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.storage.Storage Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self, db_pointer, config) (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a27348bc85856956bade10ec39d51b77e">book_paths_list</a>(self)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#aea7868ca9c943e107e2454871c730555">close</a>(self)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a92c651d41e130c97e73703eb608c82c4">commit</a>(self)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#a7532f4b2a2af0f7100253642f8af4597">create_tables</a>(self)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>cursor</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>db</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>db_host</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>db_port</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html#ad08ae5682a3e3e66658eee723084fe2a">insert_book</a>(self, book)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>password</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>sql</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>user</b> (defined in <a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a>)</td><td class="entry"><a class="el" href="../../d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html">pyShelf.src.backend.lib.storage.Storage</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

10
docs/html/dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -75,9 +75,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

65
docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html vendored
View File

@@ -1,65 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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>api_hooks</b></li><li class="navelem"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">DuckDuckGo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.api_hooks.DuckDuckGo Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>__init__</b>(self) (defined in <a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a>)</td><td class="entry"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html#a9ecf411b77aca69bee4e1c619b37e521">image_result</a>(self, query)</td><td class="entry"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>url</b> (defined in <a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a>)</td><td class="entry"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">pyShelf.src.backend.lib.api_hooks.DuckDuckGo</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

113
docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html vendored
View File

@@ -1,113 +0,0 @@
<!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: pyShelf.src.backend.lib.api_hooks.DuckDuckGo 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.3.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>pyShelf</b></li><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>api_hooks</b></li><li class="navelem"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html">DuckDuckGo</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="../../dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.api_hooks.DuckDuckGo 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:aa8a19ecca0cc92a3d617ab85ec251043"><td class="memItemLeft" align="right" valign="top"><a id="aa8a19ecca0cc92a3d617ab85ec251043"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</td></tr>
<tr class="separator:aa8a19ecca0cc92a3d617ab85ec251043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ecf411b77aca69bee4e1c619b37e521"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html#a9ecf411b77aca69bee4e1c619b37e521">image_result</a> (self, query)</td></tr>
<tr class="separator:a9ecf411b77aca69bee4e1c619b37e521"><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:aa034dc54a6c85f0311e35c32242e4884"><td class="memItemLeft" align="right" valign="top"><a id="aa034dc54a6c85f0311e35c32242e4884"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>url</b></td></tr>
<tr class="separator:aa034dc54a6c85f0311e35c32242e4884"><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">duckduckgo related searching</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9ecf411b77aca69bee4e1c619b37e521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ecf411b77aca69bee4e1c619b37e521">&#9670;&nbsp;</a></span>image_result()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result </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>query</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Returns json containing url to image
:param _key: &amp;t=h_&amp;iar=images&amp;iax=images&amp;ia=images&amp;format=json&amp;pretty=1
</pre>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/lib/<a class="el" href="../../">api_hooks.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

105
docs/html/dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html vendored
View File

@@ -1,105 +0,0 @@
<!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: pyShelf.src.backend.lib.pyShelf.InitFiles 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.3.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>pyShelf</b></li><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>pyShelf</b></li><li class="navelem"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html">InitFiles</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.pyShelf.InitFiles 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:af7310746dd1535ada6891e35bbcffb99"><td class="memItemLeft" align="right" valign="top"><a id="af7310746dd1535ada6891e35bbcffb99"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, file_array)</td></tr>
<tr class="separator:af7310746dd1535ada6891e35bbcffb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a614e5bc5f38f75680bba3f1b103c9bb4"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html#a614e5bc5f38f75680bba3f1b103c9bb4">CreateFile</a> (self, _pointer)</td></tr>
<tr class="separator:a614e5bc5f38f75680bba3f1b103c9bb4"><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">First run file creation operations</pre> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a614e5bc5f38f75680bba3f1b103c9bb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a614e5bc5f38f75680bba3f1b103c9bb4">&#9670;&nbsp;</a></span>CreateFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">def pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile </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>_pointer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<pre class="fragment">Checks if file exists and creates it 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="../../">pyShelf.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

66
docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html vendored
View File

@@ -1,66 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>config_test</b></li><li class="navelem"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">TestConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.config_test.TestConfig Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a>, including all inherited members.</p>
<table class="directory">
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>config</b> (defined in <a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a>)</td><td class="entry"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a></td><td class="entry"><span class="mlabel">static</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>test_book_dir</b>(self) (defined in <a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a>)</td><td class="entry"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>test_title</b>(self) (defined in <a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a>)</td><td class="entry"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>test_version</b>(self) (defined in <a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a>)</td><td class="entry"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">pyShelf.src.backend.tests.config_test.TestConfig</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

72
docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html vendored
View File

@@ -1,72 +0,0 @@
<!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: Member List</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.3.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>pyShelf</b></li><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>pyShelf</b></li><li class="navelem"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">BookDisplay</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pyShelf.src.backend.lib.pyShelf.BookDisplay Member List</div> </div>
</div><!--header-->
<div class="contents">
<p>This is the complete list of members for <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a0498af17fbd47db504acada242b14fad">__init__</a>(self, **kwargs)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>books_per_page</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#ac41a7eaf5b19bc7fcbd37c3a82fbcfc9">booksPerPage</a>(self, screen_size)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>current_page</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a7a6ed64b1b2f5de6d4b3b21674d61ce2">nextPage</a>(self)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html#a614c79a2ed8f5c5b0f184858dfebc71e">previousPage</a>(self)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>screen_size</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>thumbnail_scale</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>thumbnail_size</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>total_pages</b> (defined in <a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a>)</td><td class="entry"><a class="el" href="../../d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html">pyShelf.src.backend.lib.pyShelf.BookDisplay</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

10
docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Member List</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -57,9 +57,9 @@ $(function() {
</table></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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

86
docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html vendored
View File

@@ -1,86 +0,0 @@
<!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: pyShelf.src.backend.tests.config_test.TestConfig 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.3.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>pyShelf</b></li><li class="navelem"><b>src</b></li><li class="navelem"><b>backend</b></li><li class="navelem"><b>tests</b></li><li class="navelem"><b>config_test</b></li><li class="navelem"><a class="el" href="../../df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html">TestConfig</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="../../dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">pyShelf.src.backend.tests.config_test.TestConfig 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:ad2e05b99a3bddefae99d2b662493fbf1"><td class="memItemLeft" align="right" valign="top"><a id="ad2e05b99a3bddefae99d2b662493fbf1"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>test_book_dir</b> (self)</td></tr>
<tr class="separator:ad2e05b99a3bddefae99d2b662493fbf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed92bfe91cd38930be701e0f53da31f5"><td class="memItemLeft" align="right" valign="top"><a id="aed92bfe91cd38930be701e0f53da31f5"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>test_title</b> (self)</td></tr>
<tr class="separator:aed92bfe91cd38930be701e0f53da31f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8aa7edab0a5bb64c12be3772d8946113"><td class="memItemLeft" align="right" valign="top"><a id="a8aa7edab0a5bb64c12be3772d8946113"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>test_version</b> (self)</td></tr>
<tr class="separator:a8aa7edab0a5bb64c12be3772d8946113"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:abe691de80b3809c16b38a1c97318bf88"><td class="memItemLeft" align="right" valign="top"><a id="abe691de80b3809c16b38a1c97318bf88"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>config</b> = <a class="el" href="../../d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html">Config</a>(os.path.abspath(os.path.curdir))</td></tr>
<tr class="separator:abe691de80b3809c16b38a1c97318bf88"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/backend/tests/<a class="el" href="../../">config_test.py</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2019 12:54:07 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>

10
docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src.backend.tests.config_test.TestConfig Class Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -78,9 +78,9 @@ Static Public Attributes</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src/backend/lib Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -51,9 +51,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src/backend Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -55,9 +55,9 @@ Directories</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -55,9 +55,9 @@ Directories</h2></td></tr>
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: src/backend/tests Directory Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -51,9 +51,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

68
docs/html/doxygen.css vendored
View File

@@ -1,4 +1,4 @@
/* The standard CSS for doxygen 1.8.16 */
/* The standard CSS for doxygen 1.8.17 */
body, table, div, p, dl {
font: 400 14px/22px Roboto,sans-serif;
@@ -66,6 +66,11 @@ p.startli, p.startdd {
margin-top: 2px;
}
th p.starttd, p.intertd, p.endtd {
font-size: 100%;
font-weight: 700;
}
p.starttd {
margin-top: 0px;
}
@@ -161,11 +166,11 @@ a.elRef {
}
a.code, a.code:visited, a.line, a.line:visited {
color: #4665A2;
color: #4665A2;
}
a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
color: #4665A2;
color: #4665A2;
}
/* @end */
@@ -351,7 +356,7 @@ p.formulaDsp {
}
img.formulaDsp {
}
img.formulaInl, img.inline {
@@ -409,20 +414,20 @@ span.charliteral {
color: #008080
}
span.vhdldigit {
color: #ff00ff
span.vhdldigit {
color: #ff00ff
}
span.vhdlchar {
color: #000000
span.vhdlchar {
color: #000000
}
span.vhdlkeyword {
color: #700070
span.vhdlkeyword {
color: #700070
}
span.vhdllogic {
color: #ff0000
span.vhdllogic {
color: #ff0000
}
blockquote {
@@ -535,7 +540,7 @@ table.memberdecls {
white-space: nowrap;
}
.memItemRight {
.memItemRight, .memTemplItemRight {
width: 100%;
}
@@ -647,9 +652,9 @@ table.memberdecls {
}
.memdoc, dl.reflist dd {
border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
border-bottom: 1px solid #A8B8D9;
border-left: 1px solid #A8B8D9;
border-right: 1px solid #A8B8D9;
padding: 6px 10px 2px 10px;
background-color: #FBFCFD;
border-top-width: 0;
@@ -701,18 +706,18 @@ dl.reflist dd {
.params, .retval, .exception, .tparams {
margin-left: 0px;
padding-left: 0px;
}
}
.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname {
font-weight: bold;
vertical-align: top;
}
.params .paramtype, .tparams .paramtype {
font-style: italic;
vertical-align: top;
}
}
.params .paramdir, .tparams .paramdir {
font-family: "courier new",courier,monospace;
vertical-align: top;
@@ -968,8 +973,8 @@ table.fieldtable {
.fieldtable td.fielddoc p:first-child {
margin-top: 0px;
}
}
.fieldtable td.fielddoc p:last-child {
margin-bottom: 2px;
}
@@ -1044,7 +1049,7 @@ table.fieldtable {
color: #283A5D;
font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
text-decoration: none;
text-decoration: none;
}
.navpath li.navelem a:hover
@@ -1073,7 +1078,7 @@ div.summary
padding-right: 5px;
width: 50%;
text-align: right;
}
}
div.summary a
{
@@ -1088,7 +1093,7 @@ table.classindex
margin-right: 3%;
width: 94%;
border: 0;
border-spacing: 0;
border-spacing: 0;
padding: 0;
}
@@ -1268,12 +1273,12 @@ dl.section dd {
vertical-align: bottom;
border-collapse: separate;
}
#projectlogo img
{
{
border: 0px none;
}
#projectalign
{
vertical-align: middle;
@@ -1285,7 +1290,7 @@ dl.section dd {
margin: 0px;
padding: 2px 0px;
}
#projectbrief
{
font: 120% Tahoma, Arial,sans-serif;
@@ -1401,7 +1406,7 @@ div.toc ul {
list-style: none outside none;
border: medium none;
padding: 0px;
}
}
div.toc li.level1 {
margin-left: 0px;
@@ -1756,10 +1761,11 @@ table.DocNodeLTR {
tt, code, kbd, samp
{
display: inline-block;
direction:ltr;
direction:ltr;
}
/* @end */
u {
text-decoration: underline;
}

10
docs/html/files.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: File List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -67,9 +67,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/functions.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Class Members</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -111,9 +111,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/functions_func.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Class Members - Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -111,9 +111,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/hierarchy.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Class Hierarchy</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -62,9 +62,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

10
docs/html/index.html vendored
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>pyShelf Open Source Ebook Server: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,7 +19,7 @@
<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>
&#160;<span id="projectnumber">0.4.1</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
</td>
@@ -28,7 +28,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
@@ -47,9 +47,9 @@ $(function() {
</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">
Generated on Sun Feb 2 2020 08:12:21 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
</a> 1.8.17
</small></address>
</body>
</html>

2
docs/html/jquery.js vendored
View File

File diff suppressed because one or more lines are too long

2
docs/html/tabs.css vendored
View File

File diff suppressed because one or more lines are too long

50
docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 vendored
View File

@@ -1,50 +0,0 @@
.TH "pyShelf.src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.api_hooks.DuckDuckGo
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBimage_result\fP (self, query)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBurl\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
duckduckgo related searching
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)"
.PP
.nf
Returns json containing url to image
:param _key: &t=h_&iar=images&iax=images&ia=images&format=json&pretty=1
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

98
docs/man/man3/pyShelf_src_backend_lib_config_Config.3 vendored
View File

@@ -1,98 +0,0 @@
.TH "pyShelf.src.backend.lib.config.Config" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.config.Config
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, root)"
.br
.ti -1c
.RI "def \fBopen_file\fP (self, _cp)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_path\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.ti -1c
.RI "\fBVERSION\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBcatalogue_db\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBdb_host\fP"
.br
.ti -1c
.RI "\fBdb_port\fP"
.br
.ti -1c
.RI "\fBfile_array\fP"
.br
.ti -1c
.RI "\fBroot\fP"
.br
.ti -1c
.RI "\fBauto_scan\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Main System Configuration
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.config\&.Config\&.__init__ ( self, root)"
.PP
.nf
Initialize main configuration options
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.config\&.Config\&.open_file ( self, _cp)"
.PP
.nf
Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented in \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

187
docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 vendored
View File

@@ -1,187 +0,0 @@
.TH "pyShelf.src.backend.lib.library.Catalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.library.Catalogue
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, config)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, _path=None)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_html\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_image\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBcompare_shelf_current\fP (self)"
.br
.ti -1c
.RI "def \fBimport_books\fP (self, list=None)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBfile_list\fP"
.br
.ti -1c
.RI "\fBopf_regx\fP"
.br
.ti -1c
.RI "\fBcover_regx\fP"
.br
.ti -1c
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBroot_dir\fP"
.br
.ti -1c
.RI "\fBbook_folder\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBbooks\fP"
.br
.ti -1c
.RI "\fBdb_pointer\fP"
.br
.ti -1c
.RI "\fBconfig\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Decodes book metadata for storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)"
.PP
.nf
Calls storage system, gets list of books stored and compares against files on disk
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)"
.PP
.nf
Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.filter_books ( self)"
.PP
.nf
Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
.fi
.PP
.PP
Reimplemented in \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)"
.PP
.nf
Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)"
.PP
.nf
Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

107
docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 vendored
View File

@@ -1,107 +0,0 @@
.TH "pyShelf.src.backend.lib.pyShelf.BookDisplay" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.pyShelf.BookDisplay
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, **kwargs)"
.br
.ti -1c
.RI "def \fBnextPage\fP (self)"
.br
.ti -1c
.RI "def \fBpreviousPage\fP (self)"
.br
.ti -1c
.RI "def \fBbooksPerPage\fP (self, screen_size)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbooks_per_page\fP"
.br
.ti -1c
.RI "\fBcurrent_page\fP"
.br
.ti -1c
.RI "\fBthumbnail_size\fP"
.br
.ti -1c
.RI "\fBthumbnail_scale\fP"
.br
.ti -1c
.RI "\fBtotal_pages\fP"
.br
.ti -1c
.RI "\fBscreen_size\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
All functions related to displaying book information in the HTML UI
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self, ** kwargs)"
.PP
.nf
Initialize class variables
:return: None
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.PP
.nf
## TODO Remove me
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.PP
.nf
## TODO Remove me
Goto next book page
:return: new current_page
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.PP
.nf
## TODO Remove me
Goto previous book page
:return: new current_page
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

42
docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 vendored
View File

@@ -1,42 +0,0 @@
.TH "pyShelf.src.backend.lib.pyShelf.InitFiles" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.pyShelf.InitFiles
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, file_array)"
.br
.ti -1c
.RI "def \fBCreateFile\fP (self, _pointer)"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
First run file creation operations
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)"
.PP
.nf
Checks if file exists and creates it if not
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

115
docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 vendored
View File

@@ -1,115 +0,0 @@
.TH "pyShelf.src.backend.lib.storage.Storage" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.storage.Storage
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, db_pointer, config)"
.br
.ti -1c
.RI "def \fBcreate_tables\fP (self)"
.br
.ti -1c
.RI "def \fBinsert_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBbook_paths_list\fP (self)"
.br
.ti -1c
.RI "def \fBcommit\fP (self)"
.br
.ti -1c
.RI "def \fBclose\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBsql\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBdb_host\fP"
.br
.ti -1c
.RI "\fBdb_port\fP"
.br
.ti -1c
.RI "\fBdb\fP"
.br
.ti -1c
.RI "\fBcursor\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Contains all methods for system storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.book_paths_list ( self)"
.PP
.nf
Get file paths from database for comparison to system files
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.close ( self)"
.PP
.nf
Close database connection
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.commit ( self)"
.PP
.nf
Commit database transactions
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
.nf
Create table structure
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.insert_book ( self, book)"
.PP
.nf
Insert book in database
:returns: True if succeeds False if not
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

35
docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 vendored
View File

@@ -1,35 +0,0 @@
.TH "pyShelf.src.backend.tests.config_test.TestConfig" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.config_test.TestConfig
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBtest_book_dir\fP (self)"
.br
.ti -1c
.RI "def \fBtest_title\fP (self)"
.br
.ti -1c
.RI "def \fBtest_version\fP (self)"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "\fBconfig\fP = \fBConfig\fP(os\&.path\&.abspath(os\&.path\&.curdir))"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

32
docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 vendored
View File

@@ -1,32 +0,0 @@
.TH "pyShelf.src.backend.tests.library_test.TestCatalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.TestCatalogue
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBtest_filter_books\fP (self)"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "\fBroot\fP = os\&.path\&.abspath(os\&.path\&.curdir)"
.br
.ti -1c
.RI "\fBconfig\fP = \fBTest_Config\fP()"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

179
docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 vendored
View File

@@ -1,179 +0,0 @@
.TH "pyShelf.src.backend.tests.library_test.Test_Catalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.Test_Catalogue
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBpyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, _path=None)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_html\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_image\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBcompare_shelf_current\fP (self)"
.br
.ti -1c
.RI "def \fBimport_books\fP (self, list=None)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBfile_list\fP"
.br
.ti -1c
.RI "\fBopf_regx\fP"
.br
.ti -1c
.RI "\fBcover_regx\fP"
.br
.ti -1c
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBroot_dir\fP"
.br
.ti -1c
.RI "\fBbook_folder\fP"
.br
.ti -1c
.RI "\fBbooks\fP"
.br
.ti -1c
.RI "\fBdb_pointer\fP"
.br
.ti -1c
.RI "\fBconfig\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)\fC [inherited]\fP"
.PP
.nf
Calls storage system, gets list of books stored and compares against files on disk
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)\fC [inherited]\fP"
.PP
.nf
Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\&.filter_books ( self)"
.PP
.nf
Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
.fi
.PP
.PP
Reimplemented from \fBpyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)\fC [inherited]\fP"
.PP
.nf
Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP, \fC [inherited]\fP"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)\fC [inherited]\fP"
.PP
.nf
Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

79
docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 vendored
View File

@@ -1,79 +0,0 @@
.TH "pyShelf.src.backend.tests.library_test.Test_Config" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.Test_Config
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBpyShelf\&.src\&.backend\&.lib\&.config\&.Config\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBopen_file\fP (self, root='config\&.json')"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_path\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.ti -1c
.RI "\fBVERSION\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBcatalogue_db\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBdb_host\fP"
.br
.ti -1c
.RI "\fBdb_port\fP"
.br
.ti -1c
.RI "\fBfile_array\fP"
.br
.ti -1c
.RI "\fBroot\fP"
.br
.ti -1c
.RI "\fBauto_scan\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\&.open_file ( self, _cp = \fC'config\&.json'\fP)"
.PP
.nf
Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented from \fBpyShelf\&.src\&.backend\&.lib\&.config\&.Config\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

12
docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.api_hooks.DuckDuckGo" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -24,16 +24,16 @@ src.backend.lib.api_hooks.DuckDuckGo
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
duckduckgo related searching
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)"
.PP
@@ -43,8 +43,8 @@ Returns json containing url to image
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

16
docs/man/man3/src_backend_lib_config_Config.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.config.Config" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.config.Config" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -68,7 +68,7 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
@@ -76,9 +76,9 @@ Main System Configuration
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.config\&.Config\&.__init__ ( self, root)"
.PP
@@ -87,9 +87,9 @@ Initialize main configuration options
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.config\&.Config\&.open_file ( self, _cp)"
.PP
@@ -98,10 +98,10 @@ Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented in \fBsrc\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

6
docs/man/man3/src_backend_lib_display_TerminalDisplay.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.display.TerminalDisplay" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.display.TerminalDisplay" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -70,9 +70,9 @@ src.backend.lib.display.TerminalDisplay
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

28
docs/man/man3/src_backend_lib_library_Catalogue.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.library.Catalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.library.Catalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -81,7 +81,7 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
@@ -89,9 +89,9 @@ Decodes book metadata for storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)"
.PP
@@ -100,7 +100,7 @@ Calls storage system, gets list of books stored and compares against files on di
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)"
.PP
@@ -109,7 +109,7 @@ Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)"
.PP
@@ -118,7 +118,7 @@ Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)"
.PP
@@ -127,7 +127,7 @@ Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)"
.PP
@@ -138,7 +138,7 @@ book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.filter_books ( self)"
.PP
@@ -150,7 +150,7 @@ Proceeds to call process_book
.fi
.PP
.PP
Reimplemented in \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)"
@@ -163,7 +163,7 @@ Iterates over list and inserts new books into database.
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP"
.PP
@@ -171,7 +171,7 @@ Iterates over list and inserts new books into database.
Return dictionary of epub file contents
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)"
.PP
@@ -180,8 +180,8 @@ Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

20
docs/man/man3/src_backend_lib_pyShelf_BookDisplay.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.pyShelf.BookDisplay" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.pyShelf.BookDisplay" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -45,16 +45,16 @@ src.backend.lib.pyShelf.BookDisplay
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
All functions related to displaying book information in the HTML UI
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self, ** kwargs)"
.PP
@@ -64,9 +64,9 @@ Initialize class variables
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.PP
@@ -78,7 +78,7 @@ Set books per page
.fi
.PP
.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.PP
@@ -89,7 +89,7 @@ Goto next book page
.fi
.PP
.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.PP
@@ -100,8 +100,8 @@ Goto previous book page
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

12
docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.pyShelf.InitFiles" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.pyShelf.InitFiles" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -17,16 +17,16 @@ src.backend.lib.pyShelf.InitFiles
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
First run file creation operations
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)"
.PP
@@ -35,8 +35,8 @@ Checks if file exists and creates it if not
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

20
docs/man/man3/src_backend_lib_storage_Storage.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.storage.Storage" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.storage.Storage" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -60,16 +60,16 @@ src.backend.lib.storage.Storage
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
Contains all methods for system storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.book_paths_list ( self)"
.PP
@@ -78,7 +78,7 @@ Get file paths from database for comparison to system files
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.close ( self)"
.PP
@@ -87,7 +87,7 @@ Close database connection
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.commit ( self)"
.PP
@@ -96,7 +96,7 @@ Commit database transactions
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
@@ -104,7 +104,7 @@ Commit database transactions
Create table structure
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.insert_book ( self, book)"
.PP
@@ -114,8 +114,8 @@ Insert book in database
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

6
docs/man/man3/src_backend_tests_config_test_TestConfig.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.config_test.TestConfig" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.config_test.TestConfig" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -27,9 +27,9 @@ src.backend.tests.config_test.TestConfig
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

6
docs/man/man3/src_backend_tests_library_test_TestCatalogue.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.TestCatalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.TestCatalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -24,9 +24,9 @@ src.backend.tests.library_test.TestCatalogue
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

26
docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.Test_Catalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.Test_Catalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -81,9 +81,9 @@ Inherits \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)\fC [inherited]\fP"
.PP
@@ -92,7 +92,7 @@ Calls storage system, gets list of books stored and compares against files on di
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)\fC [inherited]\fP"
.PP
@@ -101,7 +101,7 @@ Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)\fC [inherited]\fP"
.PP
@@ -110,7 +110,7 @@ Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)\fC [inherited]\fP"
.PP
@@ -119,7 +119,7 @@ Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)\fC [inherited]\fP"
.PP
@@ -130,7 +130,7 @@ book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def src\&.backend\&.tests\&.library_test\&.Test_Catalogue\&.filter_books ( self)"
.PP
@@ -142,7 +142,7 @@ Proceeds to call process_book
.fi
.PP
.PP
Reimplemented from \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)\fC [inherited]\fP"
@@ -155,7 +155,7 @@ Iterates over list and inserts new books into database.
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP, \fC [inherited]\fP"
.PP
@@ -163,7 +163,7 @@ Iterates over list and inserts new books into database.
Return dictionary of epub file contents
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)\fC [inherited]\fP"
.PP
@@ -172,8 +172,8 @@ Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

10
docs/man/man3/src_backend_tests_library_test_Test_Config.3 vendored
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.Test_Config" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.Test_Config" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -68,9 +68,9 @@ Inherits \fBsrc\&.backend\&.lib\&.config\&.Config\fP\&.
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.SH "Member Function Documentation"
.PP
.PP
.SS "def src\&.backend\&.tests\&.library_test\&.Test_Config\&.open_file ( self, _cp = \fC'config\&.json'\fP)"
.PP
@@ -79,10 +79,10 @@ Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented from \fBsrc\&.backend\&.lib\&.config\&.Config\fP\&.
.SH "Author"
.PP
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

287
docs/warn.log vendored
View File

@@ -1,132 +1,155 @@
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:9: warning: Compound src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:19: warning: Compound src::backend::tests::library_test::Test_Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:8: warning: Compound src::backend::tests::library_test::Test_Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:28: warning: Compound src::backend::tests::library_test::TestCatalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:6: warning: Compound src::backend::tests::config_test::TestConfig is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:12: warning: Member __init__(self) (function) of class src::backend::lib::api_hooks::DuckDuckGo is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:13: warning: Member url (variable) of class src::backend::lib::api_hooks::DuckDuckGo is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:15: warning: return type of member src.backend.lib.api_hooks.DuckDuckGo.image_result is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:40: warning: return type of member src.backend.lib.config.Config.open_file is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:10: warning: Member __init__(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:21: warning: Member screen(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:24: warning: Member installer(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:82: warning: Member prompt(self, questions) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:93: warning: Member h_rule(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:96: warning: Member banner(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:106: warning: Member banner_render(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:79: warning: Member clear() (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:11: warning: Member term (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:12: warning: Member y (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:13: warning: Member home (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:14: warning: Member user (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:15: warning: Member version (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:16: warning: Member slogan (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:17: warning: Member green (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:18: warning: Member blue (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/display.py:19: warning: Member clr_term (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:22: warning: Member __init__(self, config) (function) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:29: warning: Member book_shelf (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member src.backend.lib.library.Catalogue.compare_shelf_current is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:115: warning: return type of member src.backend.lib.library.Catalogue.extract_content is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:122: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_html is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:129: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_image is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:89: warning: return type of member src.backend.lib.library.Catalogue.extract_metadata is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:52: warning: return type of member src.backend.lib.library.Catalogue.filter_books is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:158: warning: return type of member src.backend.lib.library.Catalogue.import_books is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:73: warning: return type of member src.backend.lib.library.Catalogue.process_book is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:35: warning: return type of member src.backend.lib.library.Catalogue.scan_folder is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:45: warning: Member books_per_page (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:46: warning: Member current_page (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:47: warning: Member thumbnail_size (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:48: warning: Member thumbnail_scale (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:49: warning: Member total_pages (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:51: warning: Member screen_size (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:40: warning: parameters of member src.backend.lib.pyShelf.BookDisplay.__init__ are not (all) documented
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:73: warning: return type of member src.backend.lib.pyShelf.BookDisplay.booksPerPage is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:55: warning: return type of member src.backend.lib.pyShelf.BookDisplay.nextPage is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:64: warning: return type of member src.backend.lib.pyShelf.BookDisplay.previousPage is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:15: warning: Member __init__(self, file_array) (function) of class src::backend::lib::pyShelf::InitFiles is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:27: warning: return type of member src.backend.lib.pyShelf.InitFiles.CreateFile is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:15: warning: Member __init__(self, config) (function) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:27: warning: Member check_ownership(self, table=None) (function) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:16: warning: Member sql (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:17: warning: Member user (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:18: warning: Member password (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:19: warning: Member db_host (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:20: warning: Member db_port (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:21: warning: Member db (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:24: warning: Member config (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:25: warning: Member cursor (variable) of class src::backend::lib::storage::Storage is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:76: warning: return type of member src.backend.lib.storage.Storage.book_paths_list is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:99: warning: return type of member src.backend.lib.storage.Storage.close is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:89: warning: return type of member src.backend.lib.storage.Storage.commit is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:46: warning: return type of member src.backend.lib.storage.Storage.create_tables is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:57: warning: return type of member src.backend.lib.storage.Storage.insert_book is not documented
/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:9: warning: Member test_book_dir(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:12: warning: Member test_title(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:15: warning: Member test_version(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:7: warning: Member config (variable) of class src::backend::tests::config_test::TestConfig is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:20: warning: Member __init__(self) (function) of class src::backend::tests::library_test::Test_Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:24: warning: Member book_shelf (variable) of class src::backend::tests::library_test::Test_Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member src.backend.lib.library.Catalogue.compare_shelf_current is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:115: warning: return type of member src.backend.lib.library.Catalogue.extract_content is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:122: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_html is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:129: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_image is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:89: warning: return type of member src.backend.lib.library.Catalogue.extract_metadata is not documented
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:23: warning: return type of member src.backend.tests.library_test.Test_Catalogue.filter_books is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:158: warning: return type of member src.backend.lib.library.Catalogue.import_books is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:73: warning: return type of member src.backend.lib.library.Catalogue.process_book is not documented
/home/raelon/Projects/pyShelf/src/backend/lib/library.py:35: warning: return type of member src.backend.lib.library.Catalogue.scan_folder is not documented
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:9: warning: Member __init__(self) (function) of class src::backend::tests::library_test::Test_Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:13: warning: return type of member src.backend.tests.library_test.Test_Config.open_file is not documented
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:32: warning: Member test_filter_books(self) (function) of class src::backend::tests::library_test::TestCatalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:29: warning: Member root (variable) of class src::backend::tests::library_test::TestCatalogue is not documented.
/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:30: warning: Member config (variable) of class src::backend::tests::library_test::TestCatalogue is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:19: warning: Compound src::backend::tests::library_test::Test_Catalogue is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:28: warning: Compound src::backend::tests::library_test::TestCatalogue is not documented.
/opt/pyshelf/src/backend/tests/config_test.py:6: warning: Compound src::backend::tests::config_test::TestConfig is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:8: warning: Compound src::backend::tests::library_test::Test_Config is not documented.
/opt/pyshelf/src/backend/lib/display.py:9: warning: Compound src::backend::lib::display::TerminalDisplay is not documented.
error: Problems running htags. Check your installation
error: USE_HTAGS is YES but htags(1) failed.
/opt/pyshelf/src/backend/lib/api_hooks.py:12: warning: Member __init__(self) (function) of class src::backend::lib::api_hooks::DuckDuckGo is not documented.
/opt/pyshelf/src/backend/lib/api_hooks.py:13: warning: Member url (variable) of class src::backend::lib::api_hooks::DuckDuckGo is not documented.
/opt/pyshelf/src/backend/lib/api_hooks.py:15: warning: parameters of member src.backend.lib.api_hooks.DuckDuckGo.image_result are not (all) documented
/opt/pyshelf/src/backend/lib/api_hooks.py:15: warning: return type of member src.backend.lib.api_hooks.DuckDuckGo.image_result is not documented
/opt/pyshelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:14: warning: parameters of member src.backend.lib.config.Config.__init__ are not (all) documented
/opt/pyshelf/src/backend/lib/config.py:40: warning: parameters of member src.backend.lib.config.Config.open_file are not (all) documented
/opt/pyshelf/src/backend/lib/config.py:40: warning: return type of member src.backend.lib.config.Config.open_file is not documented
/opt/pyshelf/src/backend/lib/display.py:10: warning: Member __init__(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:21: warning: Member screen(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:24: warning: Member installer(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:82: warning: Member prompt(self, questions) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:93: warning: Member h_rule(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:96: warning: Member banner(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:106: warning: Member banner_render(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:79: warning: Member clear() (function) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:11: warning: Member term (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:12: warning: Member y (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:13: warning: Member home (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:14: warning: Member user (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:15: warning: Member version (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:16: warning: Member slogan (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:17: warning: Member green (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:18: warning: Member blue (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/display.py:19: warning: Member clr_term (variable) of class src::backend::lib::display::TerminalDisplay is not documented.
/opt/pyshelf/src/backend/lib/library.py:22: warning: Member __init__(self, config) (function) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:29: warning: Member book_shelf (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:31: warning: Member books (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:140: warning: return type of member src.backend.lib.library.Catalogue.compare_shelf_current is not documented
/opt/pyshelf/src/backend/lib/library.py:115: warning: parameters of member src.backend.lib.library.Catalogue.extract_content are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:115: warning: return type of member src.backend.lib.library.Catalogue.extract_content is not documented
/opt/pyshelf/src/backend/lib/library.py:122: warning: parameters of member src.backend.lib.library.Catalogue.extract_cover_html are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:122: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_html is not documented
/opt/pyshelf/src/backend/lib/library.py:129: warning: parameters of member src.backend.lib.library.Catalogue.extract_cover_image are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:129: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_image is not documented
/opt/pyshelf/src/backend/lib/library.py:89: warning: parameters of member src.backend.lib.library.Catalogue.extract_metadata are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:89: warning: return type of member src.backend.lib.library.Catalogue.extract_metadata is not documented
/opt/pyshelf/src/backend/lib/library.py:52: warning: return type of member src.backend.lib.library.Catalogue.filter_books is not documented
/opt/pyshelf/src/backend/lib/library.py:158: warning: parameters of member src.backend.lib.library.Catalogue.import_books are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:158: warning: return type of member src.backend.lib.library.Catalogue.import_books is not documented
/opt/pyshelf/src/backend/lib/library.py:73: warning: parameters of member src.backend.lib.library.Catalogue.process_book are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:73: warning: return type of member src.backend.lib.library.Catalogue.process_book is not documented
/opt/pyshelf/src/backend/lib/library.py:35: warning: parameters of member src.backend.lib.library.Catalogue.scan_folder are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:35: warning: return type of member src.backend.lib.library.Catalogue.scan_folder is not documented
/opt/pyshelf/src/backend/lib/pyShelf.py:45: warning: Member books_per_page (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:46: warning: Member current_page (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:47: warning: Member thumbnail_size (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:48: warning: Member thumbnail_scale (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:49: warning: Member total_pages (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:51: warning: Member screen_size (variable) of class src::backend::lib::pyShelf::BookDisplay is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:40: warning: parameters of member src.backend.lib.pyShelf.BookDisplay.__init__ are not (all) documented
/opt/pyshelf/src/backend/lib/pyShelf.py:73: warning: parameters of member src.backend.lib.pyShelf.BookDisplay.booksPerPage are not (all) documented
/opt/pyshelf/src/backend/lib/pyShelf.py:73: warning: return type of member src.backend.lib.pyShelf.BookDisplay.booksPerPage is not documented
/opt/pyshelf/src/backend/lib/pyShelf.py:55: warning: return type of member src.backend.lib.pyShelf.BookDisplay.nextPage is not documented
/opt/pyshelf/src/backend/lib/pyShelf.py:64: warning: return type of member src.backend.lib.pyShelf.BookDisplay.previousPage is not documented
/opt/pyshelf/src/backend/lib/pyShelf.py:15: warning: Member __init__(self, file_array) (function) of class src::backend::lib::pyShelf::InitFiles is not documented.
/opt/pyshelf/src/backend/lib/pyShelf.py:27: warning: parameters of member src.backend.lib.pyShelf.InitFiles.CreateFile are not (all) documented
/opt/pyshelf/src/backend/lib/pyShelf.py:27: warning: return type of member src.backend.lib.pyShelf.InitFiles.CreateFile is not documented
/opt/pyshelf/src/backend/lib/storage.py:15: warning: Member __init__(self, config) (function) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:27: warning: Member check_ownership(self, table=None) (function) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:16: warning: Member sql (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:17: warning: Member user (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:18: warning: Member password (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:19: warning: Member db_host (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:20: warning: Member db_port (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:21: warning: Member db (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:24: warning: Member config (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:25: warning: Member cursor (variable) of class src::backend::lib::storage::Storage is not documented.
/opt/pyshelf/src/backend/lib/storage.py:76: warning: return type of member src.backend.lib.storage.Storage.book_paths_list is not documented
/opt/pyshelf/src/backend/lib/storage.py:99: warning: return type of member src.backend.lib.storage.Storage.close is not documented
/opt/pyshelf/src/backend/lib/storage.py:89: warning: return type of member src.backend.lib.storage.Storage.commit is not documented
/opt/pyshelf/src/backend/lib/storage.py:46: warning: return type of member src.backend.lib.storage.Storage.create_tables is not documented
/opt/pyshelf/src/backend/lib/storage.py:57: warning: parameters of member src.backend.lib.storage.Storage.insert_book are not (all) documented
/opt/pyshelf/src/backend/lib/storage.py:57: warning: return type of member src.backend.lib.storage.Storage.insert_book is not documented
/opt/pyshelf/src/backend/tests/config_test.py:9: warning: Member test_book_dir(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/opt/pyshelf/src/backend/tests/config_test.py:12: warning: Member test_title(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/opt/pyshelf/src/backend/tests/config_test.py:15: warning: Member test_version(self) (function) of class src::backend::tests::config_test::TestConfig is not documented.
/opt/pyshelf/src/backend/tests/config_test.py:7: warning: Member config (variable) of class src::backend::tests::config_test::TestConfig is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:20: warning: Member __init__(self) (function) of class src::backend::tests::library_test::Test_Catalogue is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:24: warning: Member book_shelf (variable) of class src::backend::tests::library_test::Test_Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:31: warning: Member books (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented.
/opt/pyshelf/src/backend/lib/library.py:140: warning: return type of member src.backend.lib.library.Catalogue.compare_shelf_current is not documented
/opt/pyshelf/src/backend/lib/library.py:115: warning: parameters of member src.backend.lib.library.Catalogue.extract_content are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:115: warning: return type of member src.backend.lib.library.Catalogue.extract_content is not documented
/opt/pyshelf/src/backend/lib/library.py:122: warning: parameters of member src.backend.lib.library.Catalogue.extract_cover_html are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:122: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_html is not documented
/opt/pyshelf/src/backend/lib/library.py:129: warning: parameters of member src.backend.lib.library.Catalogue.extract_cover_image are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:129: warning: return type of member src.backend.lib.library.Catalogue.extract_cover_image is not documented
/opt/pyshelf/src/backend/lib/library.py:89: warning: parameters of member src.backend.lib.library.Catalogue.extract_metadata are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:89: warning: return type of member src.backend.lib.library.Catalogue.extract_metadata is not documented
/opt/pyshelf/src/backend/tests/library_test.py:23: warning: return type of member src.backend.tests.library_test.Test_Catalogue.filter_books is not documented
/opt/pyshelf/src/backend/lib/library.py:158: warning: parameters of member src.backend.lib.library.Catalogue.import_books are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:158: warning: return type of member src.backend.lib.library.Catalogue.import_books is not documented
/opt/pyshelf/src/backend/lib/library.py:73: warning: parameters of member src.backend.lib.library.Catalogue.process_book are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:73: warning: return type of member src.backend.lib.library.Catalogue.process_book is not documented
/opt/pyshelf/src/backend/lib/library.py:35: warning: parameters of member src.backend.lib.library.Catalogue.scan_folder are not (all) documented
/opt/pyshelf/src/backend/lib/library.py:35: warning: return type of member src.backend.lib.library.Catalogue.scan_folder is not documented
/opt/pyshelf/src/backend/tests/library_test.py:9: warning: Member __init__(self) (function) of class src::backend::tests::library_test::Test_Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:13: warning: parameters of member src.backend.tests.library_test.Test_Config.open_file are not (all) documented
/opt/pyshelf/src/backend/tests/library_test.py:13: warning: return type of member src.backend.tests.library_test.Test_Config.open_file is not documented
/opt/pyshelf/src/backend/tests/library_test.py:32: warning: Member test_filter_books(self) (function) of class src::backend::tests::library_test::TestCatalogue is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:29: warning: Member root (variable) of class src::backend::tests::library_test::TestCatalogue is not documented.
/opt/pyshelf/src/backend/tests/library_test.py:30: warning: Member config (variable) of class src::backend::tests::library_test::TestCatalogue is not documented.