th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Mike Young
2019-12-01 13:09:41 -05:00
parent db388f4ec6
commit 3337cab11e
148 changed files with 7199 additions and 2107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/man/man3/app_config_Config.3 vendored
View File

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

118
docs/man/man3/app_lib_display_Frontend.3 vendored
View File

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

123
docs/man/man3/app_lib_library_Catalogue.3 vendored
View File

@@ -1,123 +0,0 @@
.TH "app.lib.library.Catalogue" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.library.Catalogue
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, folder=config\&.book_path)"
.br
.ti -1c
.RI "def \fBscan_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBprocess_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_html\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_image\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBcompare_shelf_current\fP (self)"
.br
.ti -1c
.RI "def \fBimport_books\fP (self, list=None)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBfile_list\fP"
.br
.ti -1c
.RI "\fBopf_regx\fP"
.br
.ti -1c
.RI "\fBcover_regx\fP"
.br
.ti -1c
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBbooks\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Decodes and stores book information
.fi
.PP
.PP
.nf
Step One: filter_books.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)"
.PP
.nf
Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.filter_books ( self)"
.PP
.nf
Scan book folder recursively for epub files
filter_books(0) -> Catalogue.books
filter_books(1) -> self.books[]
:param ret: 0 -> create class property -> dump json
:param ret: 1 -> create & return class property
.fi
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.process_book ( self, book)"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def app\&.lib\&.library\&.Catalogue\&.scan_book ( self, book)"
.PP
.nf
REMOVE ME?
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

77
docs/man/man3/app_lib_pyShelf_BookServer.3 vendored
View File

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

37
docs/man/man3/app_lib_pyShelf_RequestHandler.3 vendored
View File

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

87
docs/man/man3/app_lib_storage_Storage.3 vendored
View File

@@ -1,87 +0,0 @@
.TH "app.lib.storage.Storage" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.storage.Storage
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBdatabase\fP (self)"
.br
.ti -1c
.RI "def \fBcreate_tables\fP (self)"
.br
.ti -1c
.RI "def \fBinsert_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBbook_paths_list\fP (self)"
.br
.ti -1c
.RI "def \fBcommit\fP (self)"
.br
.ti -1c
.RI "def \fBclose\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBdb_file\fP"
.br
.ti -1c
.RI "\fBdb\fP"
.br
.ti -1c
.RI "\fBcursor\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Contains all methods for system storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
.nf
Create table structure
.fi
.PP
.SS "def app\&.lib\&.storage\&.Storage\&.database ( self)"
.PP
.nf
Create database cursor
.fi
.PP
.SS "def app\&.lib\&.storage\&.Storage\&.insert_book ( self, book)"
.PP
.nf
Insert book in database
:returns: True if succeeds False if not
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

14
docs/man/man3/md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2.3 vendored Normal file
View File

@@ -0,0 +1,14 @@
.TH "md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
md_src_interface_static_admin_css_vendor_select2_LICENSE-SELECT2 \- LICENSE-SELECT2
The MIT License (MIT)
.PP
Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors
.PP
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
.PP
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&.
.PP
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&.

14
docs/man/man3/md_src_interface_static_admin_js_vendor_select2_LICENSE.3 vendored Normal file
View File

@@ -0,0 +1,14 @@
.TH "md_src_interface_static_admin_js_vendor_select2_LICENSE" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
md_src_interface_static_admin_js_vendor_select2_LICENSE \- LICENSE
The MIT License (MIT)
.PP
Copyright (c) 2012-2015 Kevin Brown, Igor Vaynberg, and Select2 contributors
.PP
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
.PP
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\&.
.PP
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\&. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\&.

6
docs/man/man3/app_lib_api_hooks_DuckDuckGo.3 → docs/man/man3/pyShelf_src_backend_lib_api_hooks_DuckDuckGo.3 vendored Executable file → Normal file
View File

