diff --git a/docs/html/HTML/D/index.html b/docs/html/HTML/D/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/FILEMAP b/docs/html/HTML/FILEMAP old mode 100755 new mode 100644 diff --git a/docs/html/HTML/GTAGSROOT b/docs/html/HTML/GTAGSROOT old mode 100755 new mode 100644 index 3da86ee..793be1c --- a/docs/html/HTML/GTAGSROOT +++ b/docs/html/HTML/GTAGSROOT @@ -1 +1 @@ -/home/raelon/Projects/pyShelf +/home/raelon/Projects/pyShelf/src diff --git a/docs/html/HTML/I/index.html b/docs/html/HTML/I/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/J/index.html b/docs/html/HTML/J/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/R/index.html b/docs/html/HTML/R/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/S/index.html b/docs/html/HTML/S/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/Y/index.html b/docs/html/HTML/Y/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/defines.html b/docs/html/HTML/defines.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/defines/index.html b/docs/html/HTML/defines/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/files.html b/docs/html/HTML/files.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/files/index.html b/docs/html/HTML/files/index.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/help.html b/docs/html/HTML/help.html old mode 100755 new mode 100644 diff --git a/docs/html/HTML/index.html b/docs/html/HTML/index.html old mode 100755 new mode 100644 index 8ec77e1..afb2c44 --- a/docs/html/HTML/index.html +++ b/docs/html/HTML/index.html @@ -10,7 +10,7 @@

pyShelf Open Source Ebook Server-0.2.1

-Last updated Sun Dec 01 12:33:10 EST 2019
+Last updated Sun Dec 01 13:06:42 EST 2019
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/mains.html b/docs/html/HTML/mains.html old mode 100755 new mode 100644 index 8ec77e1..afb2c44 --- a/docs/html/HTML/mains.html +++ b/docs/html/HTML/mains.html @@ -10,7 +10,7 @@

pyShelf Open Source Ebook Server-0.2.1

-Last updated Sun Dec 01 12:33:10 EST 2019
+Last updated Sun Dec 01 13:06:42 EST 2019
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/rebuild.sh b/docs/html/HTML/rebuild.sh index df349d3..d26cc13 100644 --- a/docs/html/HTML/rebuild.sh +++ b/docs/html/HTML/rebuild.sh @@ -5,4 +5,4 @@ # Usage: # % sh rebuild.sh # -cd /home/raelon/Projects/pyShelf && GTAGSCONF=':langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:skip=HTML/,HTML.pub/,tags,TAGS,ID,y.tab.c,y.tab.h,gtags.files,cscope.files,cscope.out,cscope.po.out,cscope.in.out,SCCS/,RCS/,CVS/,CVSROOT/,{arch}/,autom4te.cache/,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*_flymake.*,*_flymake,*.o,*.a,*.so,*.lo,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz,*.min.js,*min.css:' htags -g -s -a -n -v -w -t 'pyShelf Open Source Ebook Server-0.2.1' /home/raelon/Projects/pyShelf/docs/html +cd /home/raelon/Projects/pyShelf/src && GTAGSCONF=':langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:skip=HTML/,HTML.pub/,tags,TAGS,ID,y.tab.c,y.tab.h,gtags.files,cscope.files,cscope.out,cscope.po.out,cscope.in.out,SCCS/,RCS/,CVS/,CVSROOT/,{arch}/,autom4te.cache/,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*_flymake.*,*_flymake,*.o,*.a,*.so,*.lo,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz,*.min.js,*min.css:' htags -g -s -a -n -v -w -t 'pyShelf Open Source Ebook Server-0.2.1' /home/raelon/Projects/pyShelf/docs/html diff --git a/docs/html/annotated.html b/docs/html/annotated.html old mode 100755 new mode 100644 index e4f6aac..fbde317 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -45,30 +45,45 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 1234]
- - - - - - - - - - - - - - - - - +
[detail level 123456]
 ▼Napp
 ▼Nconfig
 CConfig
 ▼Nlib
 ▼Napi_hooks
 CDuckDuckGo
 ▼Ndisplay
 CFrontend
 ▼Nlibrary
 CCatalogue
 ▼NpyShelf
 CBookDisplay
 CBookServer
 CInitFiles
 CRequestHandler
 ▼Nstorage
 CStorage
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼NpyShelf
 ▼Nsrc
 ▼Nbackend
 ▼Nlib
 ▼Napi_hooks
 CDuckDuckGo
 ▼Nconfig
 CConfig
 ▼Nlibrary
 CCatalogue
 ▼NpyShelf
 CBookDisplay
 CInitFiles
 ▼Nstorage
 CStorage
 ▼Ntests
 ▼Nconfig_test
 CTestConfig
 ▼Nlibrary_test
 CTest_Catalogue
 CTest_Config
 CTestCatalogue
 ▼Nfrontend
 ▼Ninterface
 ▼Napps
 CInterfaceConfig
 ▼Nmigrations
 ▼N0001_initial
 CMigration
 ▼Nmodels
 ▼CBooks
 CMeta
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/bc_s.png b/docs/html/bc_s.png old mode 100755 new mode 100644 diff --git a/docs/html/bdwn.png b/docs/html/bdwn.png old mode 100755 new mode 100644 diff --git a/docs/html/classapp_1_1config_1_1Config-members.html b/docs/html/classapp_1_1config_1_1Config-members.html deleted file mode 100755 index 0a78d67..0000000 --- a/docs/html/classapp_1_1config_1_1Config-members.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.config.Config Member List
-
-
- -

This is the complete list of members for app.config.Config, including all inherited members.

- - - - - - - - -
__init__(self) (defined in app.config.Config)app.config.Config
auto_scan (defined in app.config.Config)app.config.Config
book_path (defined in app.config.Config)app.config.Config
book_shelf (defined in app.config.Config)app.config.Config
catalogue_db (defined in app.config.Config)app.config.Config
file_array (defined in app.config.Config)app.config.Config
TITLE (defined in app.config.Config)app.config.Config
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1config_1_1Config.html b/docs/html/classapp_1_1config_1_1Config.html deleted file mode 100755 index 044db30..0000000 --- a/docs/html/classapp_1_1config_1_1Config.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: app.config.Config Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
app.config.Config Class Reference
-
-
- - - - -

-Public Member Functions

-def __init__ (self)
 
- - - - - - - - - - - - - -

-Public Attributes

- book_path
 
- TITLE
 
- book_shelf
 
- catalogue_db
 
- file_array
 
- auto_scan
 
-

Detailed Description

-
Main System Configuration
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html b/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html deleted file mode 100755 index dfd3cbc..0000000 --- a/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.lib.display.Frontend Member List
-
-
- -

This is the complete list of members for app.lib.display.Frontend, including all inherited members.

- - - - - - - - - -
__init__(self, dimensions=[0, 0])app.lib.display.Frontend
app_body(self, nav, shelf)app.lib.display.Frontend
app_footer(self)app.lib.display.Frontend
app_Headers(self)app.lib.display.Frontend
compile(self, nav, shelf)app.lib.display.Frontend
dimensions (defined in app.lib.display.Frontend)app.lib.display.Frontend
html_Headers(self)app.lib.display.Frontend
TITLE (defined in app.lib.display.Frontend)app.lib.display.Frontend
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html b/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html deleted file mode 100755 index e6e3239..0000000 --- a/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html +++ /dev/null @@ -1,257 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: app.lib.display.Frontend Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
app.lib.display.Frontend Class Reference
-
-
- - - - - - - - - - - - - - -

-Public Member Functions

def __init__ (self, dimensions=[0, 0])
 
def html_Headers (self)
 
def app_Headers (self)
 
def app_body (self, nav, shelf)
 
def app_footer (self)
 
def compile (self, nav, shelf)
 
- - - - - -

-Public Attributes

- dimensions
 
- TITLE
 
-

Detailed Description

-
Dynamic frontend display functions

Constructor & Destructor Documentation

- -

◆ __init__()

- -
-
- - - - - - - - - - - - - - - - - - -
def app.lib.display.Frontend.__init__ ( self,
 dimensions = [0, 0] 
)
-
-
:param dimensions: array containing screen size [x, y]
-
-
-
-

Member Function Documentation

- -

◆ app_body()

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
def app.lib.display.Frontend.app_body ( self,
 nav,
 shelf 
)
-
-
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
-
-
-
- -

◆ app_footer()

- -
-
- - - - - - - - -
def app.lib.display.Frontend.app_footer ( self)
-
-
Main interface footer; Closes HTML
-:returns _footer: HTML render of page footer
-
-
-
- -

◆ app_Headers()

- -
-
- - - - - - - - -
def app.lib.display.Frontend.app_Headers ( self)
-
-
App specific headers
-:returns _head: HTML render of application specific headers
-
-
-
- -

◆ compile()

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - -
def app.lib.display.Frontend.compile ( self,
 nav,
 shelf 
)
-
-
Compiles user interface
-:returns _ui: Compiled HTML for page layout
-
-
-
- -

◆ html_Headers()

- -
-
- - - - - - - - -
def app.lib.display.Frontend.html_Headers ( self)
-
-
HTML headers
-:returns _head: HTML render of page headers
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html deleted file mode 100755 index e68e270..0000000 --- a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.lib.library.Catalogue Member List
-
-
- -

This is the complete list of members for app.lib.library.Catalogue, including all inherited members.

