From 964e8dc20a8af7cb865f45aace0e3f63b8713d6e Mon Sep 17 00:00:00 2001 From: Mike Young Date: Wed, 1 Jan 2020 09:55:47 -0500 Subject: [PATCH] Incremented version number --- docs/html/HTML/index.html | 6 +- docs/html/HTML/mains.html | 6 +- docs/html/HTML/rebuild.sh | 2 +- docs/html/annotated.html | 51 +- docs/html/classes.html | 27 +- ..._1_1lib_1_1display_1_1TerminalDisplay.html | 129 +++ ..._1lib_1_1pyShelf_1_1InitFiles-members.html | 64 ++ ...ests_1_1library__test_1_1Test__Config.html | 167 ++++ ...tests_1_1library__test_1_1Test__Config.png | Bin 0 -> 853 bytes ...nd_1_1lib_1_1config_1_1Config-members.html | 79 ++ ...ibrary__test_1_1TestCatalogue-members.html | 65 ++ ...1_1display_1_1TerminalDisplay-members.html | 79 ++ ...ackend_1_1lib_1_1library_1_1Catalogue.html | 407 +++++++++ ...backend_1_1lib_1_1library_1_1Catalogue.png | Bin 0 -> 966 bytes ...library__test_1_1Test__Config-members.html | 80 ++ ...1_1config__test_1_1TestConfig-members.html | 66 ++ ..._1lib_1_1library_1_1Catalogue-members.html | 82 ++ ...1backend_1_1lib_1_1storage_1_1Storage.html | 220 +++++ ...lib_1_1pyShelf_1_1BookDisplay-members.html | 72 ++ ...nd_1_1lib_1_1api__hooks_1_1DuckDuckGo.html | 113 +++ ...sts_1_1library__test_1_1TestCatalogue.html | 83 ++ ...1_1backend_1_1lib_1_1config_1_1Config.html | 197 ++++ ..._1_1backend_1_1lib_1_1config_1_1Config.png | Bin 0 -> 858 bytes ...ackend_1_1lib_1_1pyShelf_1_1InitFiles.html | 105 +++ ...kend_1_1lib_1_1pyShelf_1_1BookDisplay.html | 206 +++++ ..._1_1lib_1_1storage_1_1Storage-members.html | 77 ++ ...s_1_1library__test_1_1Test__Catalogue.html | 462 ++++++++++ ...ts_1_1library__test_1_1Test__Catalogue.png | Bin 0 -> 962 bytes ...rary__test_1_1Test__Catalogue-members.html | 83 ++ ...b_1_1api__hooks_1_1DuckDuckGo-members.html | 65 ++ ..._1tests_1_1config__test_1_1TestConfig.html | 86 ++ .../dir_1c7294442ce83d360610449d04c9d7fc.html | 4 +- .../dir_3f615ade772d23cefe5e20dcb18424a2.html | 4 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 4 +- .../dir_9020577e2da81c4cf5a5554c26431f94.html | 4 +- docs/html/files.html | 23 +- docs/html/functions.html | 52 +- docs/html/functions_func.html | 52 +- docs/html/hierarchy.html | 25 +- docs/html/index.hhc | 345 +++---- docs/html/index.hhk | 850 ++++++++++-------- docs/html/index.hhp | 50 +- docs/html/index.html | 4 +- .../src_backend_lib_api_hooks_DuckDuckGo.3 | 50 ++ docs/man/man3/src_backend_lib_config_Config.3 | 107 +++ .../src_backend_lib_display_TerminalDisplay.3 | 78 ++ .../man3/src_backend_lib_library_Catalogue.3 | 187 ++++ .../src_backend_lib_pyShelf_BookDisplay.3 | 107 +++ .../man3/src_backend_lib_pyShelf_InitFiles.3 | 42 + .../man3/src_backend_lib_storage_Storage.3 | 121 +++ ...src_backend_tests_config_test_TestConfig.3 | 35 + ...backend_tests_library_test_TestCatalogue.3 | 32 + ...ackend_tests_library_test_Test_Catalogue.3 | 179 ++++ ...c_backend_tests_library_test_Test_Config.3 | 88 ++ docs/warn.log | 238 ++--- src/interface/templates/index.html | 2 +- src/interface/templates/search.html | 2 +- 57 files changed, 4988 insertions(+), 776 deletions(-) create mode 100644 docs/html/d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html create mode 100644 docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html create mode 100644 docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html create mode 100644 docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png create mode 100644 docs/html/d3/d4a/classsrc_1_1backend_1_1lib_1_1config_1_1Config-members.html create mode 100644 docs/html/d3/d95/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html create mode 100644 docs/html/d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html create mode 100644 docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html create mode 100644 docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.png create mode 100644 docs/html/d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html create mode 100644 docs/html/d5/dee/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html create mode 100644 docs/html/d6/d20/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html create mode 100644 docs/html/d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html create mode 100644 docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html create mode 100644 docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html create mode 100644 docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html create mode 100644 docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html create mode 100644 docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.png create mode 100644 docs/html/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html create mode 100644 docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html create mode 100644 docs/html/db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html create mode 100644 docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html create mode 100644 docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png create mode 100644 docs/html/dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html create mode 100644 docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html create mode 100644 docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html create mode 100644 docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 create mode 100644 docs/man/man3/src_backend_lib_config_Config.3 create mode 100644 docs/man/man3/src_backend_lib_display_TerminalDisplay.3 create mode 100644 docs/man/man3/src_backend_lib_library_Catalogue.3 create mode 100644 docs/man/man3/src_backend_lib_pyShelf_BookDisplay.3 create mode 100644 docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 create mode 100644 docs/man/man3/src_backend_lib_storage_Storage.3 create mode 100644 docs/man/man3/src_backend_tests_config_test_TestConfig.3 create mode 100644 docs/man/man3/src_backend_tests_library_test_TestCatalogue.3 create mode 100644 docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3 create mode 100644 docs/man/man3/src_backend_tests_library_test_Test_Config.3 diff --git a/docs/html/HTML/index.html b/docs/html/HTML/index.html index c610c6b..4fe4f22 100644 --- a/docs/html/HTML/index.html +++ b/docs/html/HTML/index.html @@ -1,16 +1,16 @@ -pyShelf Open Source Ebook Server-0.3.0 +pyShelf Open Source Ebook Server-0.4.0 -

pyShelf Open Source Ebook Server-0.3.0

+

pyShelf Open Source Ebook Server-0.4.0

-Last updated Sun Dec 15 12:54:07 EST 2019
+Last updated Wed Jan 01 09:54:41 EST 2020
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/mains.html b/docs/html/HTML/mains.html index c610c6b..4fe4f22 100644 --- a/docs/html/HTML/mains.html +++ b/docs/html/HTML/mains.html @@ -1,16 +1,16 @@ -pyShelf Open Source Ebook Server-0.3.0 +pyShelf Open Source Ebook Server-0.4.0 -

pyShelf Open Source Ebook Server-0.3.0