@@ -1,8 +1,8 @@
.TH "app.lib.api_hooks.DuckDuckGo" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "pyShelf.src.backend.lib.api_hooks.DuckDuckGo" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.api_hooks.DuckDuckGo
pyShelf.src.backend.lib.api_hooks.DuckDuckGo
.SH SYNOPSIS
.br
.PP
@@ -34,7 +34,7 @@ duckduckgo related searching
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.api_hooks\&.DuckDuckGo\&.image_result ( self, query)"
.PP
.nf

81
docs/man/man3/pyShelf_src_backend_lib_config_Config.3 vendored Normal file
View File

@@ -0,0 +1,81 @@
.TH "pyShelf.src.backend.lib.config.Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.config.Config
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, root)"
.br
.ti -1c
.RI "def \fBopen_file\fP (self, _cp)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_path\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.ti -1c
.RI "\fBVERSION\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBcatalogue_db\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBfile_array\fP"
.br
.ti -1c
.RI "\fBroot\fP"
.br
.ti -1c
.RI "\fBauto_scan\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Main System Configuration
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.config\&.Config\&.open_file ( self, _cp)"
.PP
.nf
Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented in \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

187
docs/man/man3/pyShelf_src_backend_lib_library_Catalogue.3 vendored Normal file
View File

@@ -0,0 +1,187 @@
.TH "pyShelf.src.backend.lib.library.Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.library.Catalogue
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, config)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, _path=None)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_html\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_image\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBcompare_shelf_current\fP (self)"
.br
.ti -1c
.RI "def \fBimport_books\fP (self, list=None)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBfile_list\fP"
.br
.ti -1c
.RI "\fBopf_regx\fP"
.br
.ti -1c
.RI "\fBcover_regx\fP"
.br
.ti -1c
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBroot_dir\fP"
.br
.ti -1c
.RI "\fBbook_folder\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBbooks\fP"
.br
.ti -1c
.RI "\fBdb_pointer\fP"
.br
.ti -1c
.RI "\fBconfig\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Decodes book metadata for storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)"
.PP
.nf
Calls storage system, gets list of books stored and compares against files on disk
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)"
.PP
.nf
Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.filter_books ( self)"
.PP
.nf
Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
.fi
.PP
.PP
Reimplemented in \fBpyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\fP\&.
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)"
.PP
.nf
Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)"
.PP
.nf
Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

21
docs/man/man3/app_lib_pyShelf_BookDisplay.3 → docs/man/man3/pyShelf_src_backend_lib_pyShelf_BookDisplay.3 vendored Executable file → Normal file
View File

@@ -1,8 +1,8 @@
.TH "app.lib.pyShelf.BookDisplay" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "pyShelf.src.backend.lib.pyShelf.BookDisplay" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.BookDisplay
pyShelf.src.backend.lib.pyShelf.BookDisplay
.SH SYNOPSIS
.br
.PP
@@ -10,7 +10,7 @@ app.lib.pyShelf.BookDisplay
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.RI "def \fB__init__\fP (self, **kwargs)"
.br
.ti -1c
.RI "def \fBnextPage\fP (self)"
@@ -40,6 +40,9 @@ app.lib.pyShelf.BookDisplay
.ti -1c
.RI "\fBtotal_pages\fP"
.br
.ti -1c
.RI "\fBscreen_size\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
@@ -52,7 +55,7 @@ All functions related to displaying book information in the HTML UI
.SH "Constructor & Destructor Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.__init__ ( self, ** kwargs)"
.PP
.nf
@@ -64,32 +67,34 @@ Initialize class variables
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.booksPerPage ( self, screen_size)"
.PP
.nf
## TODO Remove me
Set books per page
:param screen_size: Array containing x,y pixel sizes
:return: self.books_per_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.nextPage ( self)"
.PP
.nf
## TODO Remove me
Goto next book page
:return: new current_page
.fi
.PP
.SS "def app\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.BookDisplay\&.previousPage ( self)"
.PP
.nf
## TODO Remove me
Goto previous book page
:return: new current_page

