diff --git a/README.md b/README.md index acff567..6f6fc4e 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,69 @@ -# pyShelf 0.2.1 -## Patch Notes. -* fixed missing src/interface/models.py. thanks to u/thelastpenguin212 -* Removed un necessary data files from repo +# pyShelf 0.3.0 -

A simple terminal based ebook server

+

Terminal based ebook server. Open source & Lightweight.

+ +Having used Calibre for hosting my eBook collection in the past, I found myself frustrated having to install X on my server, or manage my library externally, Thus I have decided to spin up my own. + +## Current Features +* Recursive Scanning +* Fast database access +* Django based frontend +* Basic seaching via a SearchVector of author, title, & file_name fields. + +## Currently Supported Formats +* epub + +## Installation Example +* In addition to the above steps you must now also make the requisite changes in config.json to reflect the connection to your postgresql server Server Frontend -Frustrated with Calibre being my only option for hosting my eBook collection, I have decided to spin up my own. +## 0.3.0 Patch Notes. +### "And now we search." -Calibre is a great organizational tool for your books, however not having a terminal based option for running and maintaining -a server is cumbersome when running on a headless server. -Calibre does have a console based server solution, However there is currently no way to create, and manage your library in a headless enviroment. - -Thus I am creating pyShelf and I hope to be able to provide all the functionality required to organize and host all your ebooks. - -I am open to and hoping for community help in the design and execution of this program. +Just about all the changes in this release were in some way related to implementing the search features. +There is one new requirement +* Requirement: **PostgreSQL** +*This is what I believe to be the last infrastructure requirement, users with larger libraries should notice an increase in access speed.* +* Feature: **Searching** +*The search feature is now implemented. In its current incarnation you will by default search the author, title, & file_name fields. More defined search options will be available in future releases. Searches are paginated @ 20 results per page.* +* Discord [https://discord.gg/H9TbNJS](https://discord.gg/H9TbNJS) +* IRC find us on freenode.net @ #pyshelf ## Development -pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks. -Before developing, run `pre-commit install`. -See the [documentation](https://pre-commit.com/) for more information. +* [`pre-commit`](https://pre-commit.com/) + * Before developing, run `pre-commit install`. + * See the [documentation](https://pre-commit.com/) for more information. -pyShelf uses ['Doxygen'](http://www.doxygen.nl/) for source code documentation. -Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting. +* ['Doxygen'](http://www.doxygen.nl/) + * Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting. -pyShelf follows ['sem-ver'](https://semver.org) standards. Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly. +* ['sem-ver'](https://semver.org) + * Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly. ## Configuration -All pyShelf configuration is done in config.py. -### Nginx configuration -I have included a default nginx config file pyshelf_nginx.conf. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact. +### Nginx +Included is a default nginx config file {pyshelf_nginx.conf}. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact. Further resources for nginx setup may be found @ [This nginx, django, & uwsgi, guide](https://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html) -### uwsgi configuration +### uwsgi Inside uwsgi.ini you should make changes to reflect your install directory, and the port you wish uwsgi to listen on. Alternativly you can make the requisite changes to listen on a socket instead. This change would also require a change to the pyshelf_nginx.conf file as well. -### pyShelf configuration -User configuration is contained within config.json in the project root. The only currently required configuration is to set book_path to the location of your books. +### pyShelf +User configuration is contained within config.json in the project root. You must set book_path to the location of your books, and change the database connection details to match your environment. -## Current Features -Currently pyShelf will recursively scan your collection, extract and store some metadata in the sqlite database. It will also provide you with a web based frontend to view and download your books. Note that this is a very early alpha and lacking the ability to sort and search your collection. This feature is coming however. - -Django has been implemented to power the frontend experience, and web based database maintenance. The first steps of which are included in this commit. Also the book database has been switched over to reflect this. A properly configured web server is required for hosting the frontend, configuration of which is outside of the scope of this readme. Running via the Django test server might be possible, albeit not recomended. - -## New in 0.2.1 -* UX - * Began implementing search functionality - * Switched to Postgresql as a default to enable better search functionality within Django, and speed up response time on queries. - -## New in 0.2.0 -* UI - * The UI has moved closer to what I have envisioned for this project, however more features and changes will be coming as needed to both the form and function. -* UX - * Results have now been limited to 20 per page. Currently this is hardcoded in however in the future it will be user definable. - * Previous page & next page buttons have been implemented, and are working. +## Misc +Django has been implemented to power the frontend experience, and web based database maintenance. A properly configured web server is required for hosting the frontend, and a PostgreSQL server for the database, configuration of these servers is outside of the scope of this readme. +Running via the Django test server might be possible, albeit not recomended. ## In Progress -* UI/UX tweaks, including making the book display responsive. and not so ugly. * Searching, & further organizational tools. +* Docker image for those who need it. * Improved cover image storage, and acquisition. ## Future Goals diff --git a/config.json b/config.json index 736fc7c..77f2b02 100644 --- a/config.json +++ b/config.json @@ -1,7 +1,9 @@ { "TITLE": "pyShelf E-Book Server", - "VERSION": "0.2.1", + "VERSION": "0.3.0", "BOOKPATH": "books/", + "DB_HOST": "localhost", + "DB_PORT": "5432", "DATABASE": "pyshelf", "USER": "pyshelf", "PASSWORD": "pyshelf", diff --git a/docs/html/HTML/GTAGSROOT b/docs/html/HTML/GTAGSROOT index 793be1c..c725022 100644 --- a/docs/html/HTML/GTAGSROOT +++ b/docs/html/HTML/GTAGSROOT @@ -1 +1 @@ -/home/raelon/Projects/pyShelf/src +/home/raelon/Projects/pyShelf/src/backend diff --git a/docs/html/HTML/index.html b/docs/html/HTML/index.html index afb2c44..c610c6b 100644 --- a/docs/html/HTML/index.html +++ b/docs/html/HTML/index.html @@ -1,16 +1,16 @@ -pyShelf Open Source Ebook Server-0.2.1 +pyShelf Open Source Ebook Server-0.3.0 -

pyShelf Open Source Ebook Server-0.2.1

+

pyShelf Open Source Ebook Server-0.3.0

-Last updated Sun Dec 01 13:06:42 EST 2019
+Last updated Sun Dec 15 12:54:07 EST 2019
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/mains.html b/docs/html/HTML/mains.html index afb2c44..c610c6b 100644 --- a/docs/html/HTML/mains.html +++ b/docs/html/HTML/mains.html @@ -1,16 +1,16 @@ -pyShelf Open Source Ebook Server-0.2.1 +pyShelf Open Source Ebook Server-0.3.0 -

pyShelf Open Source Ebook Server-0.2.1

+

pyShelf Open Source Ebook Server-0.3.0

