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

Some documentation work

Browse Source
This commit is contained in:
Raelon Masters
2020-08-03 13:04:45 -04:00
parent 1f08dd6d44
commit d8ecd2fab7
68 changed files with 1084 additions and 810 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html
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.17"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<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,16 +19,16 @@
<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.1</span>
&#160;<span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">Open source, console based E-book server</div>
<div id="projectbrief">FOSS E-Book Server, https://pyshelf.com</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
@@ -74,8 +74,14 @@ def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</t
<tr class="separator:ad708c5a24143ca6fb38733f62396ee21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a204c5171b7de8ddd199563fd1b252032"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a204c5171b7de8ddd199563fd1b252032">scan_folder</a> (self, _path=None)</td></tr>
<tr class="separator:a204c5171b7de8ddd199563fd1b252032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abab8649249ef71103f314aa29644a739"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abab8649249ef71103f314aa29644a739">extract_metadata</a> (self, book)</td></tr>
<tr class="separator:abab8649249ef71103f314aa29644a739"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84b65fe5bef35dcd0a163c223a95820c"><td class="memItemLeft" align="right" valign="top"><a id="a84b65fe5bef35dcd0a163c223a95820c"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>process_by_filetype</b> (self, book)</td></tr>
<tr class="separator:a84b65fe5bef35dcd0a163c223a95820c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52115c91df4e18f24fd2da9f29ff0a54"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a52115c91df4e18f24fd2da9f29ff0a54">extract_metadata_epub</a> (self, book)</td></tr>
<tr class="separator:a52115c91df4e18f24fd2da9f29ff0a54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa281246a2ad06ed9737e7ef7c826bb20"><td class="memItemLeft" align="right" valign="top"><a id="aa281246a2ad06ed9737e7ef7c826bb20"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>extract_metadata_mobi</b> (self, book)</td></tr>
<tr class="separator:aa281246a2ad06ed9737e7ef7c826bb20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0993bce2b4fe64a46d96a5eba1d5af50"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#a0993bce2b4fe64a46d96a5eba1d5af50">extract_content</a> (self, book_zip, book)</td></tr>
<tr class="separator:a0993bce2b4fe64a46d96a5eba1d5af50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcf0dc2d816393afbfb07ea9f5c152f9"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#abcf0dc2d816393afbfb07ea9f5c152f9">extract_cover_html</a> (self, book_zip, book)</td></tr>
@@ -89,8 +95,11 @@ def&#160;</td><td class="memItemRight" valign="bottom"><b>__init__</b> (self)</t
</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:aedf70ab79105f8251d36848fb790fb9f"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#aedf70ab79105f8251d36848fb790fb9f">process_book</a> (book)</td></tr>
<tr class="separator:aedf70ab79105f8251d36848fb790fb9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf0de9eb2e0994b196fb754ae8395a0d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html#adf0de9eb2e0994b196fb754ae8395a0d">process_epub</a> (book)</td></tr>
<tr class="separator:adf0de9eb2e0994b196fb754ae8395a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0584b3c5413ef94048ddebaea000490"><td class="memItemLeft" align="right" valign="top"><a id="ab0584b3c5413ef94048ddebaea000490"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>stripTags</b> (source)</td></tr>
<tr class="separator:ab0584b3c5413ef94048ddebaea000490"><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>
@@ -109,6 +118,15 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a686b224643b060423a49a017d4a7abd8"><td class="memItemLeft" align="right" valign="top"><a id="a686b224643b060423a49a017d4a7abd8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>html_regx</b></td></tr>
<tr class="separator:a686b224643b060423a49a017d4a7abd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8fa7021f8b131c35c0a1d1179b003383"><td class="memItemLeft" align="right" valign="top"><a id="a8fa7021f8b131c35c0a1d1179b003383"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>title_sanitization_regx</b></td></tr>
<tr class="separator:a8fa7021f8b131c35c0a1d1179b003383"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8ad8ef5c7ea417050d4dd84046d3234"><td class="memItemLeft" align="right" valign="top"><a id="ad8ad8ef5c7ea417050d4dd84046d3234"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>title_sanitization_lvl2_regx</b></td></tr>
<tr class="separator:ad8ad8ef5c7ea417050d4dd84046d3234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab68843b8153b9e8ba51d0a4fa541568e"><td class="memItemLeft" align="right" valign="top"><a id="ab68843b8153b9e8ba51d0a4fa541568e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>title_sanitization_dirs_regx</b></td></tr>
<tr class="separator:ab68843b8153b9e8ba51d0a4fa541568e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e5edca4ab942e3f71958c90b5c45023"><td class="memItemLeft" align="right" valign="top"><a id="a3e5edca4ab942e3f71958c90b5c45023"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>root_dir</b></td></tr>
<tr class="separator:a3e5edca4ab942e3f71958c90b5c45023"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -151,7 +169,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 +212,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 +255,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,11 +298,11 @@ 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>
<h2 class="memtitle"><span class="permalink"><a href="#abab8649249ef71103f314aa29644a739">&#9670;&nbsp;</a></span>extract_metadata()</h2>
<a id="a52115c91df4e18f24fd2da9f29ff0a54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52115c91df4e18f24fd2da9f29ff0a54">&#9670;&nbsp;</a></span>extract_metadata_epub()</h2>
<div class="memitem">
<div class="memproto">
@@ -293,7 +311,7 @@ Public Attributes</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.library.Catalogue.extract_metadata </td>
<td class="memname">def src.backend.lib.library.Catalogue.extract_metadata_epub </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>self</em>, </td>
@@ -319,7 +337,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 +359,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,11 +400,11 @@ 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>
<h2 class="memtitle"><span class="permalink"><a href="#aedf70ab79105f8251d36848fb790fb9f">&#9670;&nbsp;</a></span>process_book()</h2>
<a id="adf0de9eb2e0994b196fb754ae8395a0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf0de9eb2e0994b196fb754ae8395a0d">&#9670;&nbsp;</a></span>process_epub()</h2>
<div class="memitem">
<div class="memproto">
@@ -395,7 +413,7 @@ Iterates over list and inserts new books into database.
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">def src.backend.lib.library.Catalogue.process_book </td>
<td class="memname">def src.backend.lib.library.Catalogue.process_epub </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>book</em></td><td>)</td>
@@ -408,7 +426,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 +463,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 +472,9 @@ Iterates over list and inserts new books into database.
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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">
Generated on Mon Aug 3 2020 09:02:53 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.17
</a> 1.8.18
</small></address>
</body>
</html>