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

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