9
docs/man/man3/app_lib_pyShelf_InitFiles.3 → docs/man/man3/pyShelf_src_backend_lib_pyShelf_InitFiles.3 vendored Executable file → Normal file
View File

@@ -1,8 +1,8 @@
.TH "app.lib.pyShelf.InitFiles" 3 "Sun Nov 10 2019" "Version 0.1.0" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.TH "pyShelf.src.backend.lib.pyShelf.InitFiles" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app.lib.pyShelf.InitFiles
pyShelf.src.backend.lib.pyShelf.InitFiles
.SH SYNOPSIS
.br
.PP
@@ -27,11 +27,12 @@ First run file creation operations
.SH "Member Function Documentation"
.PP
.SS "def app\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)"
.SS "def pyShelf\&.src\&.backend\&.lib\&.pyShelf\&.InitFiles\&.CreateFile ( self, _pointer)"
.PP
.nf
Create the file
Checks if file exists and creates it if not
.fi
.PP

120
docs/man/man3/pyShelf_src_backend_lib_storage_Storage.3 vendored Normal file
View File

@@ -0,0 +1,120 @@
.TH "pyShelf.src.backend.lib.storage.Storage" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.lib.storage.Storage
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self, db_pointer, config)"
.br
.ti -1c
.RI "def \fBdatabase\fP (self)"
.br
.ti -1c
.RI "def \fBcreate_tables\fP (self)"
.br
.ti -1c
.RI "def \fBinsert_book\fP (self, book)"
.br
.ti -1c
.RI "def \fBbook_paths_list\fP (self)"
.br
.ti -1c
.RI "def \fBcommit\fP (self)"
.br
.ti -1c
.RI "def \fBclose\fP (self)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBsql\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBdb\fP"
.br
.ti -1c
.RI "\fBcursor\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Contains all methods for system storage
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.book_paths_list ( self)"
.PP
.nf
Get file paths from database for comparison to system files
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.close ( self)"
.PP
.nf
Close database connection
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.commit ( self)"
.PP
.nf
Commit database transactions
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.create_tables ( self)"
.PP
.nf
Create table structure
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.database ( self)"
.PP
.nf
Create database cursor
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.storage\&.Storage\&.insert_book ( self, book)"
.PP
.nf
Insert book in database
:returns: True if succeeds False if not
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

35
docs/man/man3/pyShelf_src_backend_tests_config_test_TestConfig.3 vendored Normal file
View File

@@ -0,0 +1,35 @@
.TH "pyShelf.src.backend.tests.config_test.TestConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.config_test.TestConfig
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBtest_book_dir\fP (self)"
.br
.ti -1c
.RI "def \fBtest_title\fP (self)"
.br
.ti -1c
.RI "def \fBtest_version\fP (self)"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "\fBconfig\fP = \fBConfig\fP(os\&.path\&.abspath(os\&.path\&.curdir))"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

32
docs/man/man3/pyShelf_src_backend_tests_library_test_TestCatalogue.3 vendored Normal file
View File

@@ -0,0 +1,32 @@
.TH "pyShelf.src.backend.tests.library_test.TestCatalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.TestCatalogue
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBtest_filter_books\fP (self)"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "\fBroot\fP = os\&.path\&.abspath(os\&.path\&.curdir)"
.br
.ti -1c
.RI "\fBconfig\fP = \fBTest_Config\fP()"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

179
docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Catalogue.3 vendored Normal file
View File

