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

Collections, and installer patches

Browse Source
This commit is contained in:
Raelon Masters
2020-03-20 01:15:07 -04:00
parent 746dd405a8
commit 9327b01ff4
263 changed files with 509 additions and 365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 vendored Normal file → Executable file
View File

@@ -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\&.

14
docs/man/man3/src_backend_lib_config_Config.3 vendored Normal file → Executable file
View File

@@ -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\&.

4
docs/man/man3/src_backend_lib_display_TerminalDisplay.3 vendored Normal file → Executable file
View File

@@ -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\&.

26
docs/man/man3/src_backend_lib_library_Catalogue.3 vendored Normal file → Executable file
View File

@@ -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\&.

18
docs/man/man3/src_backend_lib_pyShelf_BookDisplay.3 vendored Normal file → Executable file
View File

@@ -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\&.

10
docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 vendored Normal file → Executable file
View File

@@ -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\&.

18
docs/man/man3/src_backend_lib_storage_Storage.3 vendored Normal file → Executable file
View File

@@ -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\&.

4
docs/man/man3/src_backend_tests_config_test_TestConfig.3 vendored Normal file → Executable file
View File

@@ -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\&.

4
docs/man/man3/src_backend_tests_library_test_TestCatalogue.3 vendored Normal file → Executable file
View File

@@ -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\&.

24
docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3 vendored Normal file → Executable file
View File

@@ -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\&.

8
docs/man/man3/src_backend_tests_library_test_Test_Config.3 vendored Normal file → Executable file
View File

@@ -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\&.