- - - - - - - - - - - - - - - - - -
__init__(self) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
books (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
compare_shelf_current(self) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
cover_regx (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
extract_content(self, book_zip, book) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
extract_cover_html(self, book_zip, book) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
extract_cover_image(self, book_zip, book) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
extract_metadata(self, book)app.lib.library.Catalogue
file_list (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
filter_books(self)app.lib.library.Catalogue
html_regx (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
import_books(self, list=None) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
opf_regx (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
process_book(self, book)app.lib.library.Catalogue
scan_book(self, book)app.lib.library.Catalogue
scan_folder(self, folder=config.book_path) (defined in app.lib.library.Catalogue)app.lib.library.Catalogue
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html b/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html deleted file mode 100755 index f1886d7..0000000 --- a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: app.lib.library.Catalogue Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
app.lib.library.Catalogue Class Reference
-
-
- - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

-def __init__ (self)
 
-def scan_folder (self, folder=config.book_path)
 
def scan_book (self, book)
 
def filter_books (self)
 
def process_book (self, book)
 
def extract_metadata (self, book)
 
-def extract_content (self, book_zip, book)
 
-def extract_cover_html (self, book_zip, book)
 
-def extract_cover_image (self, book_zip, book)
 
-def compare_shelf_current (self)
 
-def import_books (self, list=None)
 
- - - - - - - - - - - -

-Public Attributes

- file_list
 
- opf_regx
 
- cover_regx
 
- html_regx
 
- books
 
-

Detailed Description

-
Decodes and stores book information
Step One: filter_books

Member Function Documentation

- -

◆ extract_metadata()

- -
-
- - - - - - - - - - - - - - - - - - -
def app.lib.library.Catalogue.extract_metadata ( self,
 book 
)
-
-
Return extracted metadata and cover picture
-book['path'] == Full path to ebook file
-book['files'] == list of files from self.process_book(book)
-
-
-
- -

◆ filter_books()

- -
-
- - - - - - - - -
def app.lib.library.Catalogue.filter_books ( self)
-
-
    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
-
-
-
- -

◆ process_book()

- -
-
- - - - - - - - - - - - - - - - - - -
def app.lib.library.Catalogue.process_book ( self,
 book 
)
-
-
Return dictionary of epub file contents
-
-
- -

◆ scan_book()

- -
-
- - - - - - - - - - - - - - - - - - -
def app.lib.library.Catalogue.scan_book ( self,
 book 
)
-
-
REMOVE ME?
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html deleted file mode 100755 index 4553e03..0000000 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.lib.pyShelf.BookDisplay Member List
-
-
- -

This is the complete list of members for app.lib.pyShelf.BookDisplay, including all inherited members.

- - - - - - - - - - -
__init__(self)app.lib.pyShelf.BookDisplay
books_per_page (defined in app.lib.pyShelf.BookDisplay)app.lib.pyShelf.BookDisplay
booksPerPage(self, screen_size)app.lib.pyShelf.BookDisplay
current_page (defined in app.lib.pyShelf.BookDisplay)app.lib.pyShelf.BookDisplay
nextPage(self)app.lib.pyShelf.BookDisplay
previousPage(self)app.lib.pyShelf.BookDisplay
thumbnail_scale (defined in app.lib.pyShelf.BookDisplay)app.lib.pyShelf.BookDisplay
thumbnail_size (defined in app.lib.pyShelf.BookDisplay)app.lib.pyShelf.BookDisplay
total_pages (defined in app.lib.pyShelf.BookDisplay)app.lib.pyShelf.BookDisplay
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html deleted file mode 100755 index 9521817..0000000 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.lib.pyShelf.BookServer Member List
-
-
- -

This is the complete list of members for app.lib.pyShelf.BookServer, including all inherited members.

- - - - - - - - -
__init__(self) (defined in app.lib.pyShelf.BookServer)app.lib.pyShelf.BookServer
close(self)app.lib.pyShelf.BookServer
close_prompt(self)app.lib.pyShelf.BookServer
handler (defined in app.lib.pyShelf.BookServer)app.lib.pyShelf.BookServer
httpd (defined in app.lib.pyShelf.BookServer)app.lib.pyShelf.BookServer
run(self)app.lib.pyShelf.BookServer
server_address (defined in app.lib.pyShelf.BookServer)app.lib.pyShelf.BookServer
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html deleted file mode 100755 index 98764ae..0000000 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: app.lib.pyShelf.BookServer Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
app.lib.pyShelf.BookServer Class Reference
-
-
- - - - - - - - - - -

-Public Member Functions

-def __init__ (self)
 
def close_prompt (self)
 
def run (self)
 
def close (self)
 
- - - - - - - -

-Public Attributes

- server_address
 
- handler
 
- httpd
 
-

Detailed Description

-
HTTP server functions required to display e-books
-

Member Function Documentation

- -

◆ close()

- -
-
- - - - - - - - -
def app.lib.pyShelf.BookServer.close ( self)
-
-
Stop HTTP Server
-
-
- -

◆ close_prompt()

- -
-
- - - - - - - - -
def app.lib.pyShelf.BookServer.close_prompt ( self)
-
-
Prompt to close server
-
-
- -

◆ run()

- -
-
- - - - - - - - -
def app.lib.pyShelf.BookServer.run ( self)
-
-
Start HTTP Server
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png b/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png deleted file mode 100755 index 1dc1265..0000000 Binary files a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png and /dev/null differ diff --git a/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html deleted file mode 100755 index 130aa15..0000000 --- a/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
app.lib.storage.Storage Member List
-
-
- -

This is the complete list of members for app.lib.storage.Storage, including all inherited members.

- - - - - - - - - - - -
__init__(self) (defined in app.lib.storage.Storage)app.lib.storage.Storage
book_paths_list(self) (defined in app.lib.storage.Storage)app.lib.storage.Storage
close(self) (defined in app.lib.storage.Storage)app.lib.storage.Storage
commit(self) (defined in app.lib.storage.Storage)app.lib.storage.Storage
create_tables(self)app.lib.storage.Storage
cursor (defined in app.lib.storage.Storage)app.lib.storage.Storage
database(self)app.lib.storage.Storage
db (defined in app.lib.storage.Storage)app.lib.storage.Storage
db_file (defined in app.lib.storage.Storage)app.lib.storage.Storage
insert_book(self, book)app.lib.storage.Storage
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html b/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html deleted file mode 100755 index 5e4c61f..0000000 --- a/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: app.lib.storage.Storage Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.1.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
app.lib.storage.Storage Class Reference
-
-
- - - - - - - - - - - - - - - - -

-Public Member Functions

-def __init__ (self)
 
def database (self)
 
def create_tables (self)
 
def insert_book (self, book)
 
-def book_paths_list (self)
 
-def commit (self)
 
-def close (self)
 
- - - - - - - -

-Public Attributes

- db_file
 
- db
 
- cursor
 
-

Detailed Description

-
Contains all methods for system storage

Member Function Documentation

- -

◆ create_tables()

- -
-
- - - - - - - - -
def app.lib.storage.Storage.create_tables ( self)
-
-
Create table structure
-
-
- -

◆ database()

- -
-
- - - - - - - - -
def app.lib.storage.Storage.database ( self)
-
-
Create database cursor
-
-
- -

◆ insert_book()

- -
-
- - - - - - - - - - - - - - - - - - -
def app.lib.storage.Storage.insert_book ( self,
 book 
)
-
-
Insert book in database
-:returns: True if succeeds False if not
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classes.html b/docs/html/classes.html old mode 100755 new mode 100644 index 5d9cb4e..1faa582 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -44,45 +44,51 @@ $(function() {
Class Index
-
b | c | d | f | i | r | s
+
b | c | d | i | m | s | t
- - + + - - + - - - - - - - - + + + + + + + + - + + - + + - - + + - + + +
  b  
Config (app.config)   
  i  
+		Config (pyShelf.src.backend.lib.config)   InterfaceConfig (pyShelf.src.interface.apps)   
  t  
  s  
-
  d  
BookDisplay (app.lib.pyShelf)   InitFiles (app.lib.pyShelf)   Storage (app.lib.storage)   
BookServer (app.lib.pyShelf)   DuckDuckGo (app.lib.api_hooks)   
  r  
+
  m  
BookDisplay (pyShelf.src.backend.lib.pyShelf)   Test_Catalogue (pyShelf.src.backend.tests.library_test)   
Books (pyShelf.src.interface.models)   DuckDuckGo (pyShelf.src.backend.lib.api_hooks)   Books.Meta (pyShelf.src.interface.models)   Test_Config (pyShelf.src.backend.tests.library_test)   
  c  
  f  
+
  i  
Migration (pyShelf.src.interface.migrations.0001_initial)   TestCatalogue (pyShelf.src.backend.tests.library_test)   
RequestHandler (app.lib.pyShelf)   
  s  
+		TestConfig (pyShelf.src.backend.tests.config_test)   
Catalogue (app.lib.library)   Frontend (app.lib.display)   
Catalogue (pyShelf.src.backend.lib.library)   InitFiles (pyShelf.src.backend.lib.pyShelf)   
Storage (pyShelf.src.backend.lib.storage)   
-
b | c | d | f | i | r | s
+
b | c | d | i | m | s | t
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html new file mode 100644 index 0000000..d8b0efd --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html @@ -0,0 +1,65 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.lib.api_hooks.DuckDuckGo, including all inherited members.

+ + + + +
__init__(self) (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
image_result(self, query)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
url (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html old mode 100755 new mode 100644 similarity index 65% rename from docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html rename to docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html index 6edec3e..e48a24f --- a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app.lib.api_hooks.DuckDuckGo Class Reference +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,43 +40,43 @@ $(function() {
Public Member Functions | Public Attributes | -List of all members
+List of all members
-
app.lib.api_hooks.DuckDuckGo Class Reference
+
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference
- - - - + + +

Public Member Functions

+
def __init__ (self)
 
def image_result (self, query)
 
 
def image_result (self, query)
 
- - +

Public Attributes

+
 url
 
 

Detailed Description

duckduckgo related searching

Member Function Documentation

- -

◆ image_result()

+ +

◆ image_result()

- + @@ -100,12 +100,12 @@ Public Attributes
The documentation for this class was generated from the following file:
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html new file mode 100644 index 0000000..ad759df --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html @@ -0,0 +1,74 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+
def app.lib.api_hooks.DuckDuckGo.image_result def pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result (   self,
+ + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.config.Config Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.lib.config.Config, including all inherited members.

+ + + + + + + + + + + + + +
__init__(self, root) (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, _cp)pyShelf.src.backend.lib.config.Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html new file mode 100644 index 0000000..89327a0 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html @@ -0,0 +1,153 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.config.Config Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
pyShelf.src.backend.lib.config.Config Class Reference
+
+
+
+ + Inheritance diagram for pyShelf.src.backend.lib.config.Config:
+
+
+ + + + + + + +

+Public Member Functions

+def __init__ (self, root)
 
def open_file (self, _cp)
 
+ + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ book_path
 
+ TITLE
 
+ VERSION
 
+ book_shelf
 
+ catalogue_db
 
+ user
 
+ password
 
+ file_array
 
+ root
 
+ auto_scan
 
+

Detailed Description

+
Main System Configuration
+

Member Function Documentation

+ +

◆ open_file()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.config.Config.open_file ( self,
 _cp 
)
+
+
Opens config.json and reads in configuration options
+
+

Reimplemented in pyShelf.src.backend.tests.library_test.Test_Config.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png new file mode 100644 index 0000000..b7d4d5a Binary files /dev/null and b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png differ diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html new file mode 100644 index 0000000..1a26e88 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html @@ -0,0 +1,82 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.library.Catalogue Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.lib.library.Catalogue, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
__init__(self, config) (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_folder (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_shelf (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
books (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
compare_shelf_current(self)pyShelf.src.backend.lib.library.Catalogue
config (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
cover_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
db_pointer (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_metadata(self, book)pyShelf.src.backend.lib.library.Catalogue
file_list (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
filter_books(self)pyShelf.src.backend.lib.library.Catalogue
html_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
import_books(self, list=None)pyShelf.src.backend.lib.library.Catalogue
opf_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
process_book(book)pyShelf.src.backend.lib.library.Cataloguestatic
root_dir (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
scan_folder(self, _path=None)pyShelf.src.backend.lib.library.Catalogue
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html new file mode 100644 index 0000000..96079ef --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html @@ -0,0 +1,407 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.library.Catalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
pyShelf.src.backend.lib.library.Catalogue Class Reference
+
+
+
+ + Inheritance diagram for pyShelf.src.backend.lib.library.Catalogue:
+
+
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+def __init__ (self, config)
 
def scan_folder (self, _path=None)
 
def filter_books (self)
 
def extract_metadata (self, book)
 
def extract_content (self, book_zip, book)
 
def extract_cover_html (self, book_zip, book)
 
def extract_cover_image (self, book_zip, book)
 
def compare_shelf_current (self)
 
def import_books (self, list=None)
 
+ + + +

+Static Public Member Functions

def process_book (book)
 
+ + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ file_list
 
+ opf_regx
 
+ cover_regx
 
+ html_regx
 
+ root_dir
 
+ book_folder
 
+ book_shelf
 
+ books
 
+ db_pointer
 
+ config
 
+

Detailed Description

+
Decodes book metadata for storage
+

Member Function Documentation

+ +

◆ compare_shelf_current()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current ( self)
+
+
Calls storage system, gets list of books stored and compares against files on disk
+
+
+
+ +

◆ extract_content()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_content ( self,
 book_zip,
 book 
)
+
+
Opens epub as zip file filters then stores as list any files matching opf_regx
+
+
+
+ +

◆ extract_cover_html()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_cover_html ( self,
 book_zip,
 book 
)
+
+
Opens epub as zip file filters then stores as list any files matching html_regx
+
+
+
+ +

◆ extract_cover_image()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_cover_image ( self,
 book_zip,
 book 
)
+
+
Opens epub as zip file filters then stores as list any files matching cover_regx
+
+
+
+ +

◆ extract_metadata()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_metadata ( self,
 book 
)
+
+
Return extracted metadata and cover picture
+book['path'] == Full path to ebook file
+book['files'] == list of files from self.process_book(book)
+
+
+
+ +

◆ filter_books()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.filter_books ( self)
+
+
Calls scan_folder and filters out book files
+Proceeds to call process_book
+
+:returns self._book_list_expanded: json string containing all book metadata
+
+

Reimplemented in pyShelf.src.backend.tests.library_test.Test_Catalogue.

+ +
+
+ +

◆ import_books()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.import_books ( self,
 list = None 
)
+
+
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.
+
+
+
+ +

◆ process_book()

+ +
+
+ + + + + +
+ + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.process_book ( book)
+ 		+static
+
+
Return dictionary of epub file contents
+
+
+ +

◆ scan_folder()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.scan_folder ( self,
 _path = None 
)
+
+
Scan folder by _path, allows recurisive scanning
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png new file mode 100644 index 0000000..9198213 Binary files /dev/null and b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png differ diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html new file mode 100644 index 0000000..1c66a7e --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html @@ -0,0 +1,72 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.pyShelf.BookDisplay Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.lib.pyShelf.BookDisplay, including all inherited members.

+ + + + + + + + + + + +
__init__(self, **kwargs)pyShelf.src.backend.lib.pyShelf.BookDisplay
books_per_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
booksPerPage(self, screen_size)pyShelf.src.backend.lib.pyShelf.BookDisplay
current_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
nextPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
previousPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
screen_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_scale (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
total_pages (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html old mode 100755 new mode 100644 similarity index 51% rename from docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html rename to docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html index e28a867..b4356ef --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app.lib.pyShelf.BookDisplay Class Reference +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,62 +40,75 @@ $(function() {
Public Member Functions | Public Attributes | -List of all members
+List of all members
-
app.lib.pyShelf.BookDisplay Class Reference
+
pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference
- - - - - - - - + + + + + + + +

Public Member Functions

def __init__ (self)
 
def nextPage (self)
 
def previousPage (self)
 
def booksPerPage (self, screen_size)
 
def __init__ (self, **kwargs)
 
def nextPage (self)
 
def previousPage (self)
 
def booksPerPage (self, screen_size)
 
- - - + - - + - - + - - + - + + +

Public Attributes

+
 books_per_page
 
+
 
 current_page
 
+
 
 thumbnail_size
 
+
 
 thumbnail_scale
 
+
 
 total_pages
 
 
+ screen_size
 

Detailed Description

All functions related to displaying book information in the HTML UI

Constructor & Destructor Documentation

- -

◆ __init__()

+ +

◆ __init__()

- + - + + + + + + + + + + +
def app.lib.pyShelf.BookDisplay.__init__ def pyShelf.src.backend.lib.pyShelf.BookDisplay.__init__ (  self)self,
** kwargs 
)
@@ -105,14 +118,14 @@ Public Attributes

Member Function Documentation

- -

◆ booksPerPage()

+ +

◆ booksPerPage()

- + @@ -130,21 +143,21 @@ Public Attributes
def app.lib.pyShelf.BookDisplay.booksPerPage def pyShelf.src.backend.lib.pyShelf.BookDisplay.booksPerPage (   self,
-
Set books per page
-
+
## TODO Remove me
+Set books per page
 :param screen_size: Array containing x,y pixel sizes
 :return: self.books_per_page
- -

◆ nextPage()

+ +

◆ nextPage()

- + @@ -152,19 +165,20 @@ Public Attributes
def app.lib.pyShelf.BookDisplay.nextPage def pyShelf.src.backend.lib.pyShelf.BookDisplay.nextPage (   self)
-
Goto next book page
+
## TODO Remove me
+Goto next book page
 :return: new current_page
- -

◆ previousPage()

+ +

◆ previousPage()

- + @@ -172,18 +186,19 @@ Public Attributes
def app.lib.pyShelf.BookDisplay.previousPage def pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage (   self)
-
Goto previous book page
+
## TODO Remove me
+Goto previous book page
 :return: new current_page
The documentation for this class was generated from the following file:
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html old mode 100755 new mode 100644 similarity index 57% rename from docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html rename to docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html index be81301..2c162ed --- a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,24 +40,23 @@ $(function() {
-
app.lib.api_hooks.DuckDuckGo Member List
+
pyShelf.src.backend.lib.pyShelf.InitFiles Member List
-

This is the complete list of members for app.lib.api_hooks.DuckDuckGo, including all inherited members.

+

This is the complete list of members for pyShelf.src.backend.lib.pyShelf.InitFiles, including all inherited members.

- - - + +
__init__(self) (defined in app.lib.api_hooks.DuckDuckGo)app.lib.api_hooks.DuckDuckGo
image_result(self, query)app.lib.api_hooks.DuckDuckGo
url (defined in app.lib.api_hooks.DuckDuckGo)app.lib.api_hooks.DuckDuckGo
__init__(self, file_array) (defined in pyShelf.src.backend.lib.pyShelf.InitFiles)pyShelf.src.backend.lib.pyShelf.InitFiles
CreateFile(self, _pointer)pyShelf.src.backend.lib.pyShelf.InitFiles
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html old mode 100755 new mode 100644 similarity index 65% rename from docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles.html rename to docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html index d0428d4..d19e4a4 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles.html +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app.lib.pyShelf.InitFiles Class Reference +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,36 +40,36 @@ $(function() {
Public Member Functions | -List of all members
+List of all members
-
app.lib.pyShelf.InitFiles Class Reference
+
pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference
- - - - + + +

Public Member Functions

+
def __init__ (self, file_array)
 
def CreateFile (self, _pointer)
 
 
def CreateFile (self, _pointer)
 

Detailed Description

First run file creation operations

Member Function Documentation

- -

◆ CreateFile()

+ +

◆ CreateFile()

- + @@ -87,16 +87,17 @@ def 
def app.lib.pyShelf.InitFiles.CreateFile def pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile (   self, __init__ (self, fi
-
Create the file
+
Checks if file exists and creates it if not
+
The documentation for this class was generated from the following file:
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html new file mode 100644 index 0000000..784ff73 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html @@ -0,0 +1,74 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.storage.Storage Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.lib.storage.Storage, including all inherited members.

+ + + + + + + + + + + + + +
__init__(self, db_pointer, config) (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
book_paths_list(self)pyShelf.src.backend.lib.storage.Storage
close(self)pyShelf.src.backend.lib.storage.Storage
commit(self)pyShelf.src.backend.lib.storage.Storage
create_tables(self)pyShelf.src.backend.lib.storage.Storage
cursor (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
database(self)pyShelf.src.backend.lib.storage.Storage
db (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
insert_book(self, book)pyShelf.src.backend.lib.storage.Storage
password (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
sql (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
user (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html new file mode 100644 index 0000000..4f6a4dd --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html @@ -0,0 +1,228 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.storage.Storage Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
pyShelf.src.backend.lib.storage.Storage Class Reference
+
+
+ + + + + + + + + + + + + + + + +

+Public Member Functions

+def __init__ (self, db_pointer, config)
 
def database (self)
 
def create_tables (self)
 
def insert_book (self, book)
 
def book_paths_list (self)
 
def commit (self)
 
def close (self)
 
+ + + + + + + + + + + +

+Public Attributes

+ sql
 
+ user
 
+ password
 
+ db
 
+ cursor
 
+

Detailed Description

+
Contains all methods for system storage

Member Function Documentation

+ +

◆ book_paths_list()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.book_paths_list ( self)
+
+
Get file paths from database for comparison to system files
+
+
+
+ +

◆ close()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.close ( self)
+
+
Close database connection
+
+
+
+ +

◆ commit()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.commit ( self)
+
+
Commit database transactions
+
+
+
+ +

◆ create_tables()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.create_tables ( self)
+
+
Create table structure
+
+
+ +

◆ database()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.database ( self)
+
+
Create database cursor
+
+
+ +

◆ insert_book()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.storage.Storage.insert_book ( self,
 book 
)
+
+
Insert book in database
+:returns: True if succeeds False if not
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html new file mode 100644 index 0000000..fcd6810 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html @@ -0,0 +1,66 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.config_test.TestConfig Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.tests.config_test.TestConfig, including all inherited members.

+ + + + + +
config (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfigstatic
test_book_dir(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_title(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_version(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html new file mode 100644 index 0000000..e2ae1ba --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html @@ -0,0 +1,86 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.config_test.TestConfig Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Attributes | +List of all members
+
+
pyShelf.src.backend.tests.config_test.TestConfig Class Reference
+
+
+ + + + + + + + +

+Public Member Functions

+def test_book_dir (self)
 
+def test_title (self)
 
+def test_version (self)
 
+ + + +

+Static Public Attributes

+ config = Config(os.path.abspath(os.path.curdir))
 
+

Detailed Description

+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html new file mode 100644 index 0000000..cd11f3d --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html @@ -0,0 +1,65 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.library_test.TestCatalogue Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.tests.library_test.TestCatalogue, including all inherited members.

+ + + + +
config (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
root (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
test_filter_books(self) (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCatalogue
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html new file mode 100644 index 0000000..2183d63 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html @@ -0,0 +1,83 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Attributes | +List of all members
+
+
pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference
+
+
+ + + + +

+Public Member Functions

+def test_filter_books (self)
 
+ + + + + +

+Static Public Attributes

+ root = os.path.abspath(os.path.curdir)
 
+ config = Test_Config()
 
+

Detailed Description

+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html new file mode 100644 index 0000000..e1a0870 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html @@ -0,0 +1,83 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.library_test.Test_Catalogue Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.tests.library_test.Test_Catalogue, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
__init__(self) (defined in pyShelf.src.backend.tests.library_test.Test_Catalogue)pyShelf.src.backend.tests.library_test.Test_Catalogue
__init__(self, config) (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_folder (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_shelf (defined in pyShelf.src.backend.tests.library_test.Test_Catalogue)pyShelf.src.backend.tests.library_test.Test_Catalogue
books (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
compare_shelf_current(self)pyShelf.src.backend.lib.library.Catalogue
config (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
cover_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
db_pointer (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_metadata(self, book)pyShelf.src.backend.lib.library.Catalogue
file_list (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
filter_books(self)pyShelf.src.backend.tests.library_test.Test_Catalogue
html_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
import_books(self, list=None)pyShelf.src.backend.lib.library.Catalogue
opf_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
process_book(book)pyShelf.src.backend.lib.library.Cataloguestatic
root_dir (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
scan_folder(self, _path=None)pyShelf.src.backend.lib.library.Catalogue
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html new file mode 100644 index 0000000..98368a1 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html @@ -0,0 +1,462 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference
+
+
+
+ + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Catalogue:
+
+
+ + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+def __init__ (self)
 
def filter_books (self)
 
def scan_folder (self, _path=None)
 
def extract_metadata (self, book)
 
def extract_content (self, book_zip, book)
 
def extract_cover_html (self, book_zip, book)
 
def extract_cover_image (self, book_zip, book)
 
def compare_shelf_current (self)
 
def import_books (self, list=None)
 
+ + + +

+Static Public Member Functions

def process_book (book)
 
+ + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ book_shelf
 
+ file_list
 
+ opf_regx
 
+ cover_regx
 
+ html_regx
 
+ root_dir
 
+ book_folder
 
+ books
 
+ db_pointer
 
+ config
 
+

Detailed Description

+

Member Function Documentation

+ +

◆ compare_shelf_current()

+ +
+
+ + + + + +
+ + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current ( self)
+ 		+inherited
+
+
Calls storage system, gets list of books stored and compares against files on disk
+
+
+
+ +

◆ extract_content()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_content ( self,
 book_zip,
 book 
)
+ 		+inherited
+
+
Opens epub as zip file filters then stores as list any files matching opf_regx
+
+
+
+ +

◆ extract_cover_html()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_cover_html ( self,
 book_zip,
 book 
)
+ 		+inherited
+
+
Opens epub as zip file filters then stores as list any files matching html_regx
+
+
+
+ +

◆ extract_cover_image()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_cover_image ( self,
 book_zip,
 book 
)
+ 		+inherited
+
+
Opens epub as zip file filters then stores as list any files matching cover_regx
+
+
+
+ +

◆ extract_metadata()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.extract_metadata ( self,
 book 
)
+ 		+inherited
+
+
Return extracted metadata and cover picture
+book['path'] == Full path to ebook file
+book['files'] == list of files from self.process_book(book)
+
+
+
+ +

◆ filter_books()

+ +
+
+ + + + + + + + +
def pyShelf.src.backend.tests.library_test.Test_Catalogue.filter_books ( self)
+
+
Calls scan_folder and filters out book files
+Proceeds to call process_book
+
+:returns self._book_list_expanded: json string containing all book metadata
+
+

Reimplemented from pyShelf.src.backend.lib.library.Catalogue.

+ +
+
+ +

◆ import_books()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.import_books ( self,
 list = None 
)
+ 		+inherited
+
+
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.
+
+
+
+ +

◆ process_book()

+ +
+
+ + + + + +
+ + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.process_book ( book)
+ 		+staticinherited
+
+
Return dictionary of epub file contents
+
+
+ +

◆ scan_folder()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.lib.library.Catalogue.scan_folder ( self,
 _path = None 
)
+ 		+inherited
+
+
Scan folder by _path, allows recurisive scanning
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png new file mode 100644 index 0000000..33ae867 Binary files /dev/null and b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png differ diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html new file mode 100644 index 0000000..042bcd5 --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html @@ -0,0 +1,75 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.library_test.Test_Config Member List
+
+
+ +

This is the complete list of members for pyShelf.src.backend.tests.library_test.Test_Config, including all inherited members.

+ + + + + + + + + + + + + + +
__init__(self) (defined in pyShelf.src.backend.tests.library_test.Test_Config)pyShelf.src.backend.tests.library_test.Test_Config
__init__(self, root) (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, root="config.json")pyShelf.src.backend.tests.library_test.Test_Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html new file mode 100644 index 0000000..d2ce3ae --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html @@ -0,0 +1,152 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.Test_Config Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
pyShelf.src.backend.tests.library_test.Test_Config Class Reference
+
+
+
+ + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Config:
+
+
+ + + + + + + +

+Public Member Functions

+def __init__ (self)
 
def open_file (self, root="config.json")
 
+ + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ book_path
 
+ TITLE
 
+ VERSION
 
+ book_shelf
 
+ catalogue_db
 
+ user
 
+ password
 
+ file_array
 
+ root
 
+ auto_scan
 
+

Detailed Description

+

Member Function Documentation

+ +

◆ open_file()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def pyShelf.src.backend.tests.library_test.Test_Config.open_file ( self,
 _cp = "config.json" 
)
+
+
Opens config.json and reads in configuration options
+
+

Reimplemented from pyShelf.src.backend.lib.config.Config.

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png new file mode 100644 index 0000000..f564331 Binary files /dev/null and b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png differ diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html old mode 100755 new mode 100644 similarity index 62% rename from docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html rename to docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html index 82b4f48..5431719 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html +++ b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,23 +40,22 @@ $(function() {
-
app.lib.pyShelf.InitFiles Member List
+
pyShelf.src.interface.apps.InterfaceConfig Member List
-

This is the complete list of members for app.lib.pyShelf.InitFiles, including all inherited members.

+

This is the complete list of members for pyShelf.src.interface.apps.InterfaceConfig, including all inherited members.

- - +
__init__(self, file_array) (defined in app.lib.pyShelf.InitFiles)app.lib.pyShelf.InitFiles
CreateFile(self, _pointer)app.lib.pyShelf.InitFiles
name (defined in pyShelf.src.interface.apps.InterfaceConfig)pyShelf.src.interface.apps.InterfaceConfigstatic
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html old mode 100755 new mode 100644 similarity index 55% rename from docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html rename to docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html index def0079..1f02588 --- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html +++ b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app.lib.pyShelf.RequestHandler Class Reference +pyShelf Open Source Ebook Server: pyShelf.src.interface.apps.InterfaceConfig Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,47 +40,40 @@ $(function() {
-Public Member Functions | -Public Attributes | -List of all members
+Static Public Attributes | +List of all members
-
app.lib.pyShelf.RequestHandler Class Reference
+
pyShelf.src.interface.apps.InterfaceConfig Class Reference
- + Inheritance diagram for app.lib.pyShelf.RequestHandler:
+ + Inheritance diagram for pyShelf.src.interface.apps.InterfaceConfig:
- - - -

-Public Member Functions

-def do_GET (self)
 
- - - + + +

-Public Attributes

- path
 

+Static Public Attributes

+string name = "interface"
 

Detailed Description

-
Request Handler
The documentation for this class was generated from the following file:
-
app.lib.pyShelf.RequestHandler Member List
+
pyShelf.src.interface.models.Books.Meta Member List
-

This is the complete list of members for app.lib.pyShelf.RequestHandler, including all inherited members.

+

This is the complete list of members for pyShelf.src.interface.models.Books.Meta, including all inherited members.

- - +
do_GET(self) (defined in app.lib.pyShelf.RequestHandler)app.lib.pyShelf.RequestHandler
path (defined in app.lib.pyShelf.RequestHandler)app.lib.pyShelf.RequestHandler
db_table (defined in pyShelf.src.interface.models.Books.Meta)pyShelf.src.interface.models.Books.Metastatic
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html new file mode 100644 index 0000000..492756a --- /dev/null +++ b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html @@ -0,0 +1,73 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.interface.models.Books.Meta Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Static Public Attributes | +List of all members
+
+
pyShelf.src.interface.models.Books.Meta Class Reference
+
+
+ + + + +

+Static Public Attributes

+string db_table = "books"
 
+

Detailed Description

+
The documentation for this class was generated from the following file: +
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/closed.png b/docs/html/closed.png old mode 100755 new mode 100644 diff --git a/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html b/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html new file mode 100644 index 0000000..eef54c6 --- /dev/null +++ b/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
static Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html new file mode 100644 index 0000000..354d797 --- /dev/null +++ b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/backend/lib Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
lib Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html b/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html new file mode 100644 index 0000000..4efd2db --- /dev/null +++ b/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/css/vendor/select2 Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
select2 Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html new file mode 100644 index 0000000..1253850 --- /dev/null +++ b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html @@ -0,0 +1,63 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/backend Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
backend Directory Reference
+
+
+ + +

+Directories

+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html b/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html new file mode 100644 index 0000000..8f0f8d2 --- /dev/null +++ b/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/migrations Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
migrations Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_650ee533936399e683a30afb9473a469.html b/docs/html/dir_650ee533936399e683a30afb9473a469.html new file mode 100644 index 0000000..9f931b4 --- /dev/null +++ b/docs/html/dir_650ee533936399e683a30afb9473a469.html @@ -0,0 +1,65 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
interface Directory Reference
+
+
+ + + + +

+Directories

directory  static
 
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_d422163b96683743ed3963d4aac17747.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html old mode 100755 new mode 100644 similarity index 83% rename from docs/html/dir_d422163b96683743ed3963d4aac17747.html rename to docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index 9672e63..b6aa6dc --- a/docs/html/dir_d422163b96683743ed3963d4aac17747.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app Directory Reference +pyShelf Open Source Ebook Server: src Directory Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,12 +40,12 @@ $(function() {
-
app Directory Reference
+
src Directory Reference
@@ -55,7 +55,7 @@ Directories
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html b/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html new file mode 100644 index 0000000..9bb8ca1 --- /dev/null +++ b/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/js/vendor Directory Reference + + + + + + +
+
+
+ + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + + +
+
+
vendor Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html b/docs/html/dir_8509b06bafa958d2011203a730bf5778.html old mode 100755 new mode 100644 similarity index 78% rename from docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html rename to docs/html/dir_8509b06bafa958d2011203a730bf5778.html index 6a79080..5c9deec --- a/docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html +++ b/docs/html/dir_8509b06bafa958d2011203a730bf5778.html @@ -5,7 +5,7 @@ -pyShelf Open Source Ebook Server: app/lib Directory Reference +pyShelf Open Source Ebook Server: src/frontend Directory Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -40,18 +40,18 @@ $(function() {
-
lib Directory Reference
+
frontend Directory Reference
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html b/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html new file mode 100644 index 0000000..d5be62c --- /dev/null +++ b/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/backend/tests Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
tests Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html b/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html new file mode 100644 index 0000000..be4eff6 --- /dev/null +++ b/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/css/vendor Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
vendor Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html b/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html new file mode 100644 index 0000000..463cd39 --- /dev/null +++ b/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
admin Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html b/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html new file mode 100644 index 0000000..64c5d5f --- /dev/null +++ b/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/css Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
css Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html b/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html new file mode 100644 index 0000000..4546f25 --- /dev/null +++ b/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/templatetags Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
templatetags Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html b/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html new file mode 100644 index 0000000..1c2ff3a --- /dev/null +++ b/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/js Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
js Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html b/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html new file mode 100644 index 0000000..235063e --- /dev/null +++ b/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html @@ -0,0 +1,59 @@ + + + + + + + +pyShelf Open Source Ebook Server: src/interface/static/admin/js/vendor/select2 Directory Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
select2 Directory Reference
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/doc.png b/docs/html/doc.png old mode 100755 new mode 100644 diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css old mode 100755 new mode 100644 diff --git a/docs/html/doxygen.png b/docs/html/doxygen.png old mode 100755 new mode 100644 diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js old mode 100755 new mode 100644 diff --git a/docs/html/files.html b/docs/html/files.html old mode 100755 new mode 100644 index cfd365b..c03a879 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -45,24 +45,48 @@ $(function() {
Here is a list of all documented files with brief descriptions:
-
[detail level 123]
- - - - - - - - - - - +
[detail level 1234]
 ▼ app
 ▼ lib
 __init__.py
 api_hooks.py
 display.py
 library.py
 pyShelf.py
 storage.py
 __init__.py
 config.py
 main.py
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 ▼ src
 ▼ backend
 ▼ lib
 __init__.py
 api_hooks.py
 config.py
 library.py
 pyShelf.py
 storage.py
 ▼ tests
 __init__.py
 config_test.py
 library_test.py
 __init__.py
 pyShelf_ScanLibrary.py
 ▼ frontend
 __init__.py
 settings.py
 urls.py
 wsgi.py
 ▼ interface
 ▼ migrations
 0001_initial.py
 __init__.py
 ▼ templatetags
 __init__.py
 filters.py
 __init__.py
 admin.py
 apps.py
 models.py
 tests.py
 views.py
 __init__.py
 manage.py
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/folderclosed.png b/docs/html/folderclosed.png old mode 100755 new mode 100644 diff --git a/docs/html/folderopen.png b/docs/html/folderopen.png old mode 100755 new mode 100644 diff --git a/docs/html/functions.html b/docs/html/functions.html old mode 100755 new mode 100644 index 2236be4..9763481 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -42,74 +42,81 @@ $(function() {
Here is a list of all documented class members with links to the class documentation for each member:
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html old mode 100755 new mode 100644 index 89bb656..6f4093c --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -42,74 +42,81 @@ $(function() {
 
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html old mode 100755 new mode 100644 index cf3cb18..22ceaaf --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.1.0 +  0.2.1
Open source, console based E-book server
@@ -46,22 +46,29 @@ $(function() {
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
- - - - - - - - - - + + + + + + + + + + + + + + + + +
 Capp.lib.pyShelf.BookDisplay
 Capp.lib.pyShelf.BookServer
 Capp.lib.library.Catalogue
 Capp.config.Config
 Capp.lib.api_hooks.DuckDuckGo
 Capp.lib.display.Frontend
 Capp.lib.pyShelf.InitFiles
 Capp.lib.storage.Storage
 ▼CBaseHTTPRequestHandler
 Capp.lib.pyShelf.RequestHandler
 CpyShelf.src.backend.lib.pyShelf.BookDisplay
 ▼CpyShelf.src.backend.lib.library.Catalogue
 CpyShelf.src.backend.tests.library_test.Test_Catalogue
 ▼CpyShelf.src.backend.lib.config.Config
 CpyShelf.src.backend.tests.library_test.Test_Config
 CpyShelf.src.backend.lib.api_hooks.DuckDuckGo
 CpyShelf.src.backend.lib.pyShelf.InitFiles
 CpyShelf.src.interface.models.Books.Meta
 ▼CMigration
 CpyShelf.src.interface.migrations.0001_initial.Migration
 ▼CModel
 CpyShelf.src.interface.models.Books
 CpyShelf.src.backend.lib.storage.Storage
 CpyShelf.src.backend.tests.library_test.TestCatalogue
 CpyShelf.src.backend.tests.config_test.TestConfig
 ▼CAppConfig
 CpyShelf.src.interface.apps.InterfaceConfig
-Generated on Sun Nov 10 2019 01:10:53 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/index.hhc b/docs/html/index.hhc old mode 100755 new mode 100644 index a1f54eb..d22c651 --- a/docs/html/index.hhc +++ b/docs/html/index.hhc @@ -4,6 +4,317 @@ diff --git a/docs/html/index.hhk b/docs/html/index.hhk old mode 100755 new mode 100644 index a1f54eb..deab4cf --- a/docs/html/index.hhk +++ b/docs/html/index.hhk @@ -4,6 +4,771 @@ diff --git a/docs/html/index.hhp b/docs/html/index.hhp old mode 100755 new mode 100644 index 007220f..8a633b8 --- a/docs/html/index.hhp +++ b/docs/html/index.hhp @@ -14,7 +14,65 @@ Title=pyShelf Open Source Ebook Server main="pyShelf Open Source Ebook Server","index.hhc","index.hhk","index.html","index.html",,,,,0x23520,,0x70387e,,,,,,,,0 [FILES] +md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html +md_src_interface_static_admin_js_vendor_select2_LICENSE.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html +classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html +namespacepyShelf_1_1src_1_1frontend_1_1settings.html +namespacepyShelf_1_1src_1_1frontend_1_1urls.html +namespacepyShelf_1_1src_1_1frontend_1_1wsgi.html +classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html +classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html +classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html +classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration-members.html +classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html +classpyShelf_1_1src_1_1interface_1_1models_1_1Books-members.html +classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html +classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta-members.html +namespacepyShelf_1_1src_1_1manage.html +dir_a05f942952f29ba3ff0b6cf8bcd4f651.html +dir_3f615ade772d23cefe5e20dcb18424a2.html +dir_bf61165a5ec6f092245f16c80e25d9dd.html +dir_8509b06bafa958d2011203a730bf5778.html +dir_650ee533936399e683a30afb9473a469.html +dir_d57dcc97c471b6c632c5e6143b3e3c97.html +dir_1c7294442ce83d360610449d04c9d7fc.html +dir_5dc60ce45ea83ccf35a995eb718413e2.html +dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html +dir_2e4fe7818a9bea2340465344c5b4f122.html +dir_68267d1309a1af8e8297ef4c3efbcdba.html +dir_115a8af934cb6b8073d7541c3a02a8e0.html +dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html +dir_9020577e2da81c4cf5a5554c26431f94.html +dir_80adb54c76bf5d67e934da378f00559d.html +dir_9662e62442d92157d391ef66bee26a3c.html index.html +pages.html +namespaces.html +annotated.html +classes.html +hierarchy.html +functions.html +functions_func.html +files.html tab_a.png tab_b.png tab_h.png @@ -28,3 +86,10 @@ open.png bdwn.png sync_on.png sync_off.png +classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png +classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png +classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png +classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.png +classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.png +classpyShelf_1_1src_1_1interface_1_1models_1_1Books.png diff --git a/docs/html/index.html b/docs/html/index.html old mode 100755 new mode 100644 index e9aaefd..c13eacb --- a/docs/html/index.html +++ b/docs/html/index.html @@ -47,7 +47,7 @@ $(function() {
-Generated on Sun Dec 1 2019 12:33:10 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/jquery.js b/docs/html/jquery.js old mode 100755 new mode 100644 diff --git a/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html b/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html new file mode 100644 index 0000000..8043f24 --- /dev/null +++ b/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html @@ -0,0 +1,61 @@ + + + + + + + +pyShelf Open Source Ebook Server: LICENSE-SELECT2 + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + +
+
+
+
LICENSE-SELECT2
+
+
+

The MIT License (MIT)

+

Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/md_src_interface_static_admin_js_vendor_select2_LICENSE.html b/docs/html/md_src_interface_static_admin_js_vendor_select2_LICENSE.html new file mode 100644 index 0000000..b53ef25 --- /dev/null +++ b/docs/html/md_src_interface_static_admin_js_vendor_select2_LICENSE.html @@ -0,0 +1,61 @@ + + + + + + + +pyShelf Open Source Ebook Server: LICENSE + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + +
+
+
+
LICENSE
+
+
+

The MIT License (MIT)

+

Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+
+ +
+Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/menu.js b/docs/html/menu.js old mode 100755 new mode 100644 diff --git a/docs/html/menudata.js b/docs/html/menudata.js old mode 100755 new mode 100644 index bdab70c..b31f3d6 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -21,4 +21,16 @@ with this program; if not, write to the Free Software Foundation, Inc., for the JavaScript code in this file */ var menudata={children:[ -{text:"Main Page",url:"index.html"}]} +{text:"Main Page",url:"index.html"}, +{text:"Related Pages",url:"pages.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}]}, +{text:"Classes",url:"annotated.html",children:[ +{text:"Class List",url:"annotated.html"}, +{text:"Class Index",url:"classes.html"}, +{text:"Class Hierarchy",url:"hierarchy.html"}, +{text:"Class Members",url:"functions.html",children:[ +{text:"All",url:"functions.html"}, +{text:"Functions",url:"functions_func.html"}]}]}, +{text:"Files",url:"files.html",children:[ +{text:"File List",url:"files.html"}]}]} diff --git a/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html new file mode 100644 index 0000000..5ee7ea9 --- /dev/null +++ b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html @@ -0,0 +1,269 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.frontend.settings Namespace Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Variables
+
+
pyShelf.src.frontend.settings Namespace Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Variables

+ BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
+string SECRET_KEY = "@(9b9jslgg41u1u=mr)-2*-n2x0vef0zsy39*z@sz18&tvow18"
 
+bool DEBUG = False
 
+list ALLOWED_HOSTS = ["*"]
 
list INSTALLED_APPS
 
list MIDDLEWARE
 
list INTERNAL_IPS
 
+string ROOT_URLCONF = "frontend.urls"
 
list TEMPLATES
 
+string WSGI_APPLICATION = "frontend.wsgi.application"
 
dictionary DATABASES
 
list AUTH_PASSWORD_VALIDATORS
 
+string LANGUAGE_CODE = "en-us"
 
+string TIME_ZONE = "UTC"
 
+bool USE_I18N = True
 
+bool USE_L10N = True
 
+bool USE_TZ = True
 
+string STATIC_URL = "/static/"
 
+ STATIC_ROOT = os.path.join(BASE_DIR, "interface/static/")
 
+

Detailed Description

+
Django settings for frontend project.
+
+Generated by 'django-admin startproject' using Django 2.2.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/2.2/ref/settings/
+

Variable Documentation

+ +

◆ AUTH_PASSWORD_VALIDATORS

+ +
+
+ + + + +
list pyShelf.src.frontend.settings.AUTH_PASSWORD_VALIDATORS
+
+Initial value:
1 = [
+
2  {
+
3  "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+
4  },
+
5  {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",},
+
6  {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",},
+
7  {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",},
+
8 ]
+
+
+
+ +

◆ DATABASES

+ +
+
+ + + + +
dictionary pyShelf.src.frontend.settings.DATABASES
+
+Initial value:
1 = {
+
2  "default": {
+
3  "ENGINE": "django.db.backends.postgresql",
+
4  # "ENGINE": "django.db.backends.sqlite3",
+
5  "NAME": "pyshelf",
+
6  "PASSWORD": "",
+
7  # "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
+
8  }
+
9 }
+
+
+
+ +

◆ INSTALLED_APPS

+ +
+
+ + + + +
list pyShelf.src.frontend.settings.INSTALLED_APPS
+
+Initial value:
1 = [
+
2  "django.contrib.admin",
+
3  "django.contrib.auth",
+
4  "django.contrib.contenttypes",
+
5  "django.contrib.sessions",
+
6  "django.contrib.messages",
+
7  "django.contrib.staticfiles",
+
8  "interface",
+
9  "interface.templatetags",
+
10  "debug_toolbar",
+
11 ]
+
+
+
+ +

◆ INTERNAL_IPS

+ +
+
+ + + + +
list pyShelf.src.frontend.settings.INTERNAL_IPS
+
+Initial value:
1 = [
+
2  # ...
+
3  "127.0.0.1",
+
4  # ...
+
5 ]
+
+
+
+ +

◆ MIDDLEWARE

+ +
+
+ + + + +
list pyShelf.src.frontend.settings.MIDDLEWARE
+
+Initial value:
1 = [
+
2  "django.middleware.security.SecurityMiddleware",
+
3  "django.contrib.sessions.middleware.SessionMiddleware",
+
4  "django.middleware.common.CommonMiddleware",
+
5  "django.middleware.csrf.CsrfViewMiddleware",
+
6  "debug_toolbar.middleware.DebugToolbarMiddleware",
+
7  "django.contrib.auth.middleware.AuthenticationMiddleware",
+
8  "django.contrib.messages.middleware.MessageMiddleware",
+
9  "django.middleware.clickjacking.XFrameOptionsMiddleware",
+
10 ]
+
+
+
+ +

◆ TEMPLATES

+ +
+
+ + + + +
list pyShelf.src.frontend.settings.TEMPLATES
+
+Initial value:
1 = [
+
2  {
+
3  "BACKEND": "django.template.backends.django.DjangoTemplates",
+
4  "DIRS": [],
+
5  "APP_DIRS": True,
+
6  "OPTIONS": {
+
7  "context_processors": [
+
8  "django.template.context_processors.debug",
+
9  "django.template.context_processors.request",
+
10  "django.contrib.auth.context_processors.auth",
+
11  "django.contrib.messages.context_processors.messages",
+
12  ],
+
13  },
+
14  },
+
15 ]
+
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1urls.html b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1urls.html new file mode 100644 index 0000000..91c7499 --- /dev/null +++ b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1urls.html @@ -0,0 +1,104 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.frontend.urls Namespace Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Variables
+
+
pyShelf.src.frontend.urls Namespace Reference
+
+
+ + + + +

+Variables

list urlpatterns
 
+

Detailed Description

+
frontend URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/2.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+

Variable Documentation

+ +

◆ urlpatterns

+ +
+
+ + + + +
list pyShelf.src.frontend.urls.urlpatterns
+
+Initial value:
1 = [
+
2  path("admin/", admin.site.urls),
+
3  path("", views.index, name="index"),
+
4  path("download/<pk>", views.download, name="download"),
+
5  path("prev_page/<bookset>", views.prev_page, name="prev_page"),
+
6  path("next_page/<bookset>", views.next_page, name="next_page"),
+
7 ]
+
+
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1wsgi.html b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1wsgi.html new file mode 100644 index 0000000..08967de --- /dev/null +++ b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1wsgi.html @@ -0,0 +1,75 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.frontend.wsgi Namespace Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Variables
+
+
pyShelf.src.frontend.wsgi Namespace Reference
+
+
+ + + + +

+Variables

+ application = get_wsgi_application()
 
+

Detailed Description

+
WSGI config for frontend project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/namespacepyShelf_1_1src_1_1manage.html b/docs/html/namespacepyShelf_1_1src_1_1manage.html new file mode 100644 index 0000000..611ccb5 --- /dev/null +++ b/docs/html/namespacepyShelf_1_1src_1_1manage.html @@ -0,0 +1,69 @@ + + + + + + + +pyShelf Open Source Ebook Server: pyShelf.src.manage Namespace Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Functions
+
+
pyShelf.src.manage Namespace Reference
+
+
+ + + + +

+Functions

+def main ()
 
+

Detailed Description

+
Django's command-line utility for administrative tasks.
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html new file mode 100644 index 0000000..cb0c497 --- /dev/null +++ b/docs/html/namespaces.html @@ -0,0 +1,66 @@ + + + + + + + +pyShelf Open Source Ebook Server: Namespace List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + +
+
+
+
Namespace List
+
+
+
Here is a list of all documented namespaces with brief descriptions:
+
[detail level 1234]
+ + + + + + + +
 ▼NpyShelf
 ▼Nsrc
 ▼Nfrontend
 Nsettings
 Nurls
 Nwsgi
 Nmanage
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/nav_f.png b/docs/html/nav_f.png old mode 100755 new mode 100644 diff --git a/docs/html/nav_g.png b/docs/html/nav_g.png old mode 100755 new mode 100644 diff --git a/docs/html/nav_h.png b/docs/html/nav_h.png old mode 100755 new mode 100644 diff --git a/docs/html/open.png b/docs/html/open.png old mode 100755 new mode 100644 diff --git a/docs/html/pages.html b/docs/html/pages.html new file mode 100644 index 0000000..2c58a7e --- /dev/null +++ b/docs/html/pages.html @@ -0,0 +1,61 @@ + + + + + + + +pyShelf Open Source Ebook Server: Related Pages + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.2.1 +
+
Open source, console based E-book server
+
+
+ + + + + + +
+
+
+
Related Pages
+
+
+
Here is a list of all related documentation pages:
+ + + +
 LICENSE-SELECT2
 LICENSE
+
+
+ +
+Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/splitbar.png b/docs/html/splitbar.png old mode 100755 new mode 100644 diff --git a/docs/html/sync_off.png b/docs/html/sync_off.png old mode 100755 new mode 100644 diff --git a/docs/html/sync_on.png b/docs/html/sync_on.png old mode 100755 new mode 100644 diff --git a/docs/html/tab_a.png b/docs/html/tab_a.png old mode 100755 new mode 100644 diff --git a/docs/html/tab_b.png b/docs/html/tab_b.png old mode 100755 new mode 100644 diff --git a/docs/html/tab_h.png b/docs/html/tab_h.png old mode 100755 new mode 100644 diff --git a/docs/html/tab_s.png b/docs/html/tab_s.png old mode 100755 new mode 100644 diff --git a/docs/html/tabs.css b/docs/html/tabs.css old mode 100755 new mode 100644 diff --git a/docs/man/man3/app_config_Config.3 b/docs/man/man3/app_config_Config.3 deleted file mode 100755 index bbecc14..0000000 --- a/docs/man/man3/app_config_Config.3 +++ /dev/null @@ -1,50 +0,0 @@ -.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\&. diff --git a/docs/man/man3/app_lib_display_Frontend.3 b/docs/man/man3/app_lib_display_Frontend.3 deleted file mode 100755 index 29c1a88..0000000 --- a/docs/man/man3/app_lib_display_Frontend.3 +++ /dev/null @@ -1,118 +0,0 @@ -.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\&. diff --git a/docs/man/man3/app_lib_library_Catalogue.3 b/docs/man/man3/app_lib_library_Catalogue.3 deleted file mode 100755 index 1b3537c..0000000 --- a/docs/man/man3/app_lib_library_Catalogue.3 +++ /dev/null @@ -1,123 +0,0 @@ -.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\&. diff --git a/docs/man/man3/app_lib_pyShelf_BookServer.3 b/docs/man/man3/app_lib_pyShelf_BookServer.3 deleted file mode 100755 index 65d1692..0000000 --- a/docs/man/man3/app_lib_pyShelf_BookServer.3 +++ /dev/null @@ -1,77 +0,0 @@ -.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\&. diff --git a/docs/man/man3/app_lib_pyShelf_RequestHandler.3 b/docs/man/man3/app_lib_pyShelf_RequestHandler.3 deleted file mode 100755 index e6948aa..0000000 --- a/docs/man/man3/app_lib_pyShelf_RequestHandler.3 +++ /dev/null @@ -1,37 +0,0 @@ -.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\&. diff --git a/docs/man/man3/app_lib_storage_Storage.3 b/docs/man/man3/app_lib_storage_Storage.3 deleted file mode 100755 index ad06c6e..0000000 --- a/docs/man/man3/app_lib_storage_Storage.3 +++ /dev/null @@ -1,87 +0,0 @@ -.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\&. diff --git a/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 b/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 new file mode 100644 index 0000000..5fa6f37 --- /dev/null +++ b/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 @@ -0,0 +1,14 @@ +.TH "md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2 \- LICENSE-SELECT2 +The MIT License (MIT) +.PP +Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors +.PP +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +.PP +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. +.PP +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. diff --git a/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 b/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 new file mode 100644 index 0000000..5e4baa6 --- /dev/null +++ b/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 @@ -0,0 +1,14 @@ +.TH "md_src_interface_static_admin_js_vendor_select2_LICENSE" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +md_src_interface_static_admin_js_vendor_select2_LICENSE \- LICENSE +The MIT License (MIT) +.PP +Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors +.PP +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +.PP +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. +.PP +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. diff --git a/docs/man/man3/app_lib_api_hooks_DuckDuckGo.3 b/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 old mode 100755 new mode 100644 similarity index 68% rename from docs/man/man3/app_lib_api_hooks_DuckDuckGo.3 rename to docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 index 8513078..e7085fa --- a/docs/man/man3/app_lib_api_hooks_DuckDuckGo.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 @@ -1,8 +1,8 @@ -.TH "app.lib.api_hooks.DuckDuckGo" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME -app.lib.api_hooks.DuckDuckGo +pyShelf.src.backend.lib.api_hooks.DuckDuckGo .SH SYNOPSIS .br .PP @@ -34,7 +34,7 @@ duckduckgo related searching .SH "Member Function Documentation" .PP -.SS "def app\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)" +.SS "def pyShelf\&.src\&.backend\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)" .PP .nf diff --git a/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 b/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 new file mode 100644 index 0000000..e3ceb16 --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 @@ -0,0 +1,81 @@ +.TH "pyShelf.src.backend.lib.config.Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "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 "\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 "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\&. diff --git a/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 b/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 new file mode 100644 index 0000000..33004a8 --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 @@ -0,0 +1,187 @@ +.TH "pyShelf.src.backend.lib.library.Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "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\&. diff --git a/docs/man/man3/app_lib_pyShelf_BookDisplay.3 b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 old mode 100755 new mode 100644 similarity index 62% rename from docs/man/man3/app_lib_pyShelf_BookDisplay.3 rename to docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 index 74b871a..834a5ec --- a/docs/man/man3/app_lib_pyShelf_BookDisplay.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 @@ -1,8 +1,8 @@ -.TH "app.lib.pyShelf.BookDisplay" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.pyShelf.BookDisplay" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME -app.lib.pyShelf.BookDisplay +pyShelf.src.backend.lib.pyShelf.BookDisplay .SH SYNOPSIS .br .PP @@ -10,7 +10,7 @@ app.lib.pyShelf.BookDisplay .in +1c .ti -1c -.RI "def \fB__init__\fP (self)" +.RI "def \fB__init__\fP (self, **kwargs)" .br .ti -1c .RI "def \fBnextPage\fP (self)" @@ -40,6 +40,9 @@ app.lib.pyShelf.BookDisplay .ti -1c .RI "\fBtotal_pages\fP" .br +.ti -1c +.RI "\fBscreen_size\fP" +.br .in -1c .SH "Detailed Description" .PP @@ -52,7 +55,7 @@ All functions related to displaying book information in the HTML UI .SH "Constructor & Destructor Documentation" .PP -.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self)" +.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self, ** kwargs)" .PP .nf @@ -64,32 +67,34 @@ Initialize class variables .SH "Member Function Documentation" .PP -.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)" +.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 app\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)" +.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 app\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)" +.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)" .PP .nf +## TODO Remove me Goto previous book page :return: new current_page diff --git a/docs/man/man3/app_lib_pyShelf_InitFiles.3 b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 old mode 100755 new mode 100644 similarity index 59% rename from docs/man/man3/app_lib_pyShelf_InitFiles.3 rename to docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 index 9ee1866..c30dce2 --- a/docs/man/man3/app_lib_pyShelf_InitFiles.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 @@ -1,8 +1,8 @@ -.TH "app.lib.pyShelf.InitFiles" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.pyShelf.InitFiles" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME -app.lib.pyShelf.InitFiles +pyShelf.src.backend.lib.pyShelf.InitFiles .SH SYNOPSIS .br .PP @@ -27,11 +27,12 @@ First run file creation operations .SH "Member Function Documentation" .PP -.SS "def app\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)" +.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)" .PP .nf -Create the file +Checks if file exists and creates it if not + .fi .PP diff --git a/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 b/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 new file mode 100644 index 0000000..151f164 --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 @@ -0,0 +1,120 @@ +.TH "pyShelf.src.backend.lib.storage.Storage" 3 "Sun Dec 1 2019" "Version 0.2.1" "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 \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 "\fBsql\fP" +.br +.ti -1c +.RI "\fBuser\fP" +.br +.ti -1c +.RI "\fBpassword\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\&.database ( self)" + +.PP +.nf +Create database cursor +.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\&. diff --git a/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 b/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 new file mode 100644 index 0000000..8c1db57 --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 @@ -0,0 +1,35 @@ +.TH "pyShelf.src.backend.tests.config_test.TestConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "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\&. diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 new file mode 100644 index 0000000..456aa9e --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 @@ -0,0 +1,32 @@ +.TH "pyShelf.src.backend.tests.library_test.TestCatalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "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\&. diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 new file mode 100644 index 0000000..ea2ff4f --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 @@ -0,0 +1,179 @@ +.TH "pyShelf.src.backend.tests.library_test.Test_Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "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\&. diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 new file mode 100644 index 0000000..6e68e00 --- /dev/null +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 @@ -0,0 +1,73 @@ +.TH "pyShelf.src.backend.tests.library_test.Test_Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "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 "\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\&. diff --git a/docs/man/man3/pyShelf_src_frontend_settings.3 b/docs/man/man3/pyShelf_src_frontend_settings.3 new file mode 100644 index 0000000..71c8190 --- /dev/null +++ b/docs/man/man3/pyShelf_src_frontend_settings.3 @@ -0,0 +1,180 @@ +.TH "pyShelf.src.frontend.settings" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.frontend.settings +.SH SYNOPSIS +.br +.PP +.SS "Variables" + +.in +1c +.ti -1c +.RI "\fBBASE_DIR\fP = os\&.path\&.dirname(os\&.path\&.dirname(os\&.path\&.abspath(__file__)))" +.br +.ti -1c +.RI "string \fBSECRET_KEY\fP = '@(9b9jslgg41u1u=mr)\-2*\-n2x0vef0zsy39*z@sz18&tvow18'" +.br +.ti -1c +.RI "bool \fBDEBUG\fP = False" +.br +.ti -1c +.RI "list \fBALLOWED_HOSTS\fP = ['*']" +.br +.ti -1c +.RI "list \fBINSTALLED_APPS\fP" +.br +.ti -1c +.RI "list \fBMIDDLEWARE\fP" +.br +.ti -1c +.RI "list \fBINTERNAL_IPS\fP" +.br +.ti -1c +.RI "string \fBROOT_URLCONF\fP = 'frontend\&.urls'" +.br +.ti -1c +.RI "list \fBTEMPLATES\fP" +.br +.ti -1c +.RI "string \fBWSGI_APPLICATION\fP = 'frontend\&.wsgi\&.application'" +.br +.ti -1c +.RI "dictionary \fBDATABASES\fP" +.br +.ti -1c +.RI "list \fBAUTH_PASSWORD_VALIDATORS\fP" +.br +.ti -1c +.RI "string \fBLANGUAGE_CODE\fP = 'en\-us'" +.br +.ti -1c +.RI "string \fBTIME_ZONE\fP = 'UTC'" +.br +.ti -1c +.RI "bool \fBUSE_I18N\fP = True" +.br +.ti -1c +.RI "bool \fBUSE_L10N\fP = True" +.br +.ti -1c +.RI "bool \fBUSE_TZ\fP = True" +.br +.ti -1c +.RI "string \fBSTATIC_URL\fP = '/static/'" +.br +.ti -1c +.RI "\fBSTATIC_ROOT\fP = os\&.path\&.join(BASE_DIR, 'interface/static/')" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +Django settings for frontend project. + +Generated by 'django-admin startproject' using Django 2.2.7. + +For more information on this file, see +https://docs.djangoproject.com/en/2.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/2.2/ref/settings/ + +.fi +.PP + +.SH "Variable Documentation" +.PP +.SS "list pyShelf\&.src\&.frontend\&.settings\&.AUTH_PASSWORD_VALIDATORS" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 { +3 "NAME": "django\&.contrib\&.auth\&.password_validation\&.UserAttributeSimilarityValidator", +4 }, +5 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.MinimumLengthValidator",}, +6 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.CommonPasswordValidator",}, +7 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.NumericPasswordValidator",}, +8 ] +.fi +.SS "dictionary pyShelf\&.src\&.frontend\&.settings\&.DATABASES" +\fBInitial value:\fP +.PP +.nf +1 = { +2 "default": { +3 "ENGINE": "django\&.db\&.backends\&.postgresql", +4 # "ENGINE": "django\&.db\&.backends\&.sqlite3", +5 "NAME": "pyshelf", +6 "PASSWORD": "", +7 # "NAME": os\&.path\&.join(BASE_DIR, "db\&.sqlite3"), +8 } +9 } +.fi +.SS "list pyShelf\&.src\&.frontend\&.settings\&.INSTALLED_APPS" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 "django\&.contrib\&.admin", +3 "django\&.contrib\&.auth", +4 "django\&.contrib\&.contenttypes", +5 "django\&.contrib\&.sessions", +6 "django\&.contrib\&.messages", +7 "django\&.contrib\&.staticfiles", +8 "interface", +9 "interface\&.templatetags", +10 "debug_toolbar", +11 ] +.fi +.SS "list pyShelf\&.src\&.frontend\&.settings\&.INTERNAL_IPS" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 # \&.\&.\&. +3 "127\&.0\&.0\&.1", +4 # \&.\&.\&. +5 ] +.fi +.SS "list pyShelf\&.src\&.frontend\&.settings\&.MIDDLEWARE" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 "django\&.middleware\&.security\&.SecurityMiddleware", +3 "django\&.contrib\&.sessions\&.middleware\&.SessionMiddleware", +4 "django\&.middleware\&.common\&.CommonMiddleware", +5 "django\&.middleware\&.csrf\&.CsrfViewMiddleware", +6 "debug_toolbar\&.middleware\&.DebugToolbarMiddleware", +7 "django\&.contrib\&.auth\&.middleware\&.AuthenticationMiddleware", +8 "django\&.contrib\&.messages\&.middleware\&.MessageMiddleware", +9 "django\&.middleware\&.clickjacking\&.XFrameOptionsMiddleware", +10 ] +.fi +.SS "list pyShelf\&.src\&.frontend\&.settings\&.TEMPLATES" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 { +3 "BACKEND": "django\&.template\&.backends\&.django\&.DjangoTemplates", +4 "DIRS": [], +5 "APP_DIRS": True, +6 "OPTIONS": { +7 "context_processors": [ +8 "django\&.template\&.context_processors\&.debug", +9 "django\&.template\&.context_processors\&.request", +10 "django\&.contrib\&.auth\&.context_processors\&.auth", +11 "django\&.contrib\&.messages\&.context_processors\&.messages", +12 ], +13 }, +14 }, +15 ] +.fi +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_frontend_urls.3 b/docs/man/man3/pyShelf_src_frontend_urls.3 new file mode 100644 index 0000000..c3d36df --- /dev/null +++ b/docs/man/man3/pyShelf_src_frontend_urls.3 @@ -0,0 +1,55 @@ +.TH "pyShelf.src.frontend.urls" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.frontend.urls +.SH SYNOPSIS +.br +.PP +.SS "Variables" + +.in +1c +.ti -1c +.RI "list \fBurlpatterns\fP" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +frontend URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/2.2/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) + +.fi +.PP + +.SH "Variable Documentation" +.PP +.SS "list pyShelf\&.src\&.frontend\&.urls\&.urlpatterns" +\fBInitial value:\fP +.PP +.nf +1 = [ +2 path("admin/", admin\&.site\&.urls), +3 path("", views\&.index, name="index"), +4 path("download/", views\&.download, name="download"), +5 path("prev_page/", views\&.prev_page, name="prev_page"), +6 path("next_page/", views\&.next_page, name="next_page"), +7 ] +.fi +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_frontend_wsgi.3 b/docs/man/man3/pyShelf_src_frontend_wsgi.3 new file mode 100644 index 0000000..bc5c880 --- /dev/null +++ b/docs/man/man3/pyShelf_src_frontend_wsgi.3 @@ -0,0 +1,33 @@ +.TH "pyShelf.src.frontend.wsgi" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.frontend.wsgi +.SH SYNOPSIS +.br +.PP +.SS "Variables" + +.in +1c +.ti -1c +.RI "\fBapplication\fP = get_wsgi_application()" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +WSGI config for frontend project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/ + +.fi +.PP + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 b/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 new file mode 100644 index 0000000..8f30494 --- /dev/null +++ b/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 @@ -0,0 +1,24 @@ +.TH "pyShelf.src.interface.apps.InterfaceConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.interface.apps.InterfaceConfig +.SH SYNOPSIS +.br +.PP +.PP +Inherits AppConfig\&. +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "string \fBname\fP = 'interface'" +.br +.in -1c +.SH "Detailed Description" +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 b/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 new file mode 100644 index 0000000..6812b9b --- /dev/null +++ b/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 @@ -0,0 +1,61 @@ +.TH "pyShelf.src.interface.migrations.0001_initial.Migration" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.interface.migrations.0001_initial.Migration +.SH SYNOPSIS +.br +.PP +.PP +Inherits Migration\&. +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "bool \fBinitial\fP = True" +.br +.ti -1c +.RI "list \fBdependencies\fP = []" +.br +.ti -1c +.RI "list \fBoperations\fP" +.br +.in -1c +.SH "Detailed Description" +.PP +.SH "Member Data Documentation" +.PP +.SS "list pyShelf\&.src\&.interface\&.migrations\&.0001_initial\&.Migration\&.operations\fC [static]\fP" +\fBInitial value:\fP +.PP +.nf += [ + migrations\&.CreateModel( + name="Books", + fields=[ + ( + "id", + models\&.AutoField( + auto_created=True, + primary_key=True, + serialize=False, + verbose_name="ID", + ), + ), + ("title", models\&.CharField(max_length=255)), + ("author", models\&.CharField(max_length=255, null=True)), + ("categories", models\&.CharField(max_length=255, null=True)), + ("cover", models\&.BinaryField(editable=True, null=True)), + ("pages", models\&.IntegerField(null=True)), + ("progress", models\&.IntegerField(null=True)), + ("file_name", models\&.CharField(max_length=255)), + ], + options={"db_table": "books",}, + ), + ] +.fi + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_models_Books.3 b/docs/man/man3/pyShelf_src_interface_models_Books.3 new file mode 100644 index 0000000..1c3aeea --- /dev/null +++ b/docs/man/man3/pyShelf_src_interface_models_Books.3 @@ -0,0 +1,83 @@ +.TH "pyShelf.src.interface.models.Books" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.interface.models.Books +.SH SYNOPSIS +.br +.PP +.PP +Inherits Model\&. +.SS "Classes" + +.in +1c +.ti -1c +.RI "class \fBMeta\fP" +.br +.in -1c +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__str__\fP (self)" +.br +.ti -1c +.RI "def \fBget_absolute_url\fP (self)" +.br +.in -1c +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "\fBtitle\fP = models\&.CharField(max_length=255)" +.br +.ti -1c +.RI "\fBauthor\fP = models\&.CharField(max_length=255, null=True)" +.br +.ti -1c +.RI "\fBcategories\fP = models\&.CharField(max_length=255, null=True)" +.br +.ti -1c +.RI "\fBcover\fP = models\&.BinaryField(null=True, editable=True)" +.br +.ti -1c +.RI "\fBpages\fP = models\&.IntegerField(null=True)" +.br +.ti -1c +.RI "\fBprogress\fP = models\&.IntegerField(null=True)" +.br +.ti -1c +.RI "\fBfile_name\fP = models\&.CharField(max_length=255, null=False)" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +pyShelfs Book Database class +:param title: Book title +:param author: Author +:param categories: Categories <-- Not implemented +:param cover: Cover image BinaryField +:param pages: # of pages <-- Not implemented +:param progress: Reader percentage <-- Not implented +:param file_name: Path to book + +.fi +.PP + +.SH "Member Function Documentation" +.PP +.SS "def pyShelf\&.src\&.interface\&.models\&.Books\&.get_absolute_url ( self)" + +.PP +.nf +Returns the url to access a particular instance of MyModelName. +.fi +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 b/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 new file mode 100644 index 0000000..5ea7e8b --- /dev/null +++ b/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 @@ -0,0 +1,22 @@ +.TH "pyShelf.src.interface.models.Books.Meta" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.interface.models.Books.Meta +.SH SYNOPSIS +.br +.PP +.SS "Static Public Attributes" + +.in +1c +.ti -1c +.RI "string \fBdb_table\fP = 'books'" +.br +.in -1c +.SH "Detailed Description" +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_manage.3 b/docs/man/man3/pyShelf_src_manage.3 new file mode 100644 index 0000000..fbd7370 --- /dev/null +++ b/docs/man/man3/pyShelf_src_manage.3 @@ -0,0 +1,27 @@ +.TH "pyShelf.src.manage" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +pyShelf.src.manage +.SH SYNOPSIS +.br +.PP +.SS "Functions" + +.in +1c +.ti -1c +.RI "def \fBmain\fP ()" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +Django's command-line utility for administrative tasks. +.fi +.PP + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/warn.log b/docs/warn.log old mode 100755 new mode 100644 index 9ceb12d..2cf983b --- a/docs/warn.log +++ b/docs/warn.log @@ -1,2 +1,149 @@ -warning: source app is not a readable file or directory... skipping. -error: Cannot find directory app/. Check the value of the INPUT tag in the configuration file. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:19: warning: Compound pyShelf::src::backend::tests::library_test::Test_Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:28: warning: Compound pyShelf::src::backend::tests::library_test::TestCatalogue is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:18: warning: Compound pyShelf::src::interface::models::Books::Meta is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:6: warning: Compound pyShelf::src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/interface/apps.py:4: warning: Compound pyShelf::src::interface::apps::InterfaceConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:8: warning: Compound pyShelf::src::backend::tests::library_test::Test_Config is not documented. +/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:6: warning: Compound pyShelf::src::interface::migrations::0001_initial::Migration is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:12: warning: Member __init__(self) (function) of class pyShelf::src::backend::lib::api_hooks::DuckDuckGo is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:13: warning: Member url (variable) of class pyShelf::src::backend::lib::api_hooks::DuckDuckGo is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:15: warning: return type of member pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:14: warning: Member __init__(self, root) (function) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:17: warning: Member book_path (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:18: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:19: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member book_shelf (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member catalogue_db (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member file_array (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: warning: Member auto_scan (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: return type of member pyShelf.src.backend.lib.config.Config.open_file is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:22: warning: Member __init__(self, config) (function) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:29: warning: Member book_shelf (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:115: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_content is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:122: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_cover_html is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:129: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_cover_image is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:89: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_metadata is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:52: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.filter_books is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:158: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.import_books is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:73: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.process_book is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:35: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.scan_folder is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:45: warning: Member books_per_page (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:46: warning: Member current_page (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:47: warning: Member thumbnail_size (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:48: warning: Member thumbnail_scale (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:49: warning: Member total_pages (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:51: warning: Member screen_size (variable) of class pyShelf::src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:40: warning: parameters of member pyShelf.src.backend.lib.pyShelf.BookDisplay.__init__ are not (all) documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:73: warning: return type of member pyShelf.src.backend.lib.pyShelf.BookDisplay.booksPerPage is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:55: warning: return type of member pyShelf.src.backend.lib.pyShelf.BookDisplay.nextPage is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:64: warning: return type of member pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:15: warning: Member __init__(self, file_array) (function) of class pyShelf::src::backend::lib::pyShelf::InitFiles is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:27: warning: return type of member pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:14: warning: Member __init__(self, db_pointer, config) (function) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:16: warning: Member sql (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:17: warning: Member user (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:18: warning: Member password (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:26: warning: Member db (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:27: warning: Member cursor (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:71: warning: return type of member pyShelf.src.backend.lib.storage.Storage.book_paths_list is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:93: warning: return type of member pyShelf.src.backend.lib.storage.Storage.close is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:83: warning: return type of member pyShelf.src.backend.lib.storage.Storage.commit is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:34: warning: return type of member pyShelf.src.backend.lib.storage.Storage.create_tables is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:22: warning: return type of member pyShelf.src.backend.lib.storage.Storage.database is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:45: warning: return type of member pyShelf.src.backend.lib.storage.Storage.insert_book is not documented +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:9: warning: Member test_book_dir(self) (function) of class pyShelf::src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:12: warning: Member test_title(self) (function) of class pyShelf::src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:15: warning: Member test_version(self) (function) of class pyShelf::src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:7: warning: Member config (variable) of class pyShelf::src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:20: warning: Member __init__(self) (function) of class pyShelf::src::backend::tests::library_test::Test_Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:24: warning: Member book_shelf (variable) of class pyShelf::src::backend::tests::library_test::Test_Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:23: warning: Member file_list (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:24: warning: Member opf_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:25: warning: Member cover_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:26: warning: Member html_regx (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:27: warning: Member root_dir (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:28: warning: Member book_folder (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:32: warning: Member db_pointer (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class pyShelf::src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.compare_shelf_current is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:115: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_content is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:122: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_cover_html is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:129: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_cover_image is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:89: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.extract_metadata is not documented +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:23: warning: return type of member pyShelf.src.backend.tests.library_test.Test_Catalogue.filter_books is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:158: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.import_books is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:73: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.process_book is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:35: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.scan_folder is not documented +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:9: warning: Member __init__(self) (function) of class pyShelf::src::backend::tests::library_test::Test_Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:17: warning: Member book_path (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:18: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:19: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member book_shelf (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member catalogue_db (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member file_array (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: warning: Member auto_scan (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:13: warning: return type of member pyShelf.src.backend.tests.library_test.Test_Config.open_file is not documented +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:32: warning: Member test_filter_books(self) (function) of class pyShelf::src::backend::tests::library_test::TestCatalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:29: warning: Member root (variable) of class pyShelf::src::backend::tests::library_test::TestCatalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:30: warning: Member config (variable) of class pyShelf::src::backend::tests::library_test::TestCatalogue is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:16: warning: Member BASE_DIR (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:23: warning: Member SECRET_KEY (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:26: warning: Member DEBUG (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:28: warning: Member ALLOWED_HOSTS (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:33: warning: Member INSTALLED_APPS (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:45: warning: Member MIDDLEWARE (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:56: warning: Member INTERNAL_IPS (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:62: warning: Member ROOT_URLCONF (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:64: warning: Member TEMPLATES (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:80: warning: Member WSGI_APPLICATION (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:86: warning: Member DATABASES (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:100: warning: Member AUTH_PASSWORD_VALIDATORS (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:113: warning: Member LANGUAGE_CODE (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:115: warning: Member TIME_ZONE (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:117: warning: Member USE_I18N (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:119: warning: Member USE_L10N (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:121: warning: Member USE_TZ (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:127: warning: Member STATIC_URL (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:128: warning: Member STATIC_ROOT (variable) of namespace pyShelf::src::frontend::settings is not documented. +/home/raelon/Projects/pyShelf/src/frontend/settings.py:100: warning: parameters of member pyShelf.src.frontend.settings.AUTH_PASSWORD_VALIDATORS are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/settings.py:86: warning: parameters of member pyShelf.src.frontend.settings.DATABASES are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/settings.py:33: warning: parameters of member pyShelf.src.frontend.settings.INSTALLED_APPS are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/settings.py:56: warning: parameters of member pyShelf.src.frontend.settings.INTERNAL_IPS are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/settings.py:45: warning: parameters of member pyShelf.src.frontend.settings.MIDDLEWARE are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/settings.py:64: warning: parameters of member pyShelf.src.frontend.settings.TEMPLATES are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/urls.py:21: warning: Member urlpatterns (variable) of namespace pyShelf::src::frontend::urls is not documented. +/home/raelon/Projects/pyShelf/src/frontend/urls.py:21: warning: parameters of member pyShelf.src.frontend.urls.urlpatterns are not (all) documented +/home/raelon/Projects/pyShelf/src/frontend/wsgi.py:16: warning: Member application (variable) of namespace pyShelf::src::frontend::wsgi is not documented. +/home/raelon/Projects/pyShelf/src/interface/apps.py:5: warning: Member name (variable) of class pyShelf::src::interface::apps::InterfaceConfig is not documented. +/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:8: warning: Member initial (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. +/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:10: warning: Member dependencies (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. +/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:12: warning: Member operations (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. +/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:12: warning: parameters of member pyShelf.src.interface.migrations.0001_initial.Migration.operations are not (all) documented +/home/raelon/Projects/pyShelf/src/interface/models.py:21: warning: Member __str__(self) (function) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:24: warning: Member title (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:25: warning: Member author (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:26: warning: Member categories (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:27: warning: Member cover (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:28: warning: Member pages (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:29: warning: Member progress (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:30: warning: Member file_name (variable) of class pyShelf::src::interface::models::Books is not documented. +/home/raelon/Projects/pyShelf/src/interface/models.py:32: warning: return type of member pyShelf.src.interface.models.Books.get_absolute_url is not documented +/home/raelon/Projects/pyShelf/src/interface/models.py:19: warning: Member db_table (variable) of class pyShelf::src::interface::models::Books::Meta is not documented. +/home/raelon/Projects/pyShelf/src/manage.py:7: warning: Member main() (function) of namespace pyShelf::src::manage is not documented.