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

Document only backend

Browse Source
This commit is contained in:
Mike Young
2019-12-15 12:58:59 -05:00
parent 7eb1cb330b
commit d82f247d83
91 changed files with 7782 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -0,0 +1,158 @@
<!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 Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB

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

@@ -0,0 +1,83 @@
<!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>

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

@@ -0,0 +1,188 @@
<!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 Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.1 KiB