-Last updated Sun Dec 01 13:06:42 EST 2019
+Last updated Sun Dec 15 12:54:07 EST 2019
Powered by GLOBAL-6.6.3.
diff --git a/docs/html/HTML/rebuild.sh b/docs/html/HTML/rebuild.sh index d26cc13..a0ce080 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 && GTAGSCONF=':langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:skip=HTML/,HTML.pub/,tags,TAGS,ID,y.tab.c,y.tab.h,gtags.files,cscope.files,cscope.out,cscope.po.out,cscope.in.out,SCCS/,RCS/,CVS/,CVSROOT/,{arch}/,autom4te.cache/,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*_flymake.*,*_flymake,*.o,*.a,*.so,*.lo,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz,*.min.js,*min.css:' htags -g -s -a -n -v -w -t 'pyShelf Open Source Ebook Server-0.2.1' /home/raelon/Projects/pyShelf/docs/html +cd /home/raelon/Projects/pyShelf/src/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 diff --git a/docs/html/annotated.html b/docs/html/annotated.html index fbde317..0cf1c06 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -51,39 +51,29 @@ $(function() {  ▼Nbackend  ▼Nlib  ▼Napi_hooks - CDuckDuckGo + CDuckDuckGo  ▼Nconfig - CConfig + CConfig  ▼Nlibrary - CCatalogue + CCatalogue  ▼NpyShelf - CBookDisplay - CInitFiles + CBookDisplay + CInitFiles  ▼Nstorage - CStorage + CStorage  ▼Ntests  ▼Nconfig_test - CTestConfig + CTestConfig  ▼Nlibrary_test - CTest_Catalogue - CTest_Config - CTestCatalogue - ▼Nfrontend - ▼Ninterface - ▼Napps - CInterfaceConfig - ▼Nmigrations - ▼N0001_initial - CMigration - ▼Nmodels - ▼CBooks - CMeta + CTest_Catalogue + CTest_Config + CTestCatalogue
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classes.html b/docs/html/classes.html index 1faa582..98d2ccf 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -44,51 +44,44 @@ $(function() {
Class Index
-
b | c | d | i | m | s | t
+
b | c | d | i | s | t
- - + + + + + + + + + + + + + - - - - + + - - - - - - - - - - - - - - - + - - - +
  b  
Config (pyShelf.src.backend.lib.config)   InterfaceConfig (pyShelf.src.interface.apps)   Config (pyShelf.src.backend.lib.config)   
  s  
+		Test_Config (pyShelf.src.backend.tests.library_test)   
  d  
+		TestCatalogue (pyShelf.src.backend.tests.library_test)   
BookDisplay (pyShelf.src.backend.lib.pyShelf)   Storage (pyShelf.src.backend.lib.storage)   TestConfig (pyShelf.src.backend.tests.config_test)   
  c  
+		DuckDuckGo (pyShelf.src.backend.lib.api_hooks)   
  t  
  d  
-
  m  
+
  i  
BookDisplay (pyShelf.src.backend.lib.pyShelf)   Test_Catalogue (pyShelf.src.backend.tests.library_test)   
Catalogue (pyShelf.src.backend.lib.library)   Test_Catalogue (pyShelf.src.backend.tests.library_test)   
Books (pyShelf.src.interface.models)   DuckDuckGo (pyShelf.src.backend.lib.api_hooks)   Books.Meta (pyShelf.src.interface.models)   Test_Config (pyShelf.src.backend.tests.library_test)   
  c  
-
  i  
-		Migration (pyShelf.src.interface.migrations.0001_initial)   TestCatalogue (pyShelf.src.backend.tests.library_test)   
  s  
-		TestConfig (pyShelf.src.backend.tests.config_test)   
Catalogue (pyShelf.src.backend.lib.library)   InitFiles (pyShelf.src.backend.lib.pyShelf)   
InitFiles (pyShelf.src.backend.lib.pyShelf)   
Storage (pyShelf.src.backend.lib.storage)   
-
b | c | d | i | m | s | t
+
b | c | d | i | s | t
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html deleted file mode 100644 index d8b0efd..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Member List
-
-
- -

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

- - - - -
__init__(self) (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
image_result(self, query)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
url (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
- -
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html deleted file mode 100644 index ad759df..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.lib.config.Config Member List
-
-
- -

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

- - - - - - - - - - - - - -
__init__(self, root) (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, _cp)pyShelf.src.backend.lib.config.Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
- -
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html deleted file mode 100644 index 1a26e88..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.lib.library.Catalogue Member List
-
-
- -

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

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

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

- - - - - - - - - - - -
__init__(self, **kwargs)pyShelf.src.backend.lib.pyShelf.BookDisplay
books_per_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
booksPerPage(self, screen_size)pyShelf.src.backend.lib.pyShelf.BookDisplay
current_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
nextPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
previousPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
screen_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_scale (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
total_pages (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
- -
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html deleted file mode 100644 index 784ff73..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.lib.storage.Storage Member List
-
-
- -

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

- - - - - - - - - - - - - -
__init__(self, db_pointer, config) (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
book_paths_list(self)pyShelf.src.backend.lib.storage.Storage
close(self)pyShelf.src.backend.lib.storage.Storage
commit(self)pyShelf.src.backend.lib.storage.Storage
create_tables(self)pyShelf.src.backend.lib.storage.Storage
cursor (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
database(self)pyShelf.src.backend.lib.storage.Storage
db (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
insert_book(self, book)pyShelf.src.backend.lib.storage.Storage
password (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
sql (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
user (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
- -
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html deleted file mode 100644 index fcd6810..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.tests.config_test.TestConfig Member List
-
-
- -

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

- - - - - -
config (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfigstatic
test_book_dir(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_title(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_version(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
- -
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html deleted file mode 100644 index cd11f3d..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.tests.library_test.TestCatalogue Member List
-
-
- -

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

- - - - -
config (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
root (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
test_filter_books(self) (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCatalogue
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html b/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html deleted file mode 100644 index e1a0870..0000000 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.tests.library_test.Test_Catalogue Member List
-
-
- -

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

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

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

- - - - - - - - - - - - - - -
__init__(self) (defined in pyShelf.src.backend.tests.library_test.Test_Config)pyShelf.src.backend.tests.library_test.Test_Config
__init__(self, root) (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, root="config.json")pyShelf.src.backend.tests.library_test.Test_Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html deleted file mode 100644 index 5431719..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.interface.apps.InterfaceConfig Member List
-
-
- -

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

- - -
name (defined in pyShelf.src.interface.apps.InterfaceConfig)pyShelf.src.interface.apps.InterfaceConfigstatic
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html deleted file mode 100644 index 1f02588..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.interface.apps.InterfaceConfig Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Static Public Attributes | -List of all members
-
-
pyShelf.src.interface.apps.InterfaceConfig Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.interface.apps.InterfaceConfig:
-
-
- - - - - -

-Static Public Attributes

-string name = "interface"
 
-

Detailed Description

-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.png b/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.png deleted file mode 100644 index 23b9a2f..0000000 Binary files a/docs/html/classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.png and /dev/null differ diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration-members.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration-members.html deleted file mode 100644 index c3f238f..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration-members.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.interface.migrations.0001_initial.Migration Member List
-
-
- -

This is the complete list of members for pyShelf.src.interface.migrations.0001_initial.Migration, including all inherited members.

- - - - -
dependencies (defined in pyShelf.src.interface.migrations.0001_initial.Migration)pyShelf.src.interface.migrations.0001_initial.Migrationstatic
initial (defined in pyShelf.src.interface.migrations.0001_initial.Migration)pyShelf.src.interface.migrations.0001_initial.Migrationstatic
operations (defined in pyShelf.src.interface.migrations.0001_initial.Migration)pyShelf.src.interface.migrations.0001_initial.Migrationstatic
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html deleted file mode 100644 index 77fab88..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.interface.migrations.0001_initial.Migration Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Static Public Attributes | -List of all members
-
-
pyShelf.src.interface.migrations.0001_initial.Migration Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.interface.migrations.0001_initial.Migration:
-
-
- - - - - - - - - -

-Static Public Attributes

-bool initial = True
 
-list dependencies = []
 
list operations
 
-

Detailed Description

-

Member Data Documentation

- -

◆ operations

- -
-
- - - - - -
- - - - -
list pyShelf.src.interface.migrations.0001_initial.Migration.operations
- 		-static
-
-Initial value:
= [
-
migrations.CreateModel(
-
name="Books",
-
fields=[
-
(
-
"id",
-
models.AutoField(
-
auto_created=True,
-
primary_key=True,
-
serialize=False,
-
verbose_name="ID",
-
),
-
),
-
("title", models.CharField(max_length=255)),
-
("author", models.CharField(max_length=255, null=True)),
-
("categories", models.CharField(max_length=255, null=True)),
-
("cover", models.BinaryField(editable=True, null=True)),
-
("pages", models.IntegerField(null=True)),
-
("progress", models.IntegerField(null=True)),
-
("file_name", models.CharField(max_length=255)),
-
],
-
options={"db_table": "books",},
-
),
-
]
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.png b/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.png deleted file mode 100644 index abff510..0000000 Binary files a/docs/html/classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.png and /dev/null differ diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books-members.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books-members.html deleted file mode 100644 index 68ce195..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books-members.html +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.interface.models.Books Member List
-
-
- -

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

- - - - - - - - - - -
__str__(self) (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Books
author (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
categories (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
cover (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
file_name (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
get_absolute_url(self)pyShelf.src.interface.models.Books
pages (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
progress (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
title (defined in pyShelf.src.interface.models.Books)pyShelf.src.interface.models.Booksstatic
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html deleted file mode 100644 index b441f17..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.interface.models.Books Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Classes | -Public Member Functions | -Static Public Attributes | -List of all members
-
-
pyShelf.src.interface.models.Books Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.interface.models.Books:
-
-
- - - - - -

-Classes

class  Meta
 
- - - - - -

-Public Member Functions

-def __str__ (self)
 
def get_absolute_url (self)
 
- - - - - - - - - - - - - - - -

-Static Public Attributes

- title = models.CharField(max_length=255)
 
- author = models.CharField(max_length=255, null=True)
 
- categories = models.CharField(max_length=255, null=True)
 
- cover = models.BinaryField(null=True, editable=True)
 
- pages = models.IntegerField(null=True)
 
- progress = models.IntegerField(null=True)
 
- file_name = models.CharField(max_length=255, null=False)
 
-

Detailed Description

-
pyShelfs Book Database class
-:param title: Book title
-:param author: Author
-:param categories: Categories <-- Not implemented
-:param cover: Cover image BinaryField
-:param pages: # of pages <-- Not implemented
-:param progress: Reader percentage <-- Not implented
-:param file_name: Path to book
-

Member Function Documentation

- -

◆ get_absolute_url()

- -
-
- - - - - - - - -
def pyShelf.src.interface.models.Books.get_absolute_url ( self)
-
-
Returns the url to access a particular instance of MyModelName.
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.png b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.png deleted file mode 100644 index 4bc3819..0000000 Binary files a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books.png and /dev/null differ diff --git a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta-members.html b/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta-members.html deleted file mode 100644 index 1a14909..0000000 --- a/docs/html/classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta-members.html +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Member List - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.interface.models.Books.Meta Member List
-
-
- -

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

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

-Static Public Attributes

-string db_table = "books"
 
-

Detailed Description

-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html b/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html new file mode 100644 index 0000000..525af54 --- /dev/null +++ b/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html @@ -0,0 +1,76 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.config.Config Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + +
__init__(self, root)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
db_host (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
db_port (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, _cp)pyShelf.src.backend.lib.config.Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html b/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html new file mode 100644 index 0000000..b859d5b --- /dev/null +++ b/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html @@ -0,0 +1,77 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.library_test.Test_Config Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + +
__init__(self) (defined in pyShelf.src.backend.tests.library_test.Test_Config)pyShelf.src.backend.tests.library_test.Test_Config
pyShelf::src::backend::lib::config::Config.__init__(self, root)pyShelf.src.backend.lib.config.Config
auto_scan (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_path (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
book_shelf (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
catalogue_db (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
db_host (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
db_port (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
file_array (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
open_file(self, root="config.json")pyShelf.src.backend.tests.library_test.Test_Config
password (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
root (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
TITLE (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
user (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
VERSION (defined in pyShelf.src.backend.lib.config.Config)pyShelf.src.backend.lib.config.Config
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html b/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html similarity index 76% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html rename to docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html index 4f6a4dd..5dd90d5 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html +++ b/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.storage.Storage Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,25 +29,25 @@
- - + +
Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.lib.storage.Storage Class Reference
@@ -58,17 +58,15 @@ Public Member Functions def __init__ (self, db_pointer, config)   -def database (self) -  -def create_tables (self) +def create_tables (self)   -def insert_book (self, book) +def insert_book (self, book)   -def book_paths_list (self) +def book_paths_list (self)   -def commit (self) +def commit (self)   -def close (self) +def close (self)   + + + + @@ -166,24 +170,6 @@ Public Attributes
Create table structure
- -

◆ database()

- -
-
-

@@ -82,6 +80,12 @@ Public Attributes

 password
 
+ db_host
 
+ db_port
 
 db
 
- - - - - - - -
def pyShelf.src.backend.lib.storage.Storage.database ( self)
-
-
Create database cursor
-
-

◆ insert_book()

@@ -215,13 +201,13 @@ Public Attributes
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html b/docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html similarity index 82% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html rename to docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html index b4356ef..7ad638a 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html +++ b/docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,25 +29,25 @@
- - + +
Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference
@@ -55,13 +55,13 @@ $(function() { - + - + - + - +

Public Member Functions

def __init__ (self, **kwargs)
def __init__ (self, **kwargs)
 
def nextPage (self)
def nextPage (self)
 
def previousPage (self)
def previousPage (self)
 
def booksPerPage (self, screen_size)
def booksPerPage (self, screen_size)
 
@@ -29,18 +29,18 @@ - - + +
@@ -48,20 +48,20 @@ $(function() { Public Member Functions | Static Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.lib.library.Catalogue Class Reference
- + Inheritance diagram for pyShelf.src.backend.lib.library.Catalogue:
+ + Inheritance diagram for pyShelf.src.backend.lib.library.Catalogue:

@@ -193,13 +193,13 @@ Goto previous book page
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html similarity index 82% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html rename to docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html index 96079ef..4327dbb 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html +++ b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.library.Catalogue Class Reference - - - - + + + +
@@ -19,7 +19,7 @@

pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -70,26 +70,26 @@ Public Member Functions - + - + - + - + - + - + - + - +
def __init__ (self, config)
 
def scan_folder (self, _path=None)
def scan_folder (self, _path=None)
 
def filter_books (self)
def filter_books (self)
 
def extract_metadata (self, book)
def extract_metadata (self, book)
 
def extract_content (self, book_zip, book)
def extract_content (self, book_zip, book)
 
def extract_cover_html (self, book_zip, book)
def extract_cover_html (self, book_zip, book)
 
def extract_cover_image (self, book_zip, book)
def extract_cover_image (self, book_zip, book)
 
def compare_shelf_current (self)
def compare_shelf_current (self)
 
def import_books (self, list=None)
def import_books (self, list=None)
 
- +

Static Public Member Functions

def process_book (book)
def process_book (book)
 
@@ -29,18 +29,18 @@ - - + +
@@ -48,20 +48,20 @@ $(function() { Public Member Functions | Static Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference
- + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Catalogue:
+ + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Catalogue:

@@ -303,7 +303,7 @@ Proceeds to call process_book :returns self._book_list_expanded: json string containing all book metadata -

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

+

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

@@ -394,13 +394,13 @@ Iterates over list and inserts new books into database.
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png similarity index 100% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png rename to docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html b/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html similarity index 83% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html rename to docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html index 98368a1..e713b7a 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html +++ b/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference - - - - + + + +
@@ -19,7 +19,7 @@

pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -70,26 +70,26 @@ Public Member Functions - + - + - + - + - + - + - + - +
def __init__ (self)
 
def filter_books (self)
def filter_books (self)
 
def scan_folder (self, _path=None)
def scan_folder (self, _path=None)
 
def extract_metadata (self, book)
def extract_metadata (self, book)
 
def extract_content (self, book_zip, book)
def extract_content (self, book_zip, book)
 
def extract_cover_html (self, book_zip, book)
def extract_cover_html (self, book_zip, book)
 
def extract_cover_image (self, book_zip, book)
def extract_cover_image (self, book_zip, book)
 
def compare_shelf_current (self)
def compare_shelf_current (self)
 
def import_books (self, list=None)
def import_books (self, list=None)
 
- +

Static Public Member Functions

def process_book (book)
def process_book (book)
 
@@ -29,25 +29,25 @@ - - + +
Public Member Functions | Static Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference
@@ -65,18 +65,18 @@ Static Public Attributes   + 

@@ -342,7 +342,7 @@ Proceeds to call process_book :returns self._book_list_expanded: json string containing all book metadata -

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

+

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

@@ -449,13 +449,13 @@ Iterates over list and inserts new books into database.
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png b/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png similarity index 100% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png rename to docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png diff --git a/docs/html/d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html b/docs/html/d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html new file mode 100644 index 0000000..bea88e3 --- /dev/null +++ b/docs/html/d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html @@ -0,0 +1,65 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.library_test.TestCatalogue Member List
+
+
+ +

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

+ + + + +
config (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
root (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCataloguestatic
test_filter_books(self) (defined in pyShelf.src.backend.tests.library_test.TestCatalogue)pyShelf.src.backend.tests.library_test.TestCatalogue
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html b/docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html similarity index 74% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html rename to docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html index 2183d63..19ce362 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html +++ b/docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference - - - - + + + +
@@ -19,7 +19,7 @@

pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
root = os.path.abspath(os.path.curdir)
 
- config = Test_Config()
config = Test_Config()
 

Detailed Description

The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html similarity index 74% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html rename to docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html index d2ce3ae..6520f9b 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html +++ b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.Test_Config Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,38 +29,38 @@
- - + +
Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.tests.library_test.Test_Config Class Reference
- + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Config:
+ + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Config:
@@ -69,7 +69,7 @@ Public Member Functions - +
def __init__ (self)
 
def open_file (self, root="config.json")
def open_file (self, root="config.json")
 
+ + + + @@ -134,18 +140,18 @@ Public Attributes
Opens config.json and reads in configuration options
-

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

+

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

The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png similarity index 100% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png rename to docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png diff --git a/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html b/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html new file mode 100644 index 0000000..d76ee83 --- /dev/null +++ b/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html @@ -0,0 +1,83 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+

@@ -95,6 +95,12 @@ Public Attributes

 password
 
+ db_host
 
+ db_port
 
 file_array
 
+ + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+ + + + + + + + + +
+
+
pyShelf.src.backend.tests.library_test.Test_Catalogue Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + + +
__init__(self) (defined in pyShelf.src.backend.tests.library_test.Test_Catalogue)pyShelf.src.backend.tests.library_test.Test_Catalogue
__init__(self, config) (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_folder (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_shelf (defined in pyShelf.src.backend.tests.library_test.Test_Catalogue)pyShelf.src.backend.tests.library_test.Test_Catalogue
books (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
compare_shelf_current(self)pyShelf.src.backend.lib.library.Catalogue
config (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
cover_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
db_pointer (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_metadata(self, book)pyShelf.src.backend.lib.library.Catalogue
file_list (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
filter_books(self)pyShelf.src.backend.tests.library_test.Test_Catalogue
html_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
import_books(self, list=None)pyShelf.src.backend.lib.library.Catalogue
opf_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
process_book(book)pyShelf.src.backend.lib.library.Cataloguestatic
root_dir (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
scan_folder(self, _path=None)pyShelf.src.backend.lib.library.Catalogue
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html similarity index 66% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html rename to docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html index 89327a0..8cdaf01 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html +++ b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.config.Config Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,47 +29,46 @@
- - + +
Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.lib.config.Config Class Reference
- + Inheritance diagram for pyShelf.src.backend.lib.config.Config:
+ + Inheritance diagram for pyShelf.src.backend.lib.config.Config:
- + - +

Public Member Functions

-def __init__ (self, root)
def __init__ (self, root)
 
def open_file (self, _cp)
def open_file (self, _cp)
 
+ + + + @@ -107,7 +112,37 @@ Public Attributes

@@ -95,6 +94,12 @@ Public Attributes

 password
 
+ db_host
 
+ db_port
 
 file_array
 

Detailed Description

Main System Configuration
-

Member Function Documentation

+

Constructor & Destructor Documentation

+ +

◆ __init__()

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

Member Function Documentation

◆ open_file()

@@ -135,18 +170,18 @@ Public Attributes 
Opens config.json and reads in configuration options
-

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

+

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

The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png similarity index 100% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png rename to docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png diff --git a/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html new file mode 100644 index 0000000..4fda3ab --- /dev/null +++ b/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html @@ -0,0 +1,82 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.library.Catalogue Member List
+
+
+ +

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

+ + + + + + + + + + + + + + + + + + + + + +
__init__(self, config) (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_folder (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
book_shelf (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
books (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
compare_shelf_current(self)pyShelf.src.backend.lib.library.Catalogue
config (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
cover_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
db_pointer (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
extract_content(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_html(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_cover_image(self, book_zip, book)pyShelf.src.backend.lib.library.Catalogue
extract_metadata(self, book)pyShelf.src.backend.lib.library.Catalogue
file_list (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
filter_books(self)pyShelf.src.backend.lib.library.Catalogue
html_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
import_books(self, list=None)pyShelf.src.backend.lib.library.Catalogue
opf_regx (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
process_book(book)pyShelf.src.backend.lib.library.Cataloguestatic
root_dir (defined in pyShelf.src.backend.lib.library.Catalogue)pyShelf.src.backend.lib.library.Catalogue
scan_folder(self, _path=None)pyShelf.src.backend.lib.library.Catalogue
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html similarity index 52% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html rename to docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html index 2c162ed..ce797d3 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html +++ b/docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: Member List - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,18 +29,18 @@
- - + +
@@ -49,15 +49,15 @@ $(function() {
-

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

+

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

- - + +
__init__(self, file_array) (defined in pyShelf.src.backend.lib.pyShelf.InitFiles)pyShelf.src.backend.lib.pyShelf.InitFiles
CreateFile(self, _pointer)pyShelf.src.backend.lib.pyShelf.InitFiles
__init__(self, file_array) (defined in pyShelf.src.backend.lib.pyShelf.InitFiles)pyShelf.src.backend.lib.pyShelf.InitFiles
CreateFile(self, _pointer)pyShelf.src.backend.lib.pyShelf.InitFiles
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html new file mode 100644 index 0000000..8069a15 --- /dev/null +++ b/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html @@ -0,0 +1,75 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.storage.Storage Member List
+
+
+ +

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

+ + + + + + + + + + + + + + +
__init__(self, db_pointer, config) (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
book_paths_list(self)pyShelf.src.backend.lib.storage.Storage
close(self)pyShelf.src.backend.lib.storage.Storage
commit(self)pyShelf.src.backend.lib.storage.Storage
create_tables(self)pyShelf.src.backend.lib.storage.Storage
cursor (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
db (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
db_host (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
db_port (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
insert_book(self, book)pyShelf.src.backend.lib.storage.Storage
password (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
sql (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
user (defined in pyShelf.src.backend.lib.storage.Storage)pyShelf.src.backend.lib.storage.Storage
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html new file mode 100644 index 0000000..943f51c --- /dev/null +++ b/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html @@ -0,0 +1,65 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Member List
+
+
+ +

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

+ + + + +
__init__(self) (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
image_result(self, query)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
url (defined in pyShelf.src.backend.lib.api_hooks.DuckDuckGo)pyShelf.src.backend.lib.api_hooks.DuckDuckGo
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html b/docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html similarity index 78% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html rename to docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html index e48a24f..de26674 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +++ b/docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,25 +29,25 @@
- - + +
Public Member Functions | Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference
@@ -58,7 +58,7 @@ Public Member Functions def __init__ (self)   -def image_result (self, query) +def image_result (self, query)  
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html b/docs/html/dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html similarity index 75% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html rename to docs/html/dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html index d19e4a4..af54bd7 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html +++ b/docs/html/dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
@@ -29,24 +29,24 @@ - - + +
Public Member Functions | -List of all members
+List of all members
pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference
@@ -57,7 +57,7 @@ Public Member Functions - +

@@ -100,13 +100,13 @@ Public Attributes

pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
def __init__ (self, file_array)
 
def CreateFile (self, _pointer)
def CreateFile (self, _pointer)
 

Detailed Description

@@ -92,13 +92,13 @@ def __init__ (self, fi
The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html b/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html new file mode 100644 index 0000000..d0abc73 --- /dev/null +++ b/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html @@ -0,0 +1,66 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.tests.config_test.TestConfig Member List
+
+
+ +

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

+ + + + + +
config (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfigstatic
test_book_dir(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_title(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
test_version(self) (defined in pyShelf.src.backend.tests.config_test.TestConfig)pyShelf.src.backend.tests.config_test.TestConfig
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html new file mode 100644 index 0000000..e448586 --- /dev/null +++ b/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html @@ -0,0 +1,72 @@ + + + + + + + +pyShelf Open Source Ebook Server: Member List + + + + + + +
+
+ + + + + + +
+
pyShelf Open Source Ebook Server +  0.3.0 +
+
Open source, console based E-book server
+
+
+ + + + + + + +
+
+
+
pyShelf.src.backend.lib.pyShelf.BookDisplay Member List
+
+
+ +

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

+ + + + + + + + + + + +
__init__(self, **kwargs)pyShelf.src.backend.lib.pyShelf.BookDisplay
books_per_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
booksPerPage(self, screen_size)pyShelf.src.backend.lib.pyShelf.BookDisplay
current_page (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
nextPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
previousPage(self)pyShelf.src.backend.lib.pyShelf.BookDisplay
screen_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_scale (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
thumbnail_size (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
total_pages (defined in pyShelf.src.backend.lib.pyShelf.BookDisplay)pyShelf.src.backend.lib.pyShelf.BookDisplay
+ +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen + 1.8.16 +
+ + diff --git a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html b/docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html similarity index 76% rename from docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html rename to docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html index e2ae1ba..20f0129 100644 --- a/docs/html/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html +++ b/docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html @@ -6,10 +6,10 @@ pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.config_test.TestConfig Class Reference - - - - + + + +
@@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -29,25 +29,25 @@
- - + +
Public Member Functions | Static Public Attributes | -List of all members
+List of all members
pyShelf.src.backend.tests.config_test.TestConfig Class Reference
@@ -68,18 +68,18 @@ def test_version (self

Static Public Attributes

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

Detailed Description

The documentation for this class was generated from the following file:
-Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   +doxygen 1.8.16
diff --git a/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html b/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html deleted file mode 100644 index eef54c6..0000000 --- a/docs/html/dir_115a8af934cb6b8073d7541c3a02a8e0.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
static Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html index 354d797..e0f30e1 100644 --- a/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html +++ b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -51,7 +51,7 @@ $(function() {
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html b/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html deleted file mode 100644 index 4efd2db..0000000 --- a/docs/html/dir_2e4fe7818a9bea2340465344c5b4f122.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/css/vendor/select2 Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
select2 Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html index 1253850..267c996 100644 --- a/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html +++ b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -55,7 +55,7 @@ Directories
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html b/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html deleted file mode 100644 index 8f0f8d2..0000000 --- a/docs/html/dir_5dc60ce45ea83ccf35a995eb718413e2.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/migrations Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
migrations Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_650ee533936399e683a30afb9473a469.html b/docs/html/dir_650ee533936399e683a30afb9473a469.html deleted file mode 100644 index 9f931b4..0000000 --- a/docs/html/dir_650ee533936399e683a30afb9473a469.html +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
interface Directory Reference
-
-
- - - - -

-Directories

directory  static
 
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index b6aa6dc..aa80e43 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -55,7 +55,7 @@ Directories
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html b/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html deleted file mode 100644 index 9bb8ca1..0000000 --- a/docs/html/dir_80adb54c76bf5d67e934da378f00559d.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/js/vendor Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
vendor Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_8509b06bafa958d2011203a730bf5778.html b/docs/html/dir_8509b06bafa958d2011203a730bf5778.html deleted file mode 100644 index 5c9deec..0000000 --- a/docs/html/dir_8509b06bafa958d2011203a730bf5778.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/frontend Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
frontend Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html b/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html index d5be62c..7973a41 100644 --- a/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html +++ b/docs/html/dir_9020577e2da81c4cf5a5554c26431f94.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -51,7 +51,7 @@ $(function() {
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html b/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html deleted file mode 100644 index be4eff6..0000000 --- a/docs/html/dir_9662e62442d92157d391ef66bee26a3c.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/css/vendor Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
vendor Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html b/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html deleted file mode 100644 index 463cd39..0000000 --- a/docs/html/dir_a05f942952f29ba3ff0b6cf8bcd4f651.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
admin Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html b/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html deleted file mode 100644 index 64c5d5f..0000000 --- a/docs/html/dir_bf61165a5ec6f092245f16c80e25d9dd.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/css Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
css Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html b/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html deleted file mode 100644 index 4546f25..0000000 --- a/docs/html/dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/templatetags Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
templatetags Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html b/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html deleted file mode 100644 index 1c2ff3a..0000000 --- a/docs/html/dir_d57dcc97c471b6c632c5e6143b3e3c97.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/js Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
js Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html b/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html deleted file mode 100644 index 235063e..0000000 --- a/docs/html/dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: src/interface/static/admin/js/vendor/select2 Directory Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.2.1 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
select2 Directory Reference
-
-
-
- -
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/files.html b/docs/html/files.html index c03a879..44fb9b7 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -61,32 +61,12 @@ $(function() {  library_test.py  __init__.py  pyShelf_ScanLibrary.py - ▼ frontend - __init__.py - settings.py - urls.py - wsgi.py - ▼ interface - ▼ migrations - 0001_initial.py - __init__.py - ▼ templatetags - __init__.py - filters.py - __init__.py - admin.py - apps.py - models.py - tests.py - views.py - __init__.py - manage.py
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/functions.html b/docs/html/functions.html index 9763481..d7ac943 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -42,81 +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 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 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 6f4093c..c71a6b5 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -42,81 +42,76 @@ $(function() {
 
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 22ceaaf..bacea1f 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
Open source, console based E-book server
@@ -46,29 +46,22 @@ $(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.interface.models.Books.Meta
 ▼CMigration
 CpyShelf.src.interface.migrations.0001_initial.Migration
 ▼CModel
 CpyShelf.src.interface.models.Books
 CpyShelf.src.backend.lib.storage.Storage
 CpyShelf.src.backend.tests.library_test.TestCatalogue
 CpyShelf.src.backend.tests.config_test.TestConfig
 ▼CAppConfig
 CpyShelf.src.interface.apps.InterfaceConfig
 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
-Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
diff --git a/docs/html/index.hhc b/docs/html/index.hhc index d22c651..d1f6a98 100644 --- a/docs/html/index.hhc +++ b/docs/html/index.hhc @@ -4,27 +4,6 @@
  • -
  • - -
  • - -
  • -
  • diff --git a/docs/html/index.hhk b/docs/html/index.hhk index deab4cf..ef7d9f0 100644 --- a/docs/html/index.hhk +++ b/docs/html/index.hhk @@ -4,771 +4,642 @@ diff --git a/docs/html/index.hhp b/docs/html/index.hhp index 8a633b8..658ebb0 100644 --- a/docs/html/index.hhp +++ b/docs/html/index.hhp @@ -14,59 +14,31 @@ Title=pyShelf Open Source Ebook Server main="pyShelf Open Source Ebook Server","index.hhc","index.hhk","index.html","index.html",,,,,0x23520,,0x70387e,,,,,,,,0 [FILES] -md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html -md_src_interface_static_admin_js_vendor_select2_LICENSE.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html -classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html -namespacepyShelf_1_1src_1_1frontend_1_1settings.html -namespacepyShelf_1_1src_1_1frontend_1_1urls.html -namespacepyShelf_1_1src_1_1frontend_1_1wsgi.html -classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.html -classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig-members.html -classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.html -classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration-members.html -classpyShelf_1_1src_1_1interface_1_1models_1_1Books.html -classpyShelf_1_1src_1_1interface_1_1models_1_1Books-members.html -classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta.html -classpyShelf_1_1src_1_1interface_1_1models_1_1Books_1_1Meta-members.html -namespacepyShelf_1_1src_1_1manage.html -dir_a05f942952f29ba3ff0b6cf8bcd4f651.html +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 dir_3f615ade772d23cefe5e20dcb18424a2.html -dir_bf61165a5ec6f092245f16c80e25d9dd.html -dir_8509b06bafa958d2011203a730bf5778.html -dir_650ee533936399e683a30afb9473a469.html -dir_d57dcc97c471b6c632c5e6143b3e3c97.html dir_1c7294442ce83d360610449d04c9d7fc.html -dir_5dc60ce45ea83ccf35a995eb718413e2.html -dir_e5dd47fdf1c13a2660cfdd48f6dbd07c.html -dir_2e4fe7818a9bea2340465344c5b4f122.html dir_68267d1309a1af8e8297ef4c3efbcdba.html -dir_115a8af934cb6b8073d7541c3a02a8e0.html -dir_c9cb39ed8b98bd7419bc6fb3338b22e5.html dir_9020577e2da81c4cf5a5554c26431f94.html -dir_80adb54c76bf5d67e934da378f00559d.html -dir_9662e62442d92157d391ef66bee26a3c.html index.html -pages.html -namespaces.html annotated.html classes.html hierarchy.html @@ -86,10 +58,7 @@ open.png bdwn.png sync_on.png sync_off.png -classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png -classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png -classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png -classpyShelf_1_1src_1_1interface_1_1apps_1_1InterfaceConfig.png -classpyShelf_1_1src_1_1interface_1_1migrations_1_10001__initial_1_1Migration.png -classpyShelf_1_1src_1_1interface_1_1models_1_1Books.png +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 diff --git a/docs/html/index.html b/docs/html/index.html index c13eacb..a272a65 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -19,7 +19,7 @@
    pyShelf Open Source Ebook Server -  0.2.1 +  0.3.0
    Open source, console based E-book server
    @@ -47,7 +47,7 @@ $(function() {
    -Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   +Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   doxygen 1.8.16
    diff --git a/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html b/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html deleted file mode 100644 index 8043f24..0000000 --- a/docs/html/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: LICENSE-SELECT2 - - - - - - -
    -
    - - - - - - -
    -
    pyShelf Open Source Ebook Server -  0.2.1 -
    -
    Open source, console based E-book server
    -
    -
    - - - - - - -
    -
    -
    -
    LICENSE-SELECT2
    -
    -
    -

    The MIT License (MIT)

    -

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

    -

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

    -

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

    -

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

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

    The MIT License (MIT)

    -

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

    -

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

    -

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

    -

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

    -
    -
    - -
    -Generated on Sun Dec 1 2019 13:06:42 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
    - - diff --git a/docs/html/menudata.js b/docs/html/menudata.js index b31f3d6..25e7273 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -22,9 +22,6 @@ for the JavaScript code in this file */ var menudata={children:[ {text:"Main Page",url:"index.html"}, -{text:"Related Pages",url:"pages.html"}, -{text:"Namespaces",url:"namespaces.html",children:[ -{text:"Namespace List",url:"namespaces.html"}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, diff --git a/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html b/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html deleted file mode 100644 index 5ee7ea9..0000000 --- a/docs/html/namespacepyShelf_1_1src_1_1frontend_1_1settings.html +++ /dev/null @@ -1,269 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.frontend.settings Namespace Reference - - - - - - -
    -
    - - - - - - -
    -
    pyShelf Open Source Ebook Server -  0.2.1 -
    -
    Open source, console based E-book server
    -
    -
    - - - - - - - -
    -
    -
    -Variables
    -
    -
    pyShelf.src.frontend.settings Namespace Reference
    -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    -Variables

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

    Detailed Description

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

    Variable Documentation

    - -

    ◆ AUTH_PASSWORD_VALIDATORS

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

    ◆ DATABASES

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

    ◆ INSTALLED_APPS

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

    ◆ INTERNAL_IPS

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

    ◆ MIDDLEWARE

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

    ◆ TEMPLATES

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

    -Variables

    list urlpatterns
     
    -

    Detailed Description

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

    Variable Documentation

    - -

    ◆ urlpatterns

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

    -Variables

    - application = get_wsgi_application()
     
    -

    Detailed Description

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

    -Functions

    -def main ()
     
    -

    Detailed Description

    -
    Django's command-line utility for administrative tasks.
    - -
    -Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
    - - diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html deleted file mode 100644 index cb0c497..0000000 --- a/docs/html/namespaces.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Namespace List - - - - - - -
    -
    - - - - - - -
    -
    pyShelf Open Source Ebook Server -  0.2.1 -
    -
    Open source, console based E-book server
    -
    -
    - - - - - - -
    -
    -
    -
    Namespace List
    -
    -
    -
    Here is a list of all documented namespaces with brief descriptions:
    -
    [detail level 1234]
    - - - - - - - -
     ▼NpyShelf
     ▼Nsrc
     ▼Nfrontend
     Nsettings
     Nurls
     Nwsgi
     Nmanage
    -
    -
    - -
    -Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
    - - diff --git a/docs/html/pages.html b/docs/html/pages.html deleted file mode 100644 index 2c58a7e..0000000 --- a/docs/html/pages.html +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: Related Pages - - - - - - -
    -
    - - - - - - -
    -
    pyShelf Open Source Ebook Server -  0.2.1 -
    -
    Open source, console based E-book server
    -
    -
    - - - - - - -
    -
    -
    -
    Related Pages
    -
    -
    -
    Here is a list of all related documentation pages:
    - - - -
     LICENSE-SELECT2
     LICENSE
    -
    -
    - -
    -Generated on Sun Dec 1 2019 13:06:43 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
    - - diff --git a/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 b/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 deleted file mode 100644 index 5fa6f37..0000000 --- a/docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 +++ /dev/null @@ -1,14 +0,0 @@ -.TH "md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2 \- LICENSE-SELECT2 -The MIT License (MIT) -.PP -Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors -.PP -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -.PP -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. -.PP -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. diff --git a/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 b/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 deleted file mode 100644 index 5e4baa6..0000000 --- a/docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 +++ /dev/null @@ -1,14 +0,0 @@ -.TH "md_src_interface_static_admin_js_vendor_select2_LICENSE" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -md_src_interface_static_admin_js_vendor_select2_LICENSE \- LICENSE -The MIT License (MIT) -.PP -Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors -.PP -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -.PP -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&. -.PP -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&. diff --git a/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 b/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 index e7085fa..cea0505 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 b/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 index e3ceb16..e67eb34 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_config_Config.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.config.Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.config.Config" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME @@ -43,6 +43,12 @@ Inherited by \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\fP\ .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 @@ -62,6 +68,17 @@ Main System Configuration .fi .PP +.SH "Constructor & Destructor Documentation" +.PP +.SS "def pyShelf\&.src\&.backend\&.lib\&.config\&.Config\&.__init__ ( self, root)" + +.PP +.nf +Initialize main configuration options + +.fi +.PP + .SH "Member Function Documentation" .PP .SS "def pyShelf\&.src\&.backend\&.lib\&.config\&.Config\&.open_file ( self, _cp)" diff --git a/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 b/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 index 33004a8..98da085 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.library.Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.library.Catalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 index 834a5ec..3d2bb2d 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.pyShelf.BookDisplay" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.pyShelf.BookDisplay" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 index c30dce2..f48ff01 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.pyShelf.InitFiles" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.pyShelf.InitFiles" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 b/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 index 151f164..7e5c38d 100644 --- a/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 +++ b/docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.lib.storage.Storage" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.lib.storage.Storage" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME @@ -13,9 +13,6 @@ pyShelf.src.backend.lib.storage.Storage .RI "def \fB__init__\fP (self, db_pointer, config)" .br .ti -1c -.RI "def \fBdatabase\fP (self)" -.br -.ti -1c .RI "def \fBcreate_tables\fP (self)" .br .ti -1c @@ -44,6 +41,12 @@ pyShelf.src.backend.lib.storage.Storage .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 @@ -96,14 +99,6 @@ Create table structure .fi .PP -.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.database ( self)" - -.PP -.nf -Create database cursor -.fi -.PP - .SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.insert_book ( self, book)" .PP diff --git a/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 b/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 index 8c1db57..bd649bf 100644 --- a/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 +++ b/docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.tests.config_test.TestConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.tests.config_test.TestConfig" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 index 456aa9e..5e05cad 100644 --- a/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.tests.library_test.TestCatalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.tests.library_test.TestCatalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 index ea2ff4f..533d1d7 100644 --- a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.tests.library_test.Test_Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.tests.library_test.Test_Catalogue" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 index 6e68e00..5fbfcff 100644 --- a/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 +++ b/docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 @@ -1,4 +1,4 @@ -.TH "pyShelf.src.backend.tests.library_test.Test_Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- +.TH "pyShelf.src.backend.tests.library_test.Test_Config" 3 "Sun Dec 15 2019" "Version 0.3.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*- .ad l .nh .SH NAME @@ -43,6 +43,12 @@ Inherits \fBpyShelf\&.src\&.backend\&.lib\&.config\&.Config\fP\&. .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 diff --git a/docs/man/man3/pyShelf_src_frontend_settings.3 b/docs/man/man3/pyShelf_src_frontend_settings.3 deleted file mode 100644 index 71c8190..0000000 --- a/docs/man/man3/pyShelf_src_frontend_settings.3 +++ /dev/null @@ -1,180 +0,0 @@ -.TH "pyShelf.src.frontend.settings" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.frontend.settings -.SH SYNOPSIS -.br -.PP -.SS "Variables" - -.in +1c -.ti -1c -.RI "\fBBASE_DIR\fP = os\&.path\&.dirname(os\&.path\&.dirname(os\&.path\&.abspath(__file__)))" -.br -.ti -1c -.RI "string \fBSECRET_KEY\fP = '@(9b9jslgg41u1u=mr)\-2*\-n2x0vef0zsy39*z@sz18&tvow18'" -.br -.ti -1c -.RI "bool \fBDEBUG\fP = False" -.br -.ti -1c -.RI "list \fBALLOWED_HOSTS\fP = ['*']" -.br -.ti -1c -.RI "list \fBINSTALLED_APPS\fP" -.br -.ti -1c -.RI "list \fBMIDDLEWARE\fP" -.br -.ti -1c -.RI "list \fBINTERNAL_IPS\fP" -.br -.ti -1c -.RI "string \fBROOT_URLCONF\fP = 'frontend\&.urls'" -.br -.ti -1c -.RI "list \fBTEMPLATES\fP" -.br -.ti -1c -.RI "string \fBWSGI_APPLICATION\fP = 'frontend\&.wsgi\&.application'" -.br -.ti -1c -.RI "dictionary \fBDATABASES\fP" -.br -.ti -1c -.RI "list \fBAUTH_PASSWORD_VALIDATORS\fP" -.br -.ti -1c -.RI "string \fBLANGUAGE_CODE\fP = 'en\-us'" -.br -.ti -1c -.RI "string \fBTIME_ZONE\fP = 'UTC'" -.br -.ti -1c -.RI "bool \fBUSE_I18N\fP = True" -.br -.ti -1c -.RI "bool \fBUSE_L10N\fP = True" -.br -.ti -1c -.RI "bool \fBUSE_TZ\fP = True" -.br -.ti -1c -.RI "string \fBSTATIC_URL\fP = '/static/'" -.br -.ti -1c -.RI "\fBSTATIC_ROOT\fP = os\&.path\&.join(BASE_DIR, 'interface/static/')" -.br -.in -1c -.SH "Detailed Description" -.PP - -.PP -.nf -Django settings for frontend project. - -Generated by 'django-admin startproject' using Django 2.2.7. - -For more information on this file, see -https://docs.djangoproject.com/en/2.2/topics/settings/ - -For the full list of settings and their values, see -https://docs.djangoproject.com/en/2.2/ref/settings/ - -.fi -.PP - -.SH "Variable Documentation" -.PP -.SS "list pyShelf\&.src\&.frontend\&.settings\&.AUTH_PASSWORD_VALIDATORS" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 { -3 "NAME": "django\&.contrib\&.auth\&.password_validation\&.UserAttributeSimilarityValidator", -4 }, -5 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.MinimumLengthValidator",}, -6 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.CommonPasswordValidator",}, -7 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.NumericPasswordValidator",}, -8 ] -.fi -.SS "dictionary pyShelf\&.src\&.frontend\&.settings\&.DATABASES" -\fBInitial value:\fP -.PP -.nf -1 = { -2 "default": { -3 "ENGINE": "django\&.db\&.backends\&.postgresql", -4 # "ENGINE": "django\&.db\&.backends\&.sqlite3", -5 "NAME": "pyshelf", -6 "PASSWORD": "", -7 # "NAME": os\&.path\&.join(BASE_DIR, "db\&.sqlite3"), -8 } -9 } -.fi -.SS "list pyShelf\&.src\&.frontend\&.settings\&.INSTALLED_APPS" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 "django\&.contrib\&.admin", -3 "django\&.contrib\&.auth", -4 "django\&.contrib\&.contenttypes", -5 "django\&.contrib\&.sessions", -6 "django\&.contrib\&.messages", -7 "django\&.contrib\&.staticfiles", -8 "interface", -9 "interface\&.templatetags", -10 "debug_toolbar", -11 ] -.fi -.SS "list pyShelf\&.src\&.frontend\&.settings\&.INTERNAL_IPS" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 # \&.\&.\&. -3 "127\&.0\&.0\&.1", -4 # \&.\&.\&. -5 ] -.fi -.SS "list pyShelf\&.src\&.frontend\&.settings\&.MIDDLEWARE" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 "django\&.middleware\&.security\&.SecurityMiddleware", -3 "django\&.contrib\&.sessions\&.middleware\&.SessionMiddleware", -4 "django\&.middleware\&.common\&.CommonMiddleware", -5 "django\&.middleware\&.csrf\&.CsrfViewMiddleware", -6 "debug_toolbar\&.middleware\&.DebugToolbarMiddleware", -7 "django\&.contrib\&.auth\&.middleware\&.AuthenticationMiddleware", -8 "django\&.contrib\&.messages\&.middleware\&.MessageMiddleware", -9 "django\&.middleware\&.clickjacking\&.XFrameOptionsMiddleware", -10 ] -.fi -.SS "list pyShelf\&.src\&.frontend\&.settings\&.TEMPLATES" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 { -3 "BACKEND": "django\&.template\&.backends\&.django\&.DjangoTemplates", -4 "DIRS": [], -5 "APP_DIRS": True, -6 "OPTIONS": { -7 "context_processors": [ -8 "django\&.template\&.context_processors\&.debug", -9 "django\&.template\&.context_processors\&.request", -10 "django\&.contrib\&.auth\&.context_processors\&.auth", -11 "django\&.contrib\&.messages\&.context_processors\&.messages", -12 ], -13 }, -14 }, -15 ] -.fi -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_frontend_urls.3 b/docs/man/man3/pyShelf_src_frontend_urls.3 deleted file mode 100644 index c3d36df..0000000 --- a/docs/man/man3/pyShelf_src_frontend_urls.3 +++ /dev/null @@ -1,55 +0,0 @@ -.TH "pyShelf.src.frontend.urls" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.frontend.urls -.SH SYNOPSIS -.br -.PP -.SS "Variables" - -.in +1c -.ti -1c -.RI "list \fBurlpatterns\fP" -.br -.in -1c -.SH "Detailed Description" -.PP - -.PP -.nf -frontend URL Configuration - -The `urlpatterns` list routes URLs to views. For more information please see: - https://docs.djangoproject.com/en/2.2/topics/http/urls/ -Examples: -Function views - 1. Add an import: from my_app import views - 2. Add a URL to urlpatterns: path('', views.home, name='home') -Class-based views - 1. Add an import: from other_app.views import Home - 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') -Including another URLconf - 1. Import the include() function: from django.urls import include, path - 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) - -.fi -.PP - -.SH "Variable Documentation" -.PP -.SS "list pyShelf\&.src\&.frontend\&.urls\&.urlpatterns" -\fBInitial value:\fP -.PP -.nf -1 = [ -2 path("admin/", admin\&.site\&.urls), -3 path("", views\&.index, name="index"), -4 path("download/", views\&.download, name="download"), -5 path("prev_page/", views\&.prev_page, name="prev_page"), -6 path("next_page/", views\&.next_page, name="next_page"), -7 ] -.fi -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_frontend_wsgi.3 b/docs/man/man3/pyShelf_src_frontend_wsgi.3 deleted file mode 100644 index bc5c880..0000000 --- a/docs/man/man3/pyShelf_src_frontend_wsgi.3 +++ /dev/null @@ -1,33 +0,0 @@ -.TH "pyShelf.src.frontend.wsgi" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.frontend.wsgi -.SH SYNOPSIS -.br -.PP -.SS "Variables" - -.in +1c -.ti -1c -.RI "\fBapplication\fP = get_wsgi_application()" -.br -.in -1c -.SH "Detailed Description" -.PP - -.PP -.nf -WSGI config for frontend project. - -It exposes the WSGI callable as a module-level variable named ``application``. - -For more information on this file, see -https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/ - -.fi -.PP - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 b/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 deleted file mode 100644 index 8f30494..0000000 --- a/docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 +++ /dev/null @@ -1,24 +0,0 @@ -.TH "pyShelf.src.interface.apps.InterfaceConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.interface.apps.InterfaceConfig -.SH SYNOPSIS -.br -.PP -.PP -Inherits AppConfig\&. -.SS "Static Public Attributes" - -.in +1c -.ti -1c -.RI "string \fBname\fP = 'interface'" -.br -.in -1c -.SH "Detailed Description" -.PP - - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 b/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 deleted file mode 100644 index 6812b9b..0000000 --- a/docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 +++ /dev/null @@ -1,61 +0,0 @@ -.TH "pyShelf.src.interface.migrations.0001_initial.Migration" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.interface.migrations.0001_initial.Migration -.SH SYNOPSIS -.br -.PP -.PP -Inherits Migration\&. -.SS "Static Public Attributes" - -.in +1c -.ti -1c -.RI "bool \fBinitial\fP = True" -.br -.ti -1c -.RI "list \fBdependencies\fP = []" -.br -.ti -1c -.RI "list \fBoperations\fP" -.br -.in -1c -.SH "Detailed Description" -.PP -.SH "Member Data Documentation" -.PP -.SS "list pyShelf\&.src\&.interface\&.migrations\&.0001_initial\&.Migration\&.operations\fC [static]\fP" -\fBInitial value:\fP -.PP -.nf -= [ - migrations\&.CreateModel( - name="Books", - fields=[ - ( - "id", - models\&.AutoField( - auto_created=True, - primary_key=True, - serialize=False, - verbose_name="ID", - ), - ), - ("title", models\&.CharField(max_length=255)), - ("author", models\&.CharField(max_length=255, null=True)), - ("categories", models\&.CharField(max_length=255, null=True)), - ("cover", models\&.BinaryField(editable=True, null=True)), - ("pages", models\&.IntegerField(null=True)), - ("progress", models\&.IntegerField(null=True)), - ("file_name", models\&.CharField(max_length=255)), - ], - options={"db_table": "books",}, - ), - ] -.fi - - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_models_Books.3 b/docs/man/man3/pyShelf_src_interface_models_Books.3 deleted file mode 100644 index 1c3aeea..0000000 --- a/docs/man/man3/pyShelf_src_interface_models_Books.3 +++ /dev/null @@ -1,83 +0,0 @@ -.TH "pyShelf.src.interface.models.Books" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.interface.models.Books -.SH SYNOPSIS -.br -.PP -.PP -Inherits Model\&. -.SS "Classes" - -.in +1c -.ti -1c -.RI "class \fBMeta\fP" -.br -.in -1c -.SS "Public Member Functions" - -.in +1c -.ti -1c -.RI "def \fB__str__\fP (self)" -.br -.ti -1c -.RI "def \fBget_absolute_url\fP (self)" -.br -.in -1c -.SS "Static Public Attributes" - -.in +1c -.ti -1c -.RI "\fBtitle\fP = models\&.CharField(max_length=255)" -.br -.ti -1c -.RI "\fBauthor\fP = models\&.CharField(max_length=255, null=True)" -.br -.ti -1c -.RI "\fBcategories\fP = models\&.CharField(max_length=255, null=True)" -.br -.ti -1c -.RI "\fBcover\fP = models\&.BinaryField(null=True, editable=True)" -.br -.ti -1c -.RI "\fBpages\fP = models\&.IntegerField(null=True)" -.br -.ti -1c -.RI "\fBprogress\fP = models\&.IntegerField(null=True)" -.br -.ti -1c -.RI "\fBfile_name\fP = models\&.CharField(max_length=255, null=False)" -.br -.in -1c -.SH "Detailed Description" -.PP - -.PP -.nf -pyShelfs Book Database class -:param title: Book title -:param author: Author -:param categories: Categories <-- Not implemented -:param cover: Cover image BinaryField -:param pages: # of pages <-- Not implemented -:param progress: Reader percentage <-- Not implented -:param file_name: Path to book - -.fi -.PP - -.SH "Member Function Documentation" -.PP -.SS "def pyShelf\&.src\&.interface\&.models\&.Books\&.get_absolute_url ( self)" - -.PP -.nf -Returns the url to access a particular instance of MyModelName. -.fi -.PP - - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 b/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 deleted file mode 100644 index 5ea7e8b..0000000 --- a/docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 +++ /dev/null @@ -1,22 +0,0 @@ -.TH "pyShelf.src.interface.models.Books.Meta" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.interface.models.Books.Meta -.SH SYNOPSIS -.br -.PP -.SS "Static Public Attributes" - -.in +1c -.ti -1c -.RI "string \fBdb_table\fP = 'books'" -.br -.in -1c -.SH "Detailed Description" -.PP - - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/man/man3/pyShelf_src_manage.3 b/docs/man/man3/pyShelf_src_manage.3 deleted file mode 100644 index fbd7370..0000000 --- a/docs/man/man3/pyShelf_src_manage.3 +++ /dev/null @@ -1,27 +0,0 @@ -.TH "pyShelf.src.manage" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*- -.ad l -.nh -.SH NAME -pyShelf.src.manage -.SH SYNOPSIS -.br -.PP -.SS "Functions" - -.in +1c -.ti -1c -.RI "def \fBmain\fP ()" -.br -.in -1c -.SH "Detailed Description" -.PP - -.PP -.nf -Django's command-line utility for administrative tasks. -.fi -.PP - -.SH "Author" -.PP -Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&. diff --git a/docs/warn.log b/docs/warn.log index 2cf983b..30ea500 100644 --- a/docs/warn.log +++ b/docs/warn.log @@ -1,25 +1,23 @@ /home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:19: warning: Compound pyShelf::src::backend::tests::library_test::Test_Catalogue is not documented. /home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:28: warning: Compound pyShelf::src::backend::tests::library_test::TestCatalogue is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:18: warning: Compound pyShelf::src::interface::models::Books::Meta is not documented. /home/raelon/Projects/pyShelf/src/backend/tests/config_test.py:6: warning: Compound pyShelf::src::backend::tests::config_test::TestConfig is not documented. -/home/raelon/Projects/pyShelf/src/interface/apps.py:4: warning: Compound pyShelf::src::interface::apps::InterfaceConfig is not documented. /home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:8: warning: Compound pyShelf::src::backend::tests::library_test::Test_Config is not documented. -/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:6: warning: Compound pyShelf::src::interface::migrations::0001_initial::Migration is not documented. /home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:12: warning: Member __init__(self) (function) of class pyShelf::src::backend::lib::api_hooks::DuckDuckGo is not documented. /home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:13: warning: Member url (variable) of class pyShelf::src::backend::lib::api_hooks::DuckDuckGo is not documented. /home/raelon/Projects/pyShelf/src/backend/lib/api_hooks.py:15: warning: return type of member pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:14: warning: Member __init__(self, root) (function) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:17: warning: Member book_path (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:18: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:19: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member book_shelf (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member catalogue_db (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member file_array (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: warning: Member auto_scan (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:34: warning: return type of member pyShelf.src.backend.lib.config.Config.open_file is not documented +/home/raelon/Projects/pyShelf/src/backend/lib/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. @@ -52,18 +50,19 @@ /home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:64: warning: return type of member pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage is not documented /home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:15: warning: Member __init__(self, file_array) (function) of class pyShelf::src::backend::lib::pyShelf::InitFiles is not documented. /home/raelon/Projects/pyShelf/src/backend/lib/pyShelf.py:27: warning: return type of member pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:14: warning: Member __init__(self, db_pointer, config) (function) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:16: warning: Member sql (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:17: warning: Member user (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:18: warning: Member password (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:26: warning: Member db (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:27: warning: Member cursor (variable) of class pyShelf::src::backend::lib::storage::Storage is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:71: warning: return type of member pyShelf.src.backend.lib.storage.Storage.book_paths_list is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:93: warning: return type of member pyShelf.src.backend.lib.storage.Storage.close is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:83: warning: return type of member pyShelf.src.backend.lib.storage.Storage.commit is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:34: warning: return type of member pyShelf.src.backend.lib.storage.Storage.create_tables is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:22: warning: return type of member pyShelf.src.backend.lib.storage.Storage.database is not documented -/home/raelon/Projects/pyShelf/src/backend/lib/storage.py:45: warning: return type of member pyShelf.src.backend.lib.storage.Storage.insert_book is not documented +/home/raelon/Projects/pyShelf/src/backend/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. @@ -89,61 +88,19 @@ /home/raelon/Projects/pyShelf/src/backend/lib/library.py:73: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.process_book is not documented /home/raelon/Projects/pyShelf/src/backend/lib/library.py:35: warning: return type of member pyShelf.src.backend.lib.library.Catalogue.scan_folder is not documented /home/raelon/Projects/pyShelf/src/backend/tests/library_test.py:9: warning: Member __init__(self) (function) of class pyShelf::src::backend::tests::library_test::Test_Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:17: warning: Member book_path (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:18: warning: Member TITLE (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:19: warning: Member VERSION (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:21: warning: Member book_shelf (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:24: warning: Member catalogue_db (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:25: warning: Member user (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:26: warning: Member password (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:27: warning: Member file_array (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:31: warning: Member root (variable) of class pyShelf::src::backend::lib::config::Config is not documented. -/home/raelon/Projects/pyShelf/src/backend/lib/config.py:32: warning: Member auto_scan (variable) of class pyShelf::src::backend::lib::config::Config is not documented. +/home/raelon/Projects/pyShelf/src/backend/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/frontend/settings.py:16: warning: Member BASE_DIR (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:23: warning: Member SECRET_KEY (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:26: warning: Member DEBUG (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:28: warning: Member ALLOWED_HOSTS (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:33: warning: Member INSTALLED_APPS (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:45: warning: Member MIDDLEWARE (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:56: warning: Member INTERNAL_IPS (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:62: warning: Member ROOT_URLCONF (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:64: warning: Member TEMPLATES (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:80: warning: Member WSGI_APPLICATION (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:86: warning: Member DATABASES (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:100: warning: Member AUTH_PASSWORD_VALIDATORS (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:113: warning: Member LANGUAGE_CODE (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:115: warning: Member TIME_ZONE (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:117: warning: Member USE_I18N (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:119: warning: Member USE_L10N (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:121: warning: Member USE_TZ (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:127: warning: Member STATIC_URL (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:128: warning: Member STATIC_ROOT (variable) of namespace pyShelf::src::frontend::settings is not documented. -/home/raelon/Projects/pyShelf/src/frontend/settings.py:100: warning: parameters of member pyShelf.src.frontend.settings.AUTH_PASSWORD_VALIDATORS are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/settings.py:86: warning: parameters of member pyShelf.src.frontend.settings.DATABASES are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/settings.py:33: warning: parameters of member pyShelf.src.frontend.settings.INSTALLED_APPS are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/settings.py:56: warning: parameters of member pyShelf.src.frontend.settings.INTERNAL_IPS are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/settings.py:45: warning: parameters of member pyShelf.src.frontend.settings.MIDDLEWARE are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/settings.py:64: warning: parameters of member pyShelf.src.frontend.settings.TEMPLATES are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/urls.py:21: warning: Member urlpatterns (variable) of namespace pyShelf::src::frontend::urls is not documented. -/home/raelon/Projects/pyShelf/src/frontend/urls.py:21: warning: parameters of member pyShelf.src.frontend.urls.urlpatterns are not (all) documented -/home/raelon/Projects/pyShelf/src/frontend/wsgi.py:16: warning: Member application (variable) of namespace pyShelf::src::frontend::wsgi is not documented. -/home/raelon/Projects/pyShelf/src/interface/apps.py:5: warning: Member name (variable) of class pyShelf::src::interface::apps::InterfaceConfig is not documented. -/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:8: warning: Member initial (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. -/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:10: warning: Member dependencies (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. -/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:12: warning: Member operations (variable) of class pyShelf::src::interface::migrations::0001_initial::Migration is not documented. -/home/raelon/Projects/pyShelf/src/interface/migrations/0001_initial.py:12: warning: parameters of member pyShelf.src.interface.migrations.0001_initial.Migration.operations are not (all) documented -/home/raelon/Projects/pyShelf/src/interface/models.py:21: warning: Member __str__(self) (function) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:24: warning: Member title (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:25: warning: Member author (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:26: warning: Member categories (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:27: warning: Member cover (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:28: warning: Member pages (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:29: warning: Member progress (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:30: warning: Member file_name (variable) of class pyShelf::src::interface::models::Books is not documented. -/home/raelon/Projects/pyShelf/src/interface/models.py:32: warning: return type of member pyShelf.src.interface.models.Books.get_absolute_url is not documented -/home/raelon/Projects/pyShelf/src/interface/models.py:19: warning: Member db_table (variable) of class pyShelf::src::interface::models::Books::Meta is not documented. -/home/raelon/Projects/pyShelf/src/manage.py:7: warning: Member main() (function) of namespace pyShelf::src::manage is not documented. diff --git a/doxygen.conf b/doxygen.conf index 3a5d4fe..4ee4fbc 100644 --- a/doxygen.conf +++ b/doxygen.conf @@ -38,7 +38,7 @@ PROJECT_NAME = "pyShelf Open Source Ebook Server" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.2.1 +PROJECT_NUMBER = 0.3.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = "docs/" # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = NO +CREATE_SUBDIRS = YES # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII @@ -829,7 +829,7 @@ WARN_LOGFILE = "docs/warn.log" # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = "src/" +INPUT = "src/backend" # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/requirements b/requirements deleted file mode 100644 index 6815d6f..0000000 --- a/requirements +++ /dev/null @@ -1,48 +0,0 @@ -appdirs==1.4.3 -aspy.yaml==1.3.0 -astroid==2.3.3 -attrs==19.3.0 -beautifulsoup4==4.8.1 -black==19.10b0 -bs4==0.0.1 -certifi==2019.9.11 -cfgv==2.0.1 -chardet==3.0.4 -Click==7.0 -Django==2.2.7 -django-debug-toolbar==2.1 -greenlet==0.4.15 -identify==1.4.7 -idna==2.8 -isort==4.3.21 -lazy-object-proxy==1.4.3 -lxml==4.4.1 -mccabe==0.6.1 -msgpack==0.6.2 -nodeenv==1.3.3 -Paste==3.2.2 -pathspec==0.6.0 -Pillow==6.2.1 -pre-commit==1.20.0 -ptvsd==4.3.2 -pudb==2019.1 -Pygments==2.4.2 -pylint==2.4.4 -pynvim==0.4.0 -pytz==2019.3 -PyYAML==5.1.2 -regex==2019.11.1 -requests==2.22.0 -six==1.13.0 -soupsieve==1.9.5 -sqlparse==0.3.0 -toml==0.10.0 -typed-ast==1.4.0 -urllib3==1.25.7 -urwid==2.1.0 -uWSGI==2.0.18 -virtualenv==16.7.7 -w3lib==1.21.0 -websockets==8.1 -wrapt==1.11.2 -xsendfile==1.0rc2 diff --git a/src/backend/lib/config.py b/src/backend/lib/config.py index 76347df..1591db6 100755 --- a/src/backend/lib/config.py +++ b/src/backend/lib/config.py @@ -12,6 +12,9 @@ class Config: _fp = "config.json" def __init__(self, root): + """ + Initialize main configuration options + """ _cp = pathlib.Path.joinpath(root, self._fp) _data = self.open_file(_cp) self.book_path = _data["BOOKPATH"] @@ -24,6 +27,8 @@ class Config: self.catalogue_db = _data["DATABASE"] self.user = _data["USER"] self.password = _data["PASSWORD"] + self.db_host = _data["DB_HOST"] + self.db_port = _data["DB_PORT"] self.file_array = [ self.book_shelf, # self.catalogue_db, diff --git a/src/backend/lib/library.py b/src/backend/lib/library.py index a6c504a..94e7c9d 100755 --- a/src/backend/lib/library.py +++ b/src/backend/lib/library.py @@ -143,7 +143,7 @@ class Catalogue: """ db = Storage(self.db_pointer, self.config) stored = db.book_paths_list() - closed = db.close() + db.close() if self.books is None: self.filter_books() on_disk, in_storage = [], [] diff --git a/src/backend/lib/storage.py b/src/backend/lib/storage.py index 51b33bf..b681a10 100755 --- a/src/backend/lib/storage.py +++ b/src/backend/lib/storage.py @@ -2,6 +2,7 @@ import sqlite3 import psycopg2 +from psycopg2 import Error from .config import Config @@ -16,21 +17,14 @@ class Storage: self.sql = config.catalogue_db self.user = config.user self.password = config.password - self.database() + self.db_host = config.db_host + self.db_port = config.db_port + self.db = psycopg2.connect( + database=self.sql, user=self.user, password=self.password, host=self.db_host + ) + self.cursor = self.db.cursor() # self.create_tables() - def database(self): - """Create database cursor""" - try: - # self.db = sqlite3.connect(self.db_file) - self.db = psycopg2.connect(database=self.sql, user=self.user) - self.cursor = self.db.cursor() - return True - except Exception as e: - print(self.sql) - print(e) - return False - def create_tables(self): """Create table structure""" q_check = "SELECT * FROM books" @@ -47,22 +41,15 @@ class Storage: Insert book in database :returns: True if succeeds False if not """ - q_x = ( - "SELECT title FROM books WHERE EXISTS(SELECT * from books WHERE title = %s)" - ) - q = "INSERT INTO books (title, author, cover, progress, file_name, pages) values (%s, %s, %s, 0, %s, 0)" + q = "INSERT INTO books (title, author, cover, progress, file_name, pages) values (%s, %s, %s, 0, %s, 0);" try: try: cover_image = book[2].data except: cover_image = book[2] - x = self.cursor.execute(q_x, (book[0],)) - try: - len(x.fetchone()) > 0 - except Exception: - if not book[2]: # If cover image is missing unset entry - cover_image = None - self.cursor.execute(q, (book[0], book[1], cover_image, book[3])) + if not book[2]: # If cover image is missing unset entry + cover_image = None + self.cursor.execute(q, (book[0], book[1], cover_image, book[3])) return True except Exception as e: print(e) @@ -72,11 +59,12 @@ class Storage: """ Get file paths from database for comparison to system files """ - q = """SELECT file_name FROM books""" - x = self.cursor.execute(q) + q = "SELECT file_name FROM books;" + self.cursor.execute(q) try: - x = x.fetchall() - except Exception: + x = self.cursor.fetchall() + except psycopg2.Error as e: + print(e) x = [] return x diff --git a/src/frontend/urls.py b/src/frontend/urls.py index 7bc23ad..5852873 100755 --- a/src/frontend/urls.py +++ b/src/frontend/urls.py @@ -24,8 +24,9 @@ urlpatterns = [ path("download/", views.download, name="download"), path("prev_page/", views.prev_page, name="prev_page"), path("next_page/", views.next_page, name="next_page"), - path("search/", views.search, name="search"), path("search/", views.search, name="search"), + path("search/", views.search, name="search"), + path("search//<_set>", views.search, name="search"), ] if settings.DEBUG: import debug_toolbar diff --git a/src/interface/static/css/main.css b/src/interface/static/css/main.css index 07cdfc2..3c58dff 100755 --- a/src/interface/static/css/main.css +++ b/src/interface/static/css/main.css @@ -3,14 +3,14 @@ body{ padding: 0px; background-color: #DCDCDD; color: #fff; - overflow: hidden; + overflow-x: hidden; } #app{ display: grid; grid-template-areas: "app_header" "app_body" "app_footer"; - grid-template-rows: auto 84vh auto; + grid-template-rows: auto auto auto; max-height: 100%; } .clear{ @@ -74,14 +74,39 @@ body{ grid-template-rows: auto; grid-template-areas: "shelf"; justify-items: center; - overflow-y: scroll; background-color: dimgray; } .app_footer{ grid-area: app_footer; + display: grid; + grid-template-areas: "python_badge gplv3_badge contact"; + grid-template-columns: 1fr 1fr 8fr; + justify-content: space-between; min-width: 100%; background-color: #2b2b2b; margin: 0px; + font-family: Audiowide, cursive; + font-size: 15px; +} +.web_footer_link{ + text-decoration: none; + color: #a5a3a3; +} +.copyright{ + grid-area: gplv3_badge; + display: grid; + align-content: center; + font-family: Audiowide, cursive; + font-size: 9px; + justify-self: left; +} +.footer_contact{ + grid-area: contact; + display: inline-grid; + align-content: center; + justify-items: right; + font-size: 12px; + } .nav_top{ grid-area: nav_top; @@ -115,6 +140,10 @@ justify-content: right; } .button{ +} +.discord-button{ + max-width: 78px; + max-height: 26px; } .nav_button{ background-color:darkgray; @@ -132,6 +161,11 @@ justify-content: right; } .search{ +} +.search_details{ + display: flex; + justify-content: center; + margin: 0px 0px 5px 0px; } .shelf{ grid-area: shelf; @@ -140,18 +174,21 @@ justify-content: right; list-style-type: none; } .shelf_contents{ - display: flex; - flex-direction: column; - flex: 1; } .right_col{ grid-area: right_col } .python_logo{ + grid-area: python_badge; + display: grid; + align-content: center; } +p{ + margin: 0px; +} #python_logo{ - height: 50px; + height: 37px; width: 91px; } #book_shelf{ @@ -162,17 +199,19 @@ justify-content: right; font-size: 25px; padding: 0; margin: 0px; + min-width: 99vw; } .shelf_item{ + display: grid; background-color: burlywood; - margin: 0 10px 10px 0; + margin: 0 10px 10px 10px; max-width: 23vw; max-height: 75vh; text-align: center; } .book_thumb{ width: 23vw; - height: 75vh; + height: 50vh; } a.book_link{ text-decoration: none; diff --git a/src/interface/static/img/discord_logo_color.png b/src/interface/static/img/discord_logo_color.png new file mode 100644 index 0000000..5e2872e Binary files /dev/null and b/src/interface/static/img/discord_logo_color.png differ diff --git a/src/interface/static/img/gplv3-or-later.png b/src/interface/static/img/gplv3-or-later.png new file mode 100644 index 0000000..fe5eb73 Binary files /dev/null and b/src/interface/static/img/gplv3-or-later.png differ diff --git a/src/interface/static/img/pyShelf_frontend_0_1_0.png b/src/interface/static/img/pyShelf_frontend_0_1_0.png index 9fd1ddc..9a11246 100644 Binary files a/src/interface/static/img/pyShelf_frontend_0_1_0.png and b/src/interface/static/img/pyShelf_frontend_0_1_0.png differ diff --git a/src/interface/static/img/pyShelf_frontend_0_1_0_thumb.png b/src/interface/static/img/pyShelf_frontend_0_1_0_thumb.png index 492329c..1ab86de 100644 Binary files a/src/interface/static/img/pyShelf_frontend_0_1_0_thumb.png and b/src/interface/static/img/pyShelf_frontend_0_1_0_thumb.png differ diff --git a/src/interface/static/js/pyshelf_ux.js b/src/interface/static/js/pyshelf_ux.js index f846b49..fcadd24 100644 --- a/src/interface/static/js/pyshelf_ux.js +++ b/src/interface/static/js/pyshelf_ux.js @@ -4,4 +4,12 @@ $(document).ready(function(){ console.log(query); window.location.href = '/search/'+query; }) + $('.nav_search').on('keypress', function (e) { + if(e.which === 13){ + $(this).attr("disabled", "disabled"); + var query = $('.nav_search').val(); + window.location.href = '/search/'+query; + $(this).removeAttr("disabled"); + } + }); }) diff --git a/src/interface/templates/index.html b/src/interface/templates/index.html index 6bfcbd9..6935f17 100755 --- a/src/interface/templates/index.html +++ b/src/interface/templates/index.html @@ -18,12 +18,15 @@
    -

    pyShelf

    +

    pyShelf 0.3.0

    -

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

    +

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

    + + + Fork @@ -56,9 +59,16 @@
    - + +
    + GPLv3 or later +
    +
    + +

    irc: #pyshelf on freenode | discord: discord.gg/H9TbNJS | web: http://pyshelf.com | source: github.com/th3r00t/pyShelf

    +
    diff --git a/src/interface/templates/search.html b/src/interface/templates/search.html new file mode 100644 index 0000000..8b56ff8 --- /dev/null +++ b/src/interface/templates/search.html @@ -0,0 +1,77 @@ +{% load filters %} + + + + + + + +pyShelf E-Book Server Search Results + + + + + + + + +
    +
    +
    +

    pyShelf 0.3.0

    +
    +
    +

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

    +
    +
    + + + + + Fork + +Issue + +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    +
    +
    + Your search for {{ Query }} returned {{ len_results }} results +
    +
    +
      + {% for book in Books %} +
    • {{ book.title }}
      • + {% endfor %} +
    +
    +
    +
    +
    + +
    + GPLv3 or later +
    +
    +

    irc: #pyshelf on freenode | discord: discord.gg/H9TbNJS | web: http://pyshelf.com | source: github.com/th3r00t/pyShelf

    +
    +
    +
    + + diff --git a/src/interface/views.py b/src/interface/views.py index f371e8a..57d299d 100755 --- a/src/interface/views.py +++ b/src/interface/views.py @@ -11,6 +11,9 @@ from .models import Books def index(request): + """ + Return template index + """ _set = 1 return render( request, "index.html", {"Books": book_set(20, _set), "Set": str(_set)} @@ -18,6 +21,9 @@ def index(request): def next_page(request, bookset): + """ + Goto next page in bookset + """ try: _set = int(bookset) + 1 except Exception: @@ -28,6 +34,9 @@ def next_page(request, bookset): def prev_page(request, bookset): + """ + Goto previous page in bookset + """ _set = int(bookset) if _set <= 1: _set = 1 @@ -41,14 +50,33 @@ def prev_page(request, bookset): ) -def search(request, query=None): +def search(request, query=None, _set=1, _limit=None): + """ + Call generic search and return rendered results + """ + _set = int(_set) if query is None: return render(request, "index.html", {"Books": None}) - _r = Books().generic_search(query) - return render(request, "index.html", {"Books": _r}) + if _limit is None: + _limit = 20 ## TODO set to user defaults + if _set < 1: + _set = 1 + _set_max = int(_set) * _limit + _set_min = _set_max - _limit + search = Books().generic_search(query) + search_len = search.count() + _r = search[_set_min:_set_max] + return render( + request, + "search.html", + {"Books": _r, "Query": query, "Set": _set, "len_results": search_len}, + ) def book_set(_limit=None, _set=1): + """ + Get books results by set # + """ if _limit is None: _limit = 20 # TODO default from user choice _set_max = int(_set) * _limit @@ -79,6 +107,9 @@ def book_set_as_dict(_limit=None, _set=1): def download(request, pk): + """ + Download book by primary key + """ _book = Books.objects.all().filter(pk=pk)[0] _fn = hr_name(_book) response = HttpResponse( @@ -89,4 +120,7 @@ def download(request, pk): def hr_name(book): + """ + Nicer file names + """ return "{0}.{1}".format(slugify(book.title), book.file_name.split(".")[1])