@@ -0,0 +1,179 @@
.TH "pyShelf.src.backend.tests.library_test.Test_Catalogue" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.Test_Catalogue
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBpyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBfilter_books\fP (self)"
.br
.ti -1c
.RI "def \fBscan_folder\fP (self, _path=None)"
.br
.ti -1c
.RI "def \fBextract_metadata\fP (self, book)"
.br
.ti -1c
.RI "def \fBextract_content\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_html\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBextract_cover_image\fP (self, book_zip, book)"
.br
.ti -1c
.RI "def \fBcompare_shelf_current\fP (self)"
.br
.ti -1c
.RI "def \fBimport_books\fP (self, list=None)"
.br
.in -1c
.SS "Static Public Member Functions"
.in +1c
.ti -1c
.RI "def \fBprocess_book\fP (book)"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBfile_list\fP"
.br
.ti -1c
.RI "\fBopf_regx\fP"
.br
.ti -1c
.RI "\fBcover_regx\fP"
.br
.ti -1c
.RI "\fBhtml_regx\fP"
.br
.ti -1c
.RI "\fBroot_dir\fP"
.br
.ti -1c
.RI "\fBbook_folder\fP"
.br
.ti -1c
.RI "\fBbooks\fP"
.br
.ti -1c
.RI "\fBdb_pointer\fP"
.br
.ti -1c
.RI "\fBconfig\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.compare_shelf_current ( self)\fC [inherited]\fP"
.PP
.nf
Calls storage system, gets list of books stored and compares against files on disk
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_content ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching opf_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_html ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching html_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_cover_image ( self, book_zip, book)\fC [inherited]\fP"
.PP
.nf
Opens epub as zip file filters then stores as list any files matching cover_regx
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.extract_metadata ( self, book)\fC [inherited]\fP"
.PP
.nf
Return extracted metadata and cover picture
book['path'] == Full path to ebook file
book['files'] == list of files from self.process_book(book)
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Catalogue\&.filter_books ( self)"
.PP
.nf
Calls scan_folder and filters out book files
Proceeds to call process_book
:returns self._book_list_expanded: json string containing all book metadata
.fi
.PP
.PP
Reimplemented from \fBpyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\fP\&.
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.import_books ( self, list = \fCNone\fP)\fC [inherited]\fP"
.PP
.nf
Main entry point for import operations.
Gets a list of new files via compare_shelf_current.
Iterates over list and inserts new books into database.
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.process_book ( book)\fC [static]\fP, \fC [inherited]\fP"
.PP
.nf
Return dictionary of epub file contents
.fi
.PP
.SS "def pyShelf\&.src\&.backend\&.lib\&.library\&.Catalogue\&.scan_folder ( self, _path = \fCNone\fP)\fC [inherited]\fP"
.PP
.nf
Scan folder by _path, allows recurisive scanning
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

73
docs/man/man3/pyShelf_src_backend_tests_library_test_Test_Config.3 vendored Normal file
View File

@@ -0,0 +1,73 @@
.TH "pyShelf.src.backend.tests.library_test.Test_Config" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.backend.tests.library_test.Test_Config
.SH SYNOPSIS
.br
.PP
.PP
Inherits \fBpyShelf\&.src\&.backend\&.lib\&.config\&.Config\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__init__\fP (self)"
.br
.ti -1c
.RI "def \fBopen_file\fP (self, root='config\&.json')"
.br
.in -1c
.SS "Public Attributes"
.in +1c
.ti -1c
.RI "\fBbook_path\fP"
.br
.ti -1c
.RI "\fBTITLE\fP"
.br
.ti -1c
.RI "\fBVERSION\fP"
.br
.ti -1c
.RI "\fBbook_shelf\fP"
.br
.ti -1c
.RI "\fBcatalogue_db\fP"
.br
.ti -1c
.RI "\fBuser\fP"
.br
.ti -1c
.RI "\fBpassword\fP"
.br
.ti -1c
.RI "\fBfile_array\fP"
.br
.ti -1c
.RI "\fBroot\fP"
.br
.ti -1c
.RI "\fBauto_scan\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.backend\&.tests\&.library_test\&.Test_Config\&.open_file ( self, _cp = \fC'config\&.json'\fP)"
.PP
.nf
Opens config.json and reads in configuration options
.fi
.PP
.PP
Reimplemented from \fBpyShelf\&.src\&.backend\&.lib\&.config\&.Config\fP\&.
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

