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

Added Doxygen doc files and config

Browse Source
This commit is contained in:
Mike
2019-11-10 01:28:33 -05:00
parent ff821099cc
commit 88d2d26983
83 changed files with 8796 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/man/man3/app_config_Config.3 Normal file
View File

@@ -0,0 +1,50 @@
.TH "app.config.Config" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.config.Config
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_path\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBcatalogue_db\fP"
.br
.ti -1c
.RI "\fBfile_array\fP"
.br
.ti -1c
.RI "\fBauto_scan\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Main System Configuration
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

50
docs/man/man3/app_lib_api_hooks_DuckDuckGo.3 Normal file
View File

@@ -0,0 +1,50 @@
.TH "app.lib.api_hooks.DuckDuckGo" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.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 app\&.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\&.

118
docs/man/man3/app_lib_display_Frontend.3 Normal file
View File

@@ -0,0 +1,118 @@
.TH "app.lib.display.Frontend" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.display.Frontend
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, dimensions=[0, 0])"
.br
.ti -1c
.RI "def \fBhtml_Headers\fP (self)"
.br
.ti -1c
.RI "def \fBapp_Headers\fP (self)"
.br
.ti -1c
.RI "def \fBapp_body\fP (self, nav, shelf)"
.br
.ti -1c
.RI "def \fBapp_footer\fP (self)"
.br
.ti -1c
.RI "def \fBcompile\fP (self, nav, shelf)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBdimensions\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Dynamic frontend display functions
.fi
.PP
.SH "Constructor & Destructor Documentation"
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.__init__ ( self, dimensions = \fC[0, 0]\fP)"
.PP
.nf
:param dimensions: array containing screen size [x, y]
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.app_body ( self, nav, shelf)"
.PP
.nf
Main interface body, and navigation
:param nav: nav[] system navigation list
:param shelf: shelf[0{path:"",title:"",cover:"",author:""}]
:returns _body: HTML render of page body
.fi
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.app_footer ( self)"
.PP
.nf
Main interface footer; Closes HTML
:returns _footer: HTML render of page footer
.fi
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.app_Headers ( self)"
.PP
.nf
App specific headers
:returns _head: HTML render of application specific headers
.fi
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.compile ( self, nav, shelf)"
.PP
.nf
Compiles user interface
:returns _ui: Compiled HTML for page layout
.fi
.PP
.SS "def app\&.lib\&.display\&.Frontend\&.html_Headers ( self)"
.PP
.nf
HTML headers
:returns _head: HTML render of page headers
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

123
docs/man/man3/app_lib_library_Catalogue.3 Normal file
View File

@@ -0,0 +1,123 @@
.TH "app.lib.library.Catalogue" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.library.Catalogue
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, folder=config\&.book_path)"
.br
.ti -1c
.RI "def \fBscan_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBprocess_book\fP (self, book)"
.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 "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 "\fBbooks\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Decodes and stores book information
.fi
.PP
.PP
.nf
Step One: filter_books.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.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 app\&.lib\&.library\&.Catalogue\&.filter_books ( self)"
.PP
.nf
Scan book folder recursively for epub files
filter_books(0) -> Catalogue.books
filter_books(1) -> self.books[]
:param ret: 0 -> create class property -> dump json
:param ret: 1 -> create & return class property
.fi
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.process_book ( self, book)"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.scan_book ( self, book)"
.PP
.nf
REMOVE ME?
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

102
docs/man/man3/app_lib_pyShelf_BookDisplay.3 Normal file
View File

@@ -0,0 +1,102 @@
.TH "app.lib.pyShelf.BookDisplay" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.BookDisplay
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.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
.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 app\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self)"
.PP
.nf
Initialize class variables
:return: None
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.PP
.nf
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.PP
.nf
Goto next book page
:return: new current_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.PP
.nf
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\&.

77
docs/man/man3/app_lib_pyShelf_BookServer.3 Normal file
View File

@@ -0,0 +1,77 @@
.TH "app.lib.pyShelf.BookServer" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.BookServer
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBclose_prompt\fP (self)"
.br
.ti -1c
.RI "def \fBrun\fP (self)"
.br
.ti -1c
.RI "def \fBclose\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBserver_address\fP"
.br
.ti -1c
.RI "\fBhandler\fP"
.br
.ti -1c
.RI "\fBhttpd\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
HTTP server functions required to display e-books
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookServer\&.close ( self)"
.PP
.nf
Stop HTTP Server
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookServer\&.close_prompt ( self)"
.PP
.nf
Prompt to close server
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookServer\&.run ( self)"
.PP
.nf
Start HTTP Server
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

41
docs/man/man3/app_lib_pyShelf_InitFiles.3 Normal file
View File

@@ -0,0 +1,41 @@
.TH "app.lib.pyShelf.InitFiles" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.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 app\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)"
.PP
.nf
Create the file
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

37
docs/man/man3/app_lib_pyShelf_RequestHandler.3 Normal file
View File

@@ -0,0 +1,37 @@
.TH "app.lib.pyShelf.RequestHandler" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.RequestHandler
.SH SYNOPSIS
.br
.PP
.PP
Inherits BaseHTTPRequestHandler\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBdo_GET\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBpath\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Request Handler
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

87
docs/man/man3/app_lib_storage_Storage.3 Normal file
View File

@@ -0,0 +1,87 @@
.TH "app.lib.storage.Storage" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.storage.Storage
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBdatabase\fP (self)"
.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 "\fBdb_file\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 app\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
.nf
Create table structure
.fi
.PP
.SS "def app\&.lib\&.storage\&.Storage\&.database ( self)"
.PP
.nf
Create database cursor
.fi
.PP
.SS "def app\&.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\&.