+

pyShelf Open Source Ebook Server-0.4.0

-Last updated Sun Dec 15 12:54:07 EST 2019
+Last updated Wed Jan 01 09:54:41 EST 2020
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/rebuild.sh b/docs/html/HTML/rebuild.sh index a0ce080..c9ea341 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/src/backend && 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.3.0' /home/raelon/Projects/pyShelf/docs/html +cd /home/raelon/Projects/pyShelf/src/backend && 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.4.0' /home/raelon/Projects/pyShelf/docs/html diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 0cf1c06..fa4ac12 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -45,35 +45,36 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 123456]
- - - - - - - - - - - - - - - - - - - - - - +
[detail level 12345]
 ▼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
+ + + + + + + + + + + + + + + + + + + + + + +
 ▼Nsrc
 ▼Nbackend
 ▼Nlib
 ▼Napi_hooks
 CDuckDuckGo
 ▼Nconfig
 CConfig
 ▼Ndisplay
 CTerminalDisplay
 ▼Nlibrary
 CCatalogue
 ▼NpyShelf
 CBookDisplay
 CInitFiles
 ▼Nstorage
 CStorage
 ▼Ntests
 ▼Nconfig_test
 CTestConfig
 ▼Nlibrary_test
 CTest_Catalogue
 CTest_Config
 CTestCatalogue
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classes.html b/docs/html/classes.html index 98d2ccf..6f13f38 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -48,32 +48,33 @@ $(function() { - + - + - + - - - + + + - + - + + - - + + - +
  b  
Config (pyShelf.src.backend.lib.config)   Config (src.backend.lib.config)   
  s  
Test_Config (pyShelf.src.backend.tests.library_test)   Test_Catalogue (src.backend.tests.library_test)   
  d  
TestCatalogue (pyShelf.src.backend.tests.library_test)   Test_Config (src.backend.tests.library_test)   
BookDisplay (pyShelf.src.backend.lib.pyShelf)   Storage (pyShelf.src.backend.lib.storage)   TestConfig (pyShelf.src.backend.tests.config_test)   
BookDisplay (src.backend.lib.pyShelf)   Storage (src.backend.lib.storage)   TestCatalogue (src.backend.tests.library_test)   
  c  
DuckDuckGo (pyShelf.src.backend.lib.api_hooks)   DuckDuckGo (src.backend.lib.api_hooks)   
  t  
TestConfig (src.backend.tests.config_test)   
  i  
Catalogue (pyShelf.src.backend.lib.library)   Test_Catalogue (pyShelf.src.backend.tests.library_test)   
Catalogue (src.backend.lib.library)   TerminalDisplay (src.backend.lib.display)   
InitFiles (pyShelf.src.backend.lib.pyShelf)   
InitFiles (src.backend.lib.pyShelf)   
@@ -81,7 +82,7 @@ $(function() {
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html b/docs/html/d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html new file mode 100644 index 0000000..92f7c5d --- /dev/null +++ b/docs/html/d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html @@ -0,0 +1,129 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.display.TerminalDisplay Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.display.TerminalDisplay Class Reference
+
+
+ + + + + + + + + + + + + + + + +

+Public Member Functions

+def __init__ (self)
 
+def screen (self)
 
+def installer (self)
 
+def prompt (self, questions)
 
+def h_rule (self)
 
+def banner (self)
 
+def banner_render (self)
 
+ + + +

+Static Public Member Functions

+def clear ()
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

+ term
 
+ y
 
+ home
 
+ user
 
+ version
 
+ slogan
 
+ green
 
+ blue
 
+ clr_term
 
+

Detailed Description

+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html new file mode 100644 index 0000000..626db33 --- /dev/null +++ b/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html @@ -0,0 +1,64 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.pyShelf.InitFiles Member List
+
+
+ +

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

+ + + +
__init__(self, file_array) (defined in src.backend.lib.pyShelf.InitFiles)src.backend.lib.pyShelf.InitFiles
CreateFile(self, _pointer)src.backend.lib.pyShelf.InitFiles
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html b/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html new file mode 100644 index 0000000..d4e8a48 --- /dev/null +++ b/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html @@ -0,0 +1,167 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.tests.library_test.Test_Config Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.tests.library_test.Test_Config Class Reference
+
+
+
+ + Inheritance diagram for 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
 
+ db_host
 
+ db_port
 
+ file_array
 
+ root
 
+ auto_scan
 
+ allowed_hosts
 
+ db_user
 
+ db_pass
 
+

Detailed Description

+

Member Function Documentation

+ +

◆ open_file()

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

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

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png b/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png new file mode 100644 index 0000000000000000000000000000000000000000..d263ae18777b11ed87ebe78438cbd3c52de3936d GIT binary patch literal 853 zcmeAS@N?(olHy`uVBq!ia0vp^KY=)agBeJ^X;N+hQW60^A+G=b{|7Q(y!l$%e`o@b z1;z&s9ANFdBM;QAHhKg(_!fC~E%ns%-1w#TlZxlswz*sDYjgWm zWVM%`Q(J5A`AJH`>(WX)x4NW~M^Elu{c7*~*W{lt`OHl&>-?U1 z@y5Sjm;T>h`BAX?K)@uuFFciB_wUWN$nvjD?f!j^Yqk1%$@^#WVrNy}`*#8)ud*|8 z>&+I<-jjWf0e@`2dmQH6dvohTmDm?cbL1!GZ#_Qw`aXNVJcHeOpHFQ~IP+QjWbfzK z)pqZyKg^RqtG)H_rGQE2z9wy(9`z=>TJzUZrkw#(eLig6TgN)<=G{HNZ0(JwEXl6@ zU#;h9zplOUU-%RL`1|r}3nqOjd&{Zk`Mm1J2maLEDu0j9dNN7GdveUAq)gTLX{ntW z4gD|K1cDMz=5Jr|BJpJShXpSRPp0RxcP#Vd6Y!oaqcBa)(m}_!s3Bt36NZf@CmEA6 zCovznq{7~@6ivZ*?WI$kx>y7PV47kl@U!=)z4`lgL-zXKw~RY3+z4EE#-TQ6v;5sE z>3Vqu`;QDWo?i&Gzx(CR|1z<~nmhBkuk4L&-e$Hv@AoZ!UGq-?w!+Erx6aP|zPk4B z{k_vSzn1-Z_otEAEbF%xJU)7gCJ+s^ysPpO7xqEhPH5;Nff4UJ^yyou& z^P=Ccx4kUBvi@z;gF_eH7n|yQdwWbLck>y}%IR+(FP!(MVs`E}{*&8RJv^Bm@4qj6 zW{u^q9CPDMxzbA(Dm&ZBRJGQKd_B0w=(zex1538$mnQ$#*z)ACTkw%{oBvL#*)abx zC}tkcvv>M;$5y}D{mETh^P6$2*RFoMv~Ak0hh}j`3pGzx-p zYBuwIWqBuGmh}Ps3({qutxsmZ-L#yeVCiu+*$|6{^RJ$N4{H8=dz0(~TX + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.config.Config Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + +
__init__(self, root)src.backend.lib.config.Config
allowed_hosts (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
auto_scan (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
book_path (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
book_shelf (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
catalogue_db (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_host (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_pass (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_port (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_user (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
file_array (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
open_file(self, _cp)src.backend.lib.config.Config
password (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
root (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
TITLE (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
user (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
VERSION (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d3/d95/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html b/docs/html/d3/d95/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html new file mode 100644 index 0000000..09af39e --- /dev/null +++ b/docs/html/d3/d95/classsrc_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.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.tests.library_test.TestCatalogue Member List
+
+
+ +

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

+ + + + +
config (defined in src.backend.tests.library_test.TestCatalogue)src.backend.tests.library_test.TestCataloguestatic
root (defined in src.backend.tests.library_test.TestCatalogue)src.backend.tests.library_test.TestCataloguestatic
test_filter_books(self) (defined in src.backend.tests.library_test.TestCatalogue)src.backend.tests.library_test.TestCatalogue
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html b/docs/html/d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html new file mode 100644 index 0000000..a4a4734 --- /dev/null +++ b/docs/html/d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html @@ -0,0 +1,79 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.display.TerminalDisplay Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + +
__init__(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
banner(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
banner_render(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
blue (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
clear() (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplaystatic
clr_term (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
green (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
h_rule(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
home (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
installer(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
prompt(self, questions) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
screen(self) (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
slogan (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
term (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
user (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
version (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
y (defined in src.backend.lib.display.TerminalDisplay)src.backend.lib.display.TerminalDisplay
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html b/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html new file mode 100644 index 0000000..ee4ff15 --- /dev/null +++ b/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html @@ -0,0 +1,407 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.library.Catalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.library.Catalogue Class Reference
+
+
+
+ + Inheritance diagram for 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 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 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 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 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 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 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 src.backend.tests.library_test.Test_Catalogue.

+ +
+
+ +

◆ import_books()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def 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 src.backend.lib.library.Catalogue.process_book ( book)
+ 		+static
+
+
Return dictionary of epub file contents
+
+
+ +

◆ scan_folder()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def 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 Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.png b/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.png new file mode 100644 index 0000000000000000000000000000000000000000..22e8081e1ac0a38d0b3a339da0b802b4d818217b GIT binary patch literal 966 zcmeAS@N?(olHy`uVBq!ia0y~yVB`g|12~w0q{-?F%Yl?cfKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+19PaSi(^Oy5$;dAS@h{8$9Os7sZj)ak?*50b@I+ln`(l1;N1Lcs3I9Ixy`nYe zUu8-O9!Oq$G2n5*;h-H?^tc>u8VOom>HBDBe4{h%%KiL{8;ZY}oO_j)$#dVTH%j;F z@!(}WHGA9-Pm68HUK<*?zv>~|i@>*OQHv8#o-uise#%Cv;ds@;yd8V14JTdro^p4` zvWw@ZEPvIeZN>2YYt*uyuKaT%(GTWcJSW2H&05$ecz*tY+{g3ZzV%tT@a)5@|LdOm zFjh>ScKpYqCHtC=-4d8y#2oP5{6d86L$5rBSO5Ba7=Li9_AX%*(9BffZSb(}1%}_1 zO2(RoJcgA^7!yi&tM)BnG{|h9XaNk(1u3A=L{jdloXOzgCFRMi5Om2yiecg;w@VBi zQxE}G_F5Xg4Hi5~nJIZ8@#3yXi$Zr)h_c#o@# zoCe>PxzjsVM9Pq`zKd1VTvjujGs|uMql)YqvmEC-oBxv5T~--? zzsv2y?AMljPo~x9ZPNdFarN@duz77=51m$RTp26UFiS1b?#tp=b-D2uW*DjFb*;K` z<^9tO&wV&E=S)3$Nn+njx3wu*?Qxeg-d7bQD!3}=Y?^6Q^h>Tcu&h*cZn*l7J*m5I z`#e)Xc(Oujp`rMxr#>^&MX&KrmlF?ky3bwuSW+sxbg{WzsCmrBE~C_t%Hm}= z9=+))Ted~cZSVSRHzgkX1a4fug`c@K{nUvg6Dv*gxP#i$`40RupR1{)B(D(6;_6c8 zo#-y_mVCv1?=2;z{w<#-YWL0edc3~unCLeD)4*W<4h>&me06lV+{&C1puj=|H_&t;ucLK6TJyuCdD literal 0 HcmV?d00001 diff --git a/docs/html/d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html b/docs/html/d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html new file mode 100644 index 0000000..e6d7d43 --- /dev/null +++ b/docs/html/d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html @@ -0,0 +1,80 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.tests.library_test.Test_Config Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + +
__init__(self) (defined in src.backend.tests.library_test.Test_Config)src.backend.tests.library_test.Test_Config
src::backend::lib::config::Config.__init__(self, root)src.backend.lib.config.Config
allowed_hosts (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
auto_scan (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
book_path (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
book_shelf (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
catalogue_db (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_host (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_pass (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_port (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
db_user (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
file_array (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
open_file(self, root="config.json")src.backend.tests.library_test.Test_Config
password (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
root (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
TITLE (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
user (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
VERSION (defined in src.backend.lib.config.Config)src.backend.lib.config.Config
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d5/dee/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html b/docs/html/d5/dee/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html new file mode 100644 index 0000000..9f0bb13 --- /dev/null +++ b/docs/html/d5/dee/classsrc_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.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.tests.config_test.TestConfig Member List
+
+
+ +

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

+ + + + + +
config (defined in src.backend.tests.config_test.TestConfig)src.backend.tests.config_test.TestConfigstatic
test_book_dir(self) (defined in src.backend.tests.config_test.TestConfig)src.backend.tests.config_test.TestConfig
test_title(self) (defined in src.backend.tests.config_test.TestConfig)src.backend.tests.config_test.TestConfig
test_version(self) (defined in src.backend.tests.config_test.TestConfig)src.backend.tests.config_test.TestConfig
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d6/d20/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/d6/d20/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html new file mode 100644 index 0000000..ff25948 --- /dev/null +++ b/docs/html/d6/d20/classsrc_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.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.library.Catalogue Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + +
__init__(self, config) (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
book_folder (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
book_shelf (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
books (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
compare_shelf_current(self)src.backend.lib.library.Catalogue
config (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
cover_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
db_pointer (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)src.backend.lib.library.Catalogue
extract_metadata(self, book)src.backend.lib.library.Catalogue
file_list (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
filter_books(self)src.backend.lib.library.Catalogue
html_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
import_books(self, list=None)src.backend.lib.library.Catalogue
opf_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
process_book(book)src.backend.lib.library.Cataloguestatic
root_dir (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
scan_folder(self, _path=None)src.backend.lib.library.Catalogue
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html b/docs/html/d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html new file mode 100644 index 0000000..ad47d00 --- /dev/null +++ b/docs/html/d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html @@ -0,0 +1,220 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.storage.Storage Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.storage.Storage Class Reference
+
+
+ + + + + + + + + + + + + + + + +

+Public Member Functions

+def __init__ (self, config)
 
+def check_ownership (self, table=None)
 
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_host
 
+ db_port
 
+ db
 
+ config
 
+ cursor
 
+

Detailed Description

+
Contains all methods for system storage

Member Function Documentation

+ +

◆ book_paths_list()

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

◆ close()

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

◆ commit()

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

◆ create_tables()

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

◆ insert_book()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def 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 Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html new file mode 100644 index 0000000..7432d9d --- /dev/null +++ b/docs/html/d7/d69/classsrc_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.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.pyShelf.BookDisplay Member List
+
+
+ +

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

+ + + + + + + + + + + +
__init__(self, **kwargs)src.backend.lib.pyShelf.BookDisplay
books_per_page (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
booksPerPage(self, screen_size)src.backend.lib.pyShelf.BookDisplay
current_page (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
nextPage(self)src.backend.lib.pyShelf.BookDisplay
previousPage(self)src.backend.lib.pyShelf.BookDisplay
screen_size (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
thumbnail_scale (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
thumbnail_size (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
total_pages (defined in src.backend.lib.pyShelf.BookDisplay)src.backend.lib.pyShelf.BookDisplay
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html b/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html new file mode 100644 index 0000000..e86078a --- /dev/null +++ b/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html @@ -0,0 +1,113 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.api_hooks.DuckDuckGo Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.api_hooks.DuckDuckGo Class Reference
+
+
+ + + + + + +

+Public Member Functions

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

+Public Attributes

+ url
 
+

Detailed Description

+
duckduckgo related searching

Member Function Documentation

+ +

◆ image_result()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def src.backend.lib.api_hooks.DuckDuckGo.image_result ( self,
 query 
)
+
+
Returns json containing url to image
+:param _key: &t=h_&iar=images&iax=images&ia=images&format=json&pretty=1
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html b/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html new file mode 100644 index 0000000..c978887 --- /dev/null +++ b/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html @@ -0,0 +1,83 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.tests.library_test.TestCatalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Attributes | +List of all members
+
+
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 Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html b/docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html new file mode 100644 index 0000000..50d33d9 --- /dev/null +++ b/docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html @@ -0,0 +1,197 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.config.Config Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.config.Config Class Reference
+
+
+
+ + Inheritance diagram for 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
 
+ db_host
 
+ db_port
 
+ file_array
 
+ root
 
+ auto_scan
 
+ allowed_hosts
 
+ db_user
 
+ db_pass
 
+

Detailed Description

+
Main System Configuration
+

Constructor & Destructor Documentation

+ +

◆ __init__()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def src.backend.lib.config.Config.__init__ ( self,
 root 
)
+
+
Initialize main configuration options
+
+
+
+

Member Function Documentation

+ +

◆ open_file()

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

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

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.png b/docs/html/d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.png new file mode 100644 index 0000000000000000000000000000000000000000..c1f0983c5d75c5ea973c2b96c6f7594cad1452ff GIT binary patch literal 858 zcmV-g1Eu_lP)vTJkN^MxkN^Mxkifve1&Q1r00008bW%=J0RR90|NsC0)yh;d0008%Nkl$0;T3`LilnZExce;!c?7ccc(+J2$q9t$La1tI=rnx@I6m;fAVkOTPAAP4ZJ z?~`}^_kynd^D908`|8x+r6>awx>KlMMt)#)5M=3U`fnjTMIN_%amiahH)FSbttYxQ zwxRmW^Z8ZYU$5nVj8g8{1w()nJ!iYckMF!4xhK6gi)CerwIt6OUwPLdjbCZMX9#ej zC&|sM)gsK+nC$3mN_o#qq^?72c5Vo8qFdSCC6BeIB+q>xPHr%pF7rxZyF8yrZi1iR z^M2pOd%owFYWt}nz_D&-d#c4{ZBIo%RiI+4QYMtOJ%0r%@5V2G&yNfN&h`E8Il!;$ z@*@8$^2^uvS1TOApKDEUfMZ=Y{GeG7!wI15m*oN|% z82i+&&b*!N>;D=(on0HKJp6XZAlmiCSjEvN@;qYaUz?V9U2ke6i*5G8-adxBGg~!t zKTvh7?NDh{tgl+8B{%k!yIF_Hj?Shu3oaasdv0g4?H%$a+xtT;`Q9?yZ10lCs!@{X zzLtEgGTY^7v)y=Xw)G};0~zw}&>iyLu6O*l+gT+^H#s_|(vp|EP?L8XRS`SR_EYlC zdiL*mzwgF9ze4`pJx_ys + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.InitFiles Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +List of all members
+
+
src.backend.lib.pyShelf.InitFiles Class Reference
+
+
+ + + + + + +

+Public Member Functions

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

Detailed Description

+
First run file creation operations

Member Function Documentation

+ +

◆ CreateFile()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def src.backend.lib.pyShelf.InitFiles.CreateFile ( self,
 _pointer 
)
+
+
Checks if file exists and creates it if not
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html b/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html new file mode 100644 index 0000000..fcbeb4b --- /dev/null +++ b/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html @@ -0,0 +1,206 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.BookDisplay Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.lib.pyShelf.BookDisplay Class Reference
+
+
+ + + + + + + + + + +

+Public Member Functions

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__()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def src.backend.lib.pyShelf.BookDisplay.__init__ ( self,
** kwargs 
)
+
+
Initialize class variables
+:return: None
+
+
+
+

Member Function Documentation

+ +

◆ booksPerPage()

+ +
+
+ + + + + + + + + + + + + + + + + + +
def src.backend.lib.pyShelf.BookDisplay.booksPerPage ( self,
 screen_size 
)
+
+
## TODO Remove me
+Set books per page
+:param screen_size: Array containing x,y pixel sizes
+:return: self.books_per_page
+
+
+
+ +

◆ nextPage()

+ +
+
+ + + + + + + + +
def src.backend.lib.pyShelf.BookDisplay.nextPage ( self)
+
+
## TODO Remove me
+Goto next book page
+:return: new current_page
+
+
+
+ +

◆ previousPage()

+ +
+
+ + + + + + + + +
def src.backend.lib.pyShelf.BookDisplay.previousPage ( self)
+
+
## TODO Remove me
+Goto previous book page
+:return: new current_page
+
+
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html new file mode 100644 index 0000000..f4d2cbe --- /dev/null +++ b/docs/html/db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html @@ -0,0 +1,77 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.storage.Storage Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + +
__init__(self, config) (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
book_paths_list(self)src.backend.lib.storage.Storage
check_ownership(self, table=None) (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
close(self)src.backend.lib.storage.Storage
commit(self)src.backend.lib.storage.Storage
config (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
create_tables(self)src.backend.lib.storage.Storage
cursor (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
db (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
db_host (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
db_port (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
insert_book(self, book)src.backend.lib.storage.Storage
password (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
sql (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
user (defined in src.backend.lib.storage.Storage)src.backend.lib.storage.Storage
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html b/docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html new file mode 100644 index 0000000..ba67401 --- /dev/null +++ b/docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html @@ -0,0 +1,462 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.tests.library_test.Test_Catalogue Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
src.backend.tests.library_test.Test_Catalogue Class Reference
+
+
+
+ + Inheritance diagram for 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 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 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 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 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 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 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 src.backend.lib.library.Catalogue.

+ +
+
+ +

◆ import_books()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
def 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 src.backend.lib.library.Catalogue.process_book ( book)
+ 		+staticinherited
+
+
Return dictionary of epub file contents
+
+
+ +

◆ scan_folder()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
def 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 Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png b/docs/html/db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png new file mode 100644 index 0000000000000000000000000000000000000000..2532ba5bc84ed8c39b96a694a99d8d2f00566f89 GIT binary patch literal 962 zcmeAS@N?(olHy`uVBq!ia0y~yVB`g|12~w0q{-?F%Yl?cfKQ0)|NsAi%olIImi8Z- z0AzvjfddCvJMYK?xf~@ye!&btMIdnXREQA+19PCKi(^Oy!rMA38NzuCu>JmVH_ z{<(esU(q^8VxtGBvzr32ACpq1H?ZR`HD}ZFOK=_iv9N&T|9sB@{P^W z{)>M;%bb#vDaEh8bnbC?lV4l3J)h4yy{PW%A>IK0eYbszO{$EPdylK9%1l(Tz0O^E z`0d@v6I=FmS3aI|tZ;eEDQUfz9+#5$mIXx}d;e~V-9hWc_cYn2aXymKowvX7^|AY> zU(XG4DxZG+<9F@yE|pr3;M;$fvekDSyK`sRxi*#0|5&9q2hX;Yo^#V(T1wqbi^elj8@J-=#wWAtpR&SzUp`ZTvi z0i!Kzc9x83)|qwtYI%DXm|riJIidSM;!60Z#pdyc*Vyn1A8s{CHr}nlVCu6d`-S_} zZ%Z#{E|_raXQf1#qExZV;`xi0Z%kh{&+T)siI9`+sgoO0p2)4d%|$$I%R ztv-eJRPhz9RBE}nQnTPb=tk + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.tests.library_test.Test_Catalogue Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + +
__init__(self) (defined in src.backend.tests.library_test.Test_Catalogue)src.backend.tests.library_test.Test_Catalogue
__init__(self, config) (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
book_folder (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
book_shelf (defined in src.backend.tests.library_test.Test_Catalogue)src.backend.tests.library_test.Test_Catalogue
books (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
compare_shelf_current(self)src.backend.lib.library.Catalogue
config (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
cover_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
db_pointer (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)src.backend.lib.library.Catalogue
extract_metadata(self, book)src.backend.lib.library.Catalogue
file_list (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
filter_books(self)src.backend.tests.library_test.Test_Catalogue
html_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
import_books(self, list=None)src.backend.lib.library.Catalogue
opf_regx (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
process_book(book)src.backend.lib.library.Cataloguestatic
root_dir (defined in src.backend.lib.library.Catalogue)src.backend.lib.library.Catalogue
scan_folder(self, _path=None)src.backend.lib.library.Catalogue
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html new file mode 100644 index 0000000..55b343e --- /dev/null +++ b/docs/html/de/d11/classsrc_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.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
src.backend.lib.api_hooks.DuckDuckGo Member List
+
+
+ +

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

+ + + + +
__init__(self) (defined in src.backend.lib.api_hooks.DuckDuckGo)src.backend.lib.api_hooks.DuckDuckGo
image_result(self, query)src.backend.lib.api_hooks.DuckDuckGo
url (defined in src.backend.lib.api_hooks.DuckDuckGo)src.backend.lib.api_hooks.DuckDuckGo
+ +
+Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html b/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html new file mode 100644 index 0000000..bc28bae --- /dev/null +++ b/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html @@ -0,0 +1,86 @@ + + + + + + + +pyShelf Open Source Ebook Server: src.backend.tests.config_test.TestConfig Class Reference + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.4.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+Public Member Functions | +Static Public Attributes | +List of all members
+
+
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 Wed Jan 1 2020 09:54:41 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 index e0f30e1..308f4df 100644 --- a/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html +++ b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -51,7 +51,7 @@ $(function() {
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 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 index 267c996..3129658 100644 --- a/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html +++ b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -55,7 +55,7 @@ Directories
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index aa80e43..7e4182d 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -55,7 +55,7 @@ Directories
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 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 index 7973a41..22365cb 100644 --- a/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html +++ b/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -51,7 +51,7 @@ $(function() {
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/files.html b/docs/html/files.html index 44fb9b7..fb05f8e 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -52,21 +52,22 @@ $(function() {  __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 + display.py + library.py + pyShelf.py + storage.py + ▼ tests + __init__.py + config_test.py + library_test.py + __init__.py + pyShelf_ScanLibrary.py
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/functions.html b/docs/html/functions.html index d7ac943..8d4b0b8 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -42,76 +42,76 @@ $(function() {
Here is a list of all documented class members with links to the class documentation for each member:
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 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 index c71a6b5..d375f54 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -42,76 +42,76 @@ $(function() {
 
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index bacea1f..9148d1a 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
Open source, console based E-book server
@@ -46,22 +46,23 @@ $(function() {
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
- - - - - - - - - - + + + + + + + + + + +
 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.backend.lib.storage.Storage
 CpyShelf.src.backend.tests.library_test.TestCatalogue
 CpyShelf.src.backend.tests.config_test.TestConfig
 Csrc.backend.lib.pyShelf.BookDisplay
 ▼Csrc.backend.lib.library.Catalogue
 Csrc.backend.tests.library_test.Test_Catalogue
 ▼Csrc.backend.lib.config.Config
 Csrc.backend.tests.library_test.Test_Config
 Csrc.backend.lib.api_hooks.DuckDuckGo
 Csrc.backend.lib.pyShelf.InitFiles
 Csrc.backend.lib.storage.Storage
 Csrc.backend.lib.display.TerminalDisplay
 Csrc.backend.tests.library_test.TestCatalogue
 Csrc.backend.tests.config_test.TestConfig
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/index.hhc b/docs/html/index.hhc index d1f6a98..99b5e6b 100644 --- a/docs/html/index.hhc +++ b/docs/html/index.hhc @@ -8,165 +8,192 @@
    • -
    • +
      • -
      • +
        • -
        • +
          • -
          • +
            • -
            • +
              • -
              • -
                  -
                • -
                • -
                • -
                -
              -
            • -
                -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                -
              -
            • -
                -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                -
              -
            • -
                -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                -
              • -
                  -
                • -
                • -
                -
              -
            • -
                -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                +
              • +
              • +
            -
          • +
            • -
            • +
              • -
              • -
                  -
                • -
                • -
                • -
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              -
            • +
            +
          • +
              +
              • -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                -
              • -
                  -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                • -
                -
              • -
                  -
                • -
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            +
          • +
              +
            • +
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            +
          • +
              +
            • +
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            • +
                +
              • +
              • +
              +
            +
          • +
              +
            • +
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            +
          +
        • +
            +
          • +
              +
            • +
                +
              • +
              • +
              • +
              +
            +
          • +
              +
            • +
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            • +
                +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              • +
              +
            • +
                +
          @@ -176,20 +203,21 @@
          • -
          • -
          • +
          • +
            • -
            • +
            -
          • +
            • -
            • +
            -
          • -
          • -
          • -
          • -
          • +
          • +
          • +
          • +
          • +
          • +
          • @@ -210,6 +238,7 @@
          • +
          • diff --git a/docs/html/index.hhk b/docs/html/index.hhk index ef7d9f0..ff436e5 100644 --- a/docs/html/index.hhk +++ b/docs/html/index.hhk @@ -4,642 +4,780 @@
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • -
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
              • -
              • +
              -
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
            • +
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
            • +
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • +
            • +
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • -
            • -
            • -
            • -
            • -
            • -
            • +
              • -
              • +
              -
            • -
            • -
            • -
            • +
              • -
              • +
              -
            • +
              • -
              • +
              -
            • -
            • +
              • -
              • +
              -
            • +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
            • +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
            • +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
            • +
            • +
            • +
            • +
            • +
            • +
            • +
            • +
                +
              • +
              +
            • +
            • +
            • +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
                +
              • +
              +
            • +
            • +
            • +
            • +
            diff --git a/docs/html/index.hhp b/docs/html/index.hhp index 658ebb0..4bc8d52 100644 --- a/docs/html/index.hhp +++ b/docs/html/index.hhp @@ -14,26 +14,28 @@ Title=pyShelf Open Source Ebook Server main="pyShelf Open Source Ebook Server","index.hhc","index.hhk","index.html","index.html",,,,,0x23520,,0x70387e,,,,,,,,0 [FILES] -dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html -dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html -d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html -d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html -d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html -da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html -d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html -dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html -dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html -da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html -d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html -dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html -df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html -dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html -d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html -d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html -d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html -d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html -d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html -d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html +d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html +d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.html +d3/d4a/classsrc_1_1backend_1_1lib_1_1config_1_1Config-members.html +d0/d35/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay.html +d4/d45/classsrc_1_1backend_1_1lib_1_1display_1_1TerminalDisplay-members.html +d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html +d6/d20/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html +db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html +d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html +da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html +d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html +d7/d40/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage.html +db/d9a/classsrc_1_1backend_1_1lib_1_1storage_1_1Storage-members.html +df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html +d5/dee/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html +db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html +dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html +d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html +d5/ddf/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html +d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html +d3/d95/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html dir_3f615ade772d23cefe5e20dcb18424a2.html dir_1c7294442ce83d360610449d04c9d7fc.html dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -58,7 +60,7 @@ open.png bdwn.png sync_on.png sync_off.png -d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png -d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png -d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png -d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png +d8/dfe/classsrc_1_1backend_1_1lib_1_1config_1_1Config.png +d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.png +db/dda/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png +d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png diff --git a/docs/html/index.html b/docs/html/index.html index a272a65..5908bf4 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -19,7 +19,7 @@
            pyShelf Open Source Ebook Server -  0.3.0 +  0.4.0
            Open source, console based E-book server
            @@ -47,7 +47,7 @@ $(function() {
            -Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +Generated on Wed Jan 1 2020 09:54:41 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
            diff --git a/docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 b/docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 new file mode 100644 index 0000000..3347e3f --- /dev/null +++ b/docs/man/man3/src_backend_lib_api_hooks_DuckDuckGo.3 @@ -0,0 +1,50 @@ +.TH "src.backend.lib.api_hooks.DuckDuckGo" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.api_hooks.DuckDuckGo +.SH SYNOPSIS +.br +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self)" +.br +.ti -1c +.RI "def \fBimage_result\fP (self, query)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBurl\fP" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +duckduckgo related searching +.fi +.PP + +.SH "Member Function Documentation" +.PP +.SS "def src\&.backend\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)" + +.PP +.nf +Returns json containing url to image +:param _key: &t=h_&iar=images&iax=images&ia=images&format=json&pretty=1 + +.fi +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/src_backend_lib_config_Config.3 b/docs/man/man3/src_backend_lib_config_Config.3 new file mode 100644 index 0000000..dbeea06 --- /dev/null +++ b/docs/man/man3/src_backend_lib_config_Config.3 @@ -0,0 +1,107 @@ +.TH "src.backend.lib.config.Config" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.config.Config +.SH SYNOPSIS +.br +.PP +.PP +Inherited by \fBsrc\&.backend\&.tests\&.library_test\&.Test_Config\fP\&. +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self, root)" +.br +.ti -1c +.RI "def \fBopen_file\fP (self, _cp)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBbook_path\fP" +.br +.ti -1c +.RI "\fBTITLE\fP" +.br +.ti -1c +.RI "\fBVERSION\fP" +.br +.ti -1c +.RI "\fBbook_shelf\fP" +.br +.ti -1c +.RI "\fBcatalogue_db\fP" +.br +.ti -1c +.RI "\fBuser\fP" +.br +.ti -1c +.RI "\fBpassword\fP" +.br +.ti -1c +.RI "\fBdb_host\fP" +.br +.ti -1c +.RI "\fBdb_port\fP" +.br +.ti -1c +.RI "\fBfile_array\fP" +.br +.ti -1c +.RI "\fBroot\fP" +.br +.ti -1c +.RI "\fBauto_scan\fP" +.br +.ti -1c +.RI "\fBallowed_hosts\fP" +.br +.ti -1c +.RI "\fBdb_user\fP" +.br +.ti -1c +.RI "\fBdb_pass\fP" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +Main System Configuration + +.fi +.PP + +.SH "Constructor & Destructor Documentation" +.PP +.SS "def src\&.backend\&.lib\&.config\&.Config\&.__init__ ( self, root)" + +.PP +.nf +Initialize main configuration options + +.fi +.PP + +.SH "Member Function Documentation" +.PP +.SS "def src\&.backend\&.lib\&.config\&.Config\&.open_file ( self, _cp)" + +.PP +.nf +Opens config.json and reads in configuration options + +.fi +.PP + +.PP +Reimplemented in \fBsrc\&.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/src_backend_lib_display_TerminalDisplay.3 b/docs/man/man3/src_backend_lib_display_TerminalDisplay.3 new file mode 100644 index 0000000..e9185af --- /dev/null +++ b/docs/man/man3/src_backend_lib_display_TerminalDisplay.3 @@ -0,0 +1,78 @@ +.TH "src.backend.lib.display.TerminalDisplay" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.display.TerminalDisplay +.SH SYNOPSIS +.br +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self)" +.br +.ti -1c +.RI "def \fBscreen\fP (self)" +.br +.ti -1c +.RI "def \fBinstaller\fP (self)" +.br +.ti -1c +.RI "def \fBprompt\fP (self, questions)" +.br +.ti -1c +.RI "def \fBh_rule\fP (self)" +.br +.ti -1c +.RI "def \fBbanner\fP (self)" +.br +.ti -1c +.RI "def \fBbanner_render\fP (self)" +.br +.in -1c +.SS "Static Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fBclear\fP ()" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBterm\fP" +.br +.ti -1c +.RI "\fBy\fP" +.br +.ti -1c +.RI "\fBhome\fP" +.br +.ti -1c +.RI "\fBuser\fP" +.br +.ti -1c +.RI "\fBversion\fP" +.br +.ti -1c +.RI "\fBslogan\fP" +.br +.ti -1c +.RI "\fBgreen\fP" +.br +.ti -1c +.RI "\fBblue\fP" +.br +.ti -1c +.RI "\fBclr_term\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/src_backend_lib_library_Catalogue.3 b/docs/man/man3/src_backend_lib_library_Catalogue.3 new file mode 100644 index 0000000..2a18f7f --- /dev/null +++ b/docs/man/man3/src_backend_lib_library_Catalogue.3 @@ -0,0 +1,187 @@ +.TH "src.backend.lib.library.Catalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.library.Catalogue +.SH SYNOPSIS +.br +.PP +.PP +Inherited by \fBsrc\&.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 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 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 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 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 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 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 \fBsrc\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&. +.SS "def 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 src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP" + +.PP +.nf +Return dictionary of epub file contents +.fi +.PP + +.SS "def src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)" + +.PP +.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/src_backend_lib_pyShelf_BookDisplay.3 b/docs/man/man3/src_backend_lib_pyShelf_BookDisplay.3 new file mode 100644 index 0000000..6f09925 --- /dev/null +++ b/docs/man/man3/src_backend_lib_pyShelf_BookDisplay.3 @@ -0,0 +1,107 @@ +.TH "src.backend.lib.pyShelf.BookDisplay" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.pyShelf.BookDisplay +.SH SYNOPSIS +.br +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self, **kwargs)" +.br +.ti -1c +.RI "def \fBnextPage\fP (self)" +.br +.ti -1c +.RI "def \fBpreviousPage\fP (self)" +.br +.ti -1c +.RI "def \fBbooksPerPage\fP (self, screen_size)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBbooks_per_page\fP" +.br +.ti -1c +.RI "\fBcurrent_page\fP" +.br +.ti -1c +.RI "\fBthumbnail_size\fP" +.br +.ti -1c +.RI "\fBthumbnail_scale\fP" +.br +.ti -1c +.RI "\fBtotal_pages\fP" +.br +.ti -1c +.RI "\fBscreen_size\fP" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +All functions related to displaying book information in the HTML UI +.fi +.PP + +.SH "Constructor & Destructor Documentation" +.PP +.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self, ** kwargs)" + +.PP +.nf +Initialize class variables +:return: None + +.fi +.PP + +.SH "Member Function Documentation" +.PP +.SS "def 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 src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)" + +.PP +.nf +## TODO Remove me +Goto next book page +:return: new current_page + +.fi +.PP + +.SS "def src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)" + +.PP +.nf +## TODO Remove me +Goto previous book page +:return: new current_page + +.fi +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 b/docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 new file mode 100644 index 0000000..4f528de --- /dev/null +++ b/docs/man/man3/src_backend_lib_pyShelf_InitFiles.3 @@ -0,0 +1,42 @@ +.TH "src.backend.lib.pyShelf.InitFiles" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.pyShelf.InitFiles +.SH SYNOPSIS +.br +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self, file_array)" +.br +.ti -1c +.RI "def \fBCreateFile\fP (self, _pointer)" +.br +.in -1c +.SH "Detailed Description" +.PP + +.PP +.nf +First run file creation operations +.fi +.PP + +.SH "Member Function Documentation" +.PP +.SS "def src\&.backend\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)" + +.PP +.nf +Checks if file exists and creates it if not + +.fi +.PP + + +.SH "Author" +.PP +Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/src_backend_lib_storage_Storage.3 b/docs/man/man3/src_backend_lib_storage_Storage.3 new file mode 100644 index 0000000..43aebee --- /dev/null +++ b/docs/man/man3/src_backend_lib_storage_Storage.3 @@ -0,0 +1,121 @@ +.TH "src.backend.lib.storage.Storage" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.lib.storage.Storage +.SH SYNOPSIS +.br +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self, config)" +.br +.ti -1c +.RI "def \fBcheck_ownership\fP (self, table=None)" +.br +.ti -1c +.RI "def \fBcreate_tables\fP (self)" +.br +.ti -1c +.RI "def \fBinsert_book\fP (self, book)" +.br +.ti -1c +.RI "def \fBbook_paths_list\fP (self)" +.br +.ti -1c +.RI "def \fBcommit\fP (self)" +.br +.ti -1c +.RI "def \fBclose\fP (self)" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBsql\fP" +.br +.ti -1c +.RI "\fBuser\fP" +.br +.ti -1c +.RI "\fBpassword\fP" +.br +.ti -1c +.RI "\fBdb_host\fP" +.br +.ti -1c +.RI "\fBdb_port\fP" +.br +.ti -1c +.RI "\fBdb\fP" +.br +.ti -1c +.RI "\fBconfig\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 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 src\&.backend\&.lib\&.storage\&.Storage\&.close ( self)" + +.PP +.nf +Close database connection + +.fi +.PP + +.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.commit ( self)" + +.PP +.nf +Commit database transactions + +.fi +.PP + +.SS "def src\&.backend\&.lib\&.storage\&.Storage\&.create_tables ( self)" + +.PP +.nf +Create table structure +.fi +.PP + +.SS "def 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/src_backend_tests_config_test_TestConfig.3 b/docs/man/man3/src_backend_tests_config_test_TestConfig.3 new file mode 100644 index 0000000..bace3ca --- /dev/null +++ b/docs/man/man3/src_backend_tests_config_test_TestConfig.3 @@ -0,0 +1,35 @@ +.TH "src.backend.tests.config_test.TestConfig" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +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/src_backend_tests_library_test_TestCatalogue.3 b/docs/man/man3/src_backend_tests_library_test_TestCatalogue.3 new file mode 100644 index 0000000..90b6072 --- /dev/null +++ b/docs/man/man3/src_backend_tests_library_test_TestCatalogue.3 @@ -0,0 +1,32 @@ +.TH "src.backend.tests.library_test.TestCatalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +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/src_backend_tests_library_test_Test_Catalogue.3 b/docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3 new file mode 100644 index 0000000..4149984 --- /dev/null +++ b/docs/man/man3/src_backend_tests_library_test_Test_Catalogue.3 @@ -0,0 +1,179 @@ +.TH "src.backend.tests.library_test.Test_Catalogue" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.tests.library_test.Test_Catalogue +.SH SYNOPSIS +.br +.PP +.PP +Inherits \fBsrc\&.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 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 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 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 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 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 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 \fBsrc\&.backend\&.lib\&.library\&.Catalogue\fP\&. +.SS "def 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 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 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/src_backend_tests_library_test_Test_Config.3 b/docs/man/man3/src_backend_tests_library_test_Test_Config.3 new file mode 100644 index 0000000..4a44df5 --- /dev/null +++ b/docs/man/man3/src_backend_tests_library_test_Test_Config.3 @@ -0,0 +1,88 @@ +.TH "src.backend.tests.library_test.Test_Config" 3 "Wed Jan 1 2020" "Version 0.4.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.ad l +.nh +.SH NAME +src.backend.tests.library_test.Test_Config +.SH SYNOPSIS +.br +.PP +.PP +Inherits \fBsrc\&.backend\&.lib\&.config\&.Config\fP\&. +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "def \fB__init__\fP (self)" +.br +.ti -1c +.RI "def \fBopen_file\fP (self, root='config\&.json')" +.br +.in -1c +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "\fBbook_path\fP" +.br +.ti -1c +.RI "\fBTITLE\fP" +.br +.ti -1c +.RI "\fBVERSION\fP" +.br +.ti -1c +.RI "\fBbook_shelf\fP" +.br +.ti -1c +.RI "\fBcatalogue_db\fP" +.br +.ti -1c +.RI "\fBuser\fP" +.br +.ti -1c +.RI "\fBpassword\fP" +.br +.ti -1c +.RI "\fBdb_host\fP" +.br +.ti -1c +.RI "\fBdb_port\fP" +.br +.ti -1c +.RI "\fBfile_array\fP" +.br +.ti -1c +.RI "\fBroot\fP" +.br +.ti -1c +.RI "\fBauto_scan\fP" +.br +.ti -1c +.RI "\fBallowed_hosts\fP" +.br +.ti -1c +.RI "\fBdb_user\fP" +.br +.ti -1c +.RI "\fBdb_pass\fP" +.br +.in -1c +.SH "Detailed Description" +.PP +.SH "Member Function Documentation" +.PP +.SS "def 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 \fBsrc\&.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/warn.log b/docs/warn.log index 30ea500..39ffa46 100644 --- a/docs/warn.log +++ b/docs/warn.log @@ -1,106 +1,132 @@ -/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/backend/tests/config_test.py:6: warning: Compound pyShelf::src::backend::tests::config_test::TestConfig 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/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:20: 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:21: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: 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:27: 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:28: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member db_host (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member db_port (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: 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:36: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: 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:39: 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:15: 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:17: warning: Member sql (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:18: warning: Member user (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:19: warning: Member password (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:20: warning: Member db_host (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:21: warning: Member db_port (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:22: warning: Member db (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:25: warning: Member cursor (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:58: 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:81: warning: return type of member pyShelf.src.backend.lib.storage.Storage.close is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:71: warning: return type of member pyShelf.src.backend.lib.storage.Storage.commit is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:28: 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:39: 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:20: 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:21: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: 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:27: 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:28: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member db_host (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member db_port (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: 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:36: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: 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/backend/lib/display.py:9: warning: Compound src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:19: warning: Compound src::backend::tests::library_test::Test_Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:8: warning: Compound src::backend::tests::library_test::Test_Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:28: warning: Compound src::backend::tests::library_test::TestCatalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:6: warning: Compound src::backend::tests::config_test::TestConfig is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:12: warning: Member __init__(self) (function) of class 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 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 src.backend.lib.api_hooks.DuckDuckGo.image_result is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:40: warning: return type of member src.backend.lib.config.Config.open_file is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:10: warning: Member __init__(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:21: warning: Member screen(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:24: warning: Member installer(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:82: warning: Member prompt(self, questions) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:93: warning: Member h_rule(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:96: warning: Member banner(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:106: warning: Member banner_render(self) (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:79: warning: Member clear() (function) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:11: warning: Member term (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:12: warning: Member y (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:13: warning: Member home (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:14: warning: Member user (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:15: warning: Member version (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:16: warning: Member slogan (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:17: warning: Member green (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:18: warning: Member blue (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/display.py:19: warning: Member clr_term (variable) of class src::backend::lib::display::TerminalDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:22: warning: Member __init__(self, config) (function) of class 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 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 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 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 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 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 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 src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class 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 src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member 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 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 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 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 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 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 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 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 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 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 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 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 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 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 src::backend::lib::pyShelf::BookDisplay is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:40: warning: parameters of member 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 src.backend.lib.pyShelf.BookDisplay.booksPerPage is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:55: warning: return type of member src.backend.lib.pyShelf.BookDisplay.nextPage is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:64: warning: return type of member 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 src::backend::lib::pyShelf::InitFiles is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:27: warning: return type of member src.backend.lib.pyShelf.InitFiles.CreateFile is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:15: warning: Member __init__(self, config) (function) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:27: warning: Member check_ownership(self, table=None) (function) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:16: warning: Member sql (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:17: warning: Member user (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:18: warning: Member password (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:19: warning: Member db_host (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:20: warning: Member db_port (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:21: warning: Member db (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:24: warning: Member config (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:25: warning: Member cursor (variable) of class src::backend::lib::storage::Storage is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:76: warning: return type of member src.backend.lib.storage.Storage.book_paths_list is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:99: warning: return type of member src.backend.lib.storage.Storage.close is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:89: warning: return type of member src.backend.lib.storage.Storage.commit is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:46: warning: return type of member src.backend.lib.storage.Storage.create_tables is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:57: warning: return type of member 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 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 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 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 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 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 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 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 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 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 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 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 src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:31: warning: Member books (variable) of class 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 src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:33: warning: Member config (variable) of class src::backend::lib::library::Catalogue is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/library.py:140: warning: return type of member 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 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 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 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 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 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 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 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 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 src::backend::tests::library_test::Test_Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:20: warning: Member book_path (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member TITLE (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:22: warning: Member VERSION (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member book_shelf (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member catalogue_db (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member user (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member password (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:28: warning: Member db_host (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:29: warning: Member db_port (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:30: warning: Member file_array (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:33: warning: Member root (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: Member auto_scan (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:36: warning: Member allowed_hosts (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:37: warning: Member db_user (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/lib/config.py:38: warning: Member db_pass (variable) of class src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:13: warning: return type of member 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 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 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 src::backend::tests::library_test::TestCatalogue is not documented. diff --git a/src/interface/templates/index.html b/src/interface/templates/index.html index 6935f17..3ed459a 100755 --- a/src/interface/templates/index.html +++ b/src/interface/templates/index.html @@ -18,7 +18,7 @@
            -

            pyShelf 0.3.0

            +

            pyShelf 0.4.0

            "An elegant tool... for a more civilized age."

            diff --git a/src/interface/templates/search.html b/src/interface/templates/search.html index 8b56ff8..f191fb7 100644 --- a/src/interface/templates/search.html +++ b/src/interface/templates/search.html @@ -18,7 +18,7 @@
            -

            pyShelf 0.3.0

            +

            pyShelf 0.4.0

            "An elegant tool... for a more civilized age."