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

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

@@ -1,4 +1,4 @@
.TH "src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.api_hooks.DuckDuckGo" 3 "Mon Aug 3 2020" "Version 0.6.0" "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\&.

22
docs/man/man3/src_backend_lib_config_Config.3
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.config.Config" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.config.Config" 3 "Mon Aug 3 2020" "Version 0.6.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -17,6 +17,9 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.ti -1c
.RI "def \fBopen_file\fP (self, _cp)"
.br
.ti -1c
.RI "def \fBdjango_secret\fP (self, _data)"
.br
.in -1c
.SS "Public Attributes"
@@ -66,9 +69,12 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.ti -1c
.RI "\fBdb_pass\fP"
.br
.ti -1c
.RI "\fBSECRET\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
@@ -76,9 +82,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 +93,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 +104,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\&.

57
docs/man/man3/src_backend_lib_library_Catalogue.3
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.library.Catalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.library.Catalogue" 3 "Mon Aug 3 2020" "Version 0.6.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -21,7 +21,13 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.RI "def \fBprocess_by_filetype\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_metadata_epub\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_metadata_mobi\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
@@ -43,7 +49,10 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.RI "def \fBprocess_epub\fP (book)"
.br
.ti -1c
.RI "def \fBstripTags\fP (source)"
.br
.in -1c
.SS "Public Attributes"
@@ -62,15 +71,21 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_lvl2_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_dirs_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
@@ -81,7 +96,7 @@ Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.PP
.nf
@@ -89,9 +104,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 +115,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 +124,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 +133,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,8 +142,8 @@ 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)"
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata_epub ( self, book)"
.PP
.nf
@@ -138,7 +153,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 +165,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,15 +178,15 @@ Iterates over list and inserts new books into database.
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP"
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.process_epub ( book)\fC [static]\fP"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)"
.PP
@@ -180,8 +195,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
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.pyShelf.BookDisplay" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.pyShelf.BookDisplay" 3 "Mon Aug 3 2020" "Version 0.6.0" "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
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.pyShelf.InitFiles" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.pyShelf.InitFiles" 3 "Mon Aug 3 2020" "Version 0.6.0" "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\&.

23
docs/man/man3/src_backend_lib_storage_Storage.3
View File

@@ -1,4 +1,4 @@
.TH "src.backend.lib.storage.Storage" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.lib.storage.Storage" 3 "Mon Aug 3 2020" "Version 0.6.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -30,6 +30,9 @@ src.backend.lib.storage.Storage
.ti -1c
.RI "def \fBclose\fP (self)"
.br
.ti -1c
.RI "def \fBmake_collections\fP (self)"
.br
.in -1c
.SS "Public Attributes"
@@ -60,16 +63,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 +81,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 +90,7 @@ Close database connection
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.commit ( self)"
.PP
@@ -96,7 +99,7 @@ Commit database transactions
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
@@ -104,7 +107,7 @@ Commit database transactions
Create table structure
.fi
.PP
.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.insert_book ( self, book)"
.PP
@@ -114,8 +117,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
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.config_test.TestConfig" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.config_test.TestConfig" 3 "Mon Aug 3 2020" "Version 0.6.0" "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
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.TestCatalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.TestCatalogue" 3 "Mon Aug 3 2020" "Version 0.6.0" "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\&.

52
docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.Test_Catalogue" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.Test_Catalogue" 3 "Mon Aug 3 2020" "Version 0.6.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -21,7 +21,13 @@ Inherits \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.RI "def \fBscan_folder\fP (self, _path=None)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.RI "def \fBprocess_by_filetype\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_metadata_epub\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_metadata_mobi\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
@@ -43,7 +49,10 @@ Inherits \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.RI "def \fBprocess_epub\fP (book)"
.br
.ti -1c
.RI "def \fBstripTags\fP (source)"
.br
.in -1c
.SS "Public Attributes"
@@ -65,6 +74,15 @@ Inherits \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_lvl2_regx\fP"
.br
.ti -1c
.RI "\fBtitle_sanitization_dirs_regx\fP"
.br
.ti -1c
.RI "\fBroot_dir\fP"
.br
.ti -1c
@@ -81,9 +99,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 +110,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 +119,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 +128,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,8 +137,8 @@ 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"
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata_epub ( self, book)\fC [inherited]\fP"
.PP
.nf
@@ -130,7 +148,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 +160,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,15 +173,15 @@ 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"
.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.process_epub ( book)\fC [static]\fP, \fC [inherited]\fP"
.PP
.nf
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 +190,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\&.

16
docs/man/man3/src_backend_tests_library_test_Test_Config.3
View File

@@ -1,4 +1,4 @@
.TH "src.backend.tests.library_test.Test_Config" 3 "Sun Feb 2 2020" "Version 0.4.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "src.backend.tests.library_test.Test_Config" 3 "Mon Aug 3 2020" "Version 0.6.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -17,6 +17,9 @@ Inherits \fBsrc\&.backend\&.lib\&.config\&.Config\fP\&.
.ti -1c
.RI "def \fBopen_file\fP (self, root='config\&.json')"
.br
.ti -1c
.RI "def \fBdjango_secret\fP (self, _data)"
.br
.in -1c
.SS "Public Attributes"
@@ -66,11 +69,14 @@ Inherits \fBsrc\&.backend\&.lib\&.config\&.Config\fP\&.
.ti -1c
.RI "\fBdb_pass\fP"
.br
.ti -1c
.RI "\fBSECRET\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 +85,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\&.