180
docs/man/man3/pyShelf_src_frontend_settings.3 vendored Normal file
View File

@@ -0,0 +1,180 @@
.TH "pyShelf.src.frontend.settings" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.frontend.settings
.SH SYNOPSIS
.br
.PP
.SS "Variables"
.in +1c
.ti -1c
.RI "\fBBASE_DIR\fP = os\&.path\&.dirname(os\&.path\&.dirname(os\&.path\&.abspath(__file__)))"
.br
.ti -1c
.RI "string \fBSECRET_KEY\fP = '@(9b9jslgg41u1u=mr)\-2*\-n2x0vef0zsy39*z@sz18&tvow18'"
.br
.ti -1c
.RI "bool \fBDEBUG\fP = False"
.br
.ti -1c
.RI "list \fBALLOWED_HOSTS\fP = ['*']"
.br
.ti -1c
.RI "list \fBINSTALLED_APPS\fP"
.br
.ti -1c
.RI "list \fBMIDDLEWARE\fP"
.br
.ti -1c
.RI "list \fBINTERNAL_IPS\fP"
.br
.ti -1c
.RI "string \fBROOT_URLCONF\fP = 'frontend\&.urls'"
.br
.ti -1c
.RI "list \fBTEMPLATES\fP"
.br
.ti -1c
.RI "string \fBWSGI_APPLICATION\fP = 'frontend\&.wsgi\&.application'"
.br
.ti -1c
.RI "dictionary \fBDATABASES\fP"
.br
.ti -1c
.RI "list \fBAUTH_PASSWORD_VALIDATORS\fP"
.br
.ti -1c
.RI "string \fBLANGUAGE_CODE\fP = 'en\-us'"
.br
.ti -1c
.RI "string \fBTIME_ZONE\fP = 'UTC'"
.br
.ti -1c
.RI "bool \fBUSE_I18N\fP = True"
.br
.ti -1c
.RI "bool \fBUSE_L10N\fP = True"
.br
.ti -1c
.RI "bool \fBUSE_TZ\fP = True"
.br
.ti -1c
.RI "string \fBSTATIC_URL\fP = '/static/'"
.br
.ti -1c
.RI "\fBSTATIC_ROOT\fP = os\&.path\&.join(BASE_DIR, 'interface/static/')"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Django settings for frontend project.
Generated by 'django-admin startproject' using Django 2.2.7.
For more information on this file, see
https://docs.djangoproject.com/en/2.2/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.2/ref/settings/
.fi
.PP
.SH "Variable Documentation"
.PP
.SS "list pyShelf\&.src\&.frontend\&.settings\&.AUTH_PASSWORD_VALIDATORS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 {
3 "NAME": "django\&.contrib\&.auth\&.password_validation\&.UserAttributeSimilarityValidator",
4 },
5 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.MinimumLengthValidator",},
6 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.CommonPasswordValidator",},
7 {"NAME": "django\&.contrib\&.auth\&.password_validation\&.NumericPasswordValidator",},
8 ]
.fi
.SS "dictionary pyShelf\&.src\&.frontend\&.settings\&.DATABASES"
\fBInitial value:\fP
.PP
.nf
1 = {
2 "default": {
3 "ENGINE": "django\&.db\&.backends\&.postgresql",
4 # "ENGINE": "django\&.db\&.backends\&.sqlite3",
5 "NAME": "pyshelf",
6 "PASSWORD": "",
7 # "NAME": os\&.path\&.join(BASE_DIR, "db\&.sqlite3"),
8 }
9 }
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.INSTALLED_APPS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 "django\&.contrib\&.admin",
3 "django\&.contrib\&.auth",
4 "django\&.contrib\&.contenttypes",
5 "django\&.contrib\&.sessions",
6 "django\&.contrib\&.messages",
7 "django\&.contrib\&.staticfiles",
8 "interface",
9 "interface\&.templatetags",
10 "debug_toolbar",
11 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.INTERNAL_IPS"
\fBInitial value:\fP
.PP
.nf
1 = [
2 # \&.\&.\&.
3 "127\&.0\&.0\&.1",
4 # \&.\&.\&.
5 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.MIDDLEWARE"
\fBInitial value:\fP
.PP
.nf
1 = [
2 "django\&.middleware\&.security\&.SecurityMiddleware",
3 "django\&.contrib\&.sessions\&.middleware\&.SessionMiddleware",
4 "django\&.middleware\&.common\&.CommonMiddleware",
5 "django\&.middleware\&.csrf\&.CsrfViewMiddleware",
6 "debug_toolbar\&.middleware\&.DebugToolbarMiddleware",
7 "django\&.contrib\&.auth\&.middleware\&.AuthenticationMiddleware",
8 "django\&.contrib\&.messages\&.middleware\&.MessageMiddleware",
9 "django\&.middleware\&.clickjacking\&.XFrameOptionsMiddleware",
10 ]
.fi
.SS "list pyShelf\&.src\&.frontend\&.settings\&.TEMPLATES"
\fBInitial value:\fP
.PP
.nf
1 = [
2 {
3 "BACKEND": "django\&.template\&.backends\&.django\&.DjangoTemplates",
4 "DIRS": [],
5 "APP_DIRS": True,
6 "OPTIONS": {
7 "context_processors": [
8 "django\&.template\&.context_processors\&.debug",
9 "django\&.template\&.context_processors\&.request",
10 "django\&.contrib\&.auth\&.context_processors\&.auth",
11 "django\&.contrib\&.messages\&.context_processors\&.messages",
12 ],
13 },
14 },
15 ]
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

55
docs/man/man3/pyShelf_src_frontend_urls.3 vendored Normal file
View File

@@ -0,0 +1,55 @@
.TH "pyShelf.src.frontend.urls" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.frontend.urls
.SH SYNOPSIS
.br
.PP
.SS "Variables"
.in +1c
.ti -1c
.RI "list \fBurlpatterns\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
frontend URL Configuration
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/2.2/topics/http/urls/
Examples:
Function views
1. Add an import: from my_app import views
2. Add a URL to urlpatterns: path('', views.home, name='home')
Class-based views
1. Add an import: from other_app.views import Home
2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
Including another URLconf
1. Import the include() function: from django.urls import include, path
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
.fi
.PP
.SH "Variable Documentation"
.PP
.SS "list pyShelf\&.src\&.frontend\&.urls\&.urlpatterns"
\fBInitial value:\fP
.PP
.nf
1 = [
2 path("admin/", admin\&.site\&.urls),
3 path("", views\&.index, name="index"),
4 path("download/<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 ]
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

33
docs/man/man3/pyShelf_src_frontend_wsgi.3 vendored Normal file
View File

@@ -0,0 +1,33 @@
.TH "pyShelf.src.frontend.wsgi" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.frontend.wsgi
.SH SYNOPSIS
.br
.PP
.SS "Variables"
.in +1c
.ti -1c
.RI "\fBapplication\fP = get_wsgi_application()"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
WSGI config for frontend project.
It exposes the WSGI callable as a module-level variable named ``application``.
For more information on this file, see
https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

24
docs/man/man3/pyShelf_src_interface_apps_InterfaceConfig.3 vendored Normal file
View File

@@ -0,0 +1,24 @@
.TH "pyShelf.src.interface.apps.InterfaceConfig" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.interface.apps.InterfaceConfig
.SH SYNOPSIS
.br
.PP
.PP
Inherits AppConfig\&.
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "string \fBname\fP = 'interface'"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

61
docs/man/man3/pyShelf_src_interface_migrations_0001_initial_Migration.3 vendored Normal file
View File

@@ -0,0 +1,61 @@
.TH "pyShelf.src.interface.migrations.0001_initial.Migration" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.interface.migrations.0001_initial.Migration
.SH SYNOPSIS
.br
.PP
.PP
Inherits Migration\&.
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "bool \fBinitial\fP = True"
.br
.ti -1c
.RI "list \fBdependencies\fP = []"
.br
.ti -1c
.RI "list \fBoperations\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Member Data Documentation"
.PP
.SS "list pyShelf\&.src\&.interface\&.migrations\&.0001_initial\&.Migration\&.operations\fC [static]\fP"
\fBInitial value:\fP
.PP
.nf
= [
migrations\&.CreateModel(
name="Books",
fields=[
(
"id",
models\&.AutoField(
auto_created=True,
primary_key=True,
serialize=False,
verbose_name="ID",
),
),
("title", models\&.CharField(max_length=255)),
("author", models\&.CharField(max_length=255, null=True)),
("categories", models\&.CharField(max_length=255, null=True)),
("cover", models\&.BinaryField(editable=True, null=True)),
("pages", models\&.IntegerField(null=True)),
("progress", models\&.IntegerField(null=True)),
("file_name", models\&.CharField(max_length=255)),
],
options={"db_table": "books",},
),
]
.fi
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

83
docs/man/man3/pyShelf_src_interface_models_Books.3 vendored Normal file
View File

@@ -0,0 +1,83 @@
.TH "pyShelf.src.interface.models.Books" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.interface.models.Books
.SH SYNOPSIS
.br
.PP
.PP
Inherits Model\&.
.SS "Classes"
.in +1c
.ti -1c
.RI "class \fBMeta\fP"
.br
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "def \fB__str__\fP (self)"
.br
.ti -1c
.RI "def \fBget_absolute_url\fP (self)"
.br
.in -1c
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "\fBtitle\fP = models\&.CharField(max_length=255)"
.br
.ti -1c
.RI "\fBauthor\fP = models\&.CharField(max_length=255, null=True)"
.br
.ti -1c
.RI "\fBcategories\fP = models\&.CharField(max_length=255, null=True)"
.br
.ti -1c
.RI "\fBcover\fP = models\&.BinaryField(null=True, editable=True)"
.br
.ti -1c
.RI "\fBpages\fP = models\&.IntegerField(null=True)"
.br
.ti -1c
.RI "\fBprogress\fP = models\&.IntegerField(null=True)"
.br
.ti -1c
.RI "\fBfile_name\fP = models\&.CharField(max_length=255, null=False)"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
pyShelfs Book Database class
:param title: Book title
:param author: Author
:param categories: Categories <-- Not implemented
:param cover: Cover image BinaryField
:param pages: # of pages <-- Not implemented
:param progress: Reader percentage <-- Not implented
:param file_name: Path to book
.fi
.PP
.SH "Member Function Documentation"
.PP
.SS "def pyShelf\&.src\&.interface\&.models\&.Books\&.get_absolute_url ( self)"
.PP
.nf
Returns the url to access a particular instance of MyModelName.
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

22
docs/man/man3/pyShelf_src_interface_models_Books_Meta.3 vendored Normal file
View File

@@ -0,0 +1,22 @@
.TH "pyShelf.src.interface.models.Books.Meta" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.interface.models.Books.Meta
.SH SYNOPSIS
.br
.PP
.SS "Static Public Attributes"
.in +1c
.ti -1c
.RI "string \fBdb_table\fP = 'books'"
.br
.in -1c
.SH "Detailed Description"
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.

27
docs/man/man3/pyShelf_src_manage.3 vendored Normal file
View File

@@ -0,0 +1,27 @@
.TH "pyShelf.src.manage" 3 "Sun Dec 1 2019" "Version 0.2.1" "pyShelf Open Source Ebook Server" \" -*- nroff -*-
.ad l
.nh
.SH NAME
pyShelf.src.manage
.SH SYNOPSIS
.br
.PP
.SS "Functions"
.in +1c
.ti -1c
.RI "def \fBmain\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP
.PP
.nf
Django's command-line utility for administrative tasks.
.fi
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for pyShelf Open Source Ebook Server from the source code\&.