diff --git a/README.md b/README.md index 63e3590..b8ab274 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pyShelf 0.4.0 +# pyShelf 0.4.1

Terminal based ebook server. Open source & Lightweight.

@@ -6,6 +6,8 @@ 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. +### Join the discussion: Discord [https://discord.gg/H9TbNJS](https://discord.gg/H9TbNJS) | IRC freenode.net @ #pyshelf + ## Current Features * Custom Installer * Recursive Scanning @@ -23,6 +25,10 @@ Having used Calibre for hosting my eBook collection in the past, I found myself ## Further Installation & Support Information * [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md) +## 0.4.1 Patch Notes. +### Filename detection +Now using os.path.splitext to ensure proper formating of downloaded files + ## 0.4.0 Patch Notes. ### The Installer Initiative @@ -36,18 +42,6 @@ process is listed in the process list. At this time I would suggest stopping both your postgresql and nginx servers should you already have them and allowing the installer to do its work generating custom configurations and putting the nginx config files in place (/etc/nginx/sites-available, and symlinked to /etc/nginx/sites-enabled/) None of your existing configurations will be overwritten. -## 0.3.0 Patch Notes. -### "And now we search." - -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 * [`pre-commit`](https://pre-commit.com/) diff --git a/config.json b/config.json index 18a02eb..b83d7e3 100644 --- a/config.json +++ b/config.json @@ -1 +1 @@ -{"TITLE": "pyShelf E-Book Server", "VERSION": "0.3.0", "BOOKPATH": "/home/raelon/Books", "DB_HOST": "localhost", "DB_PORT": "5432", "DATABASE": "pyshelf", "USER": "pyshelf", "PASSWORD": "pyshelf", "BOOKSHELF": "data/shelf.json", "ALLOWED_HOSTS": "*", "hostname": "localhost", "webport": "8000", "wsgiport": "8001"} +{"TITLE": "pyShelf E-Book Server", "VERSION": "0.4.1", "BOOKPATH": "", "DB_HOST": "localhost", "DB_PORT": "5432", "DATABASE": "pyshelf", "USER": "pyshelf", "PASSWORD": "pyshelf", "BOOKSHELF": "data/shelf.json", "ALLOWED_HOSTS": "*", "hostname": "localhost", "webport": "8000", "wsgiport": "8001"} diff --git a/docs/html/HTML/D/index.html b/docs/html/HTML/D/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/D/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/FILEMAP b/docs/html/HTML/FILEMAP deleted file mode 100644 index e69de29..0000000 diff --git a/docs/html/HTML/GTAGSROOT b/docs/html/HTML/GTAGSROOT deleted file mode 100644 index c725022..0000000 --- a/docs/html/HTML/GTAGSROOT +++ /dev/null @@ -1 +0,0 @@ -/home/raelon/Projects/pyShelf/src/backend diff --git a/docs/html/HTML/I/index.html b/docs/html/HTML/I/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/I/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/J/index.html b/docs/html/HTML/J/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/J/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/R/index.html b/docs/html/HTML/R/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/R/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/S/index.html b/docs/html/HTML/S/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/S/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/Y/index.html b/docs/html/HTML/Y/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/Y/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/defines.html b/docs/html/HTML/defines.html deleted file mode 100644 index ff101d5..0000000 --- a/docs/html/HTML/defines.html +++ /dev/null @@ -1,13 +0,0 @@ - - - -DEFINITIONS - - - - - - -

DEFINITIONS

- - diff --git a/docs/html/HTML/defines/index.html b/docs/html/HTML/defines/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/defines/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/files.html b/docs/html/HTML/files.html deleted file mode 100644 index a63dd8b..0000000 --- a/docs/html/HTML/files.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -FILES - - - - - - -

FILES

-
    -
- - diff --git a/docs/html/HTML/files/index.html b/docs/html/HTML/files/index.html deleted file mode 100644 index f931715..0000000 --- a/docs/html/HTML/files/index.html +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/html/HTML/help.html b/docs/html/HTML/help.html deleted file mode 100644 index 45bafb4..0000000 --- a/docs/html/HTML/help.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -HELP - - - - - - -

Usage of Links

-
/* [<][>][^][v][top][bottom][index][help] */
-
-
[<]
Previous definition.
-
[>]
Next definition.
-
[^]
First definition in this file.
-
[v]
Last definition in this file.
-
[top]
Top of this file.
-
[bottom]
Bottom of this file.
-
[index]
Return to index page.
-
[help]
You are seeing now.
-
- - diff --git a/docs/html/HTML/index.html b/docs/html/HTML/index.html deleted file mode 100644 index 4fe4f22..0000000 --- a/docs/html/HTML/index.html +++ /dev/null @@ -1,28 +0,0 @@ - - - -pyShelf Open Source Ebook Server-0.4.0 - - - - - - -

pyShelf Open Source Ebook Server-0.4.0

-
-Last updated Wed Jan 01 09:54:41 EST 2020
-Powered by GLOBAL-6.6.3.
-
-
-

MAINS

-
-
-
-

DEFINITIONS

-
-

FILES

-
    -
-
- - diff --git a/docs/html/HTML/mains.html b/docs/html/HTML/mains.html deleted file mode 100644 index 4fe4f22..0000000 --- a/docs/html/HTML/mains.html +++ /dev/null @@ -1,28 +0,0 @@ - - - -pyShelf Open Source Ebook Server-0.4.0 - - - - - - -

pyShelf Open Source Ebook Server-0.4.0

-
-Last updated Wed Jan 01 09:54:41 EST 2020
-Powered by GLOBAL-6.6.3.
-
-
-

MAINS

-
-
-
-

DEFINITIONS

-
-

FILES

-
    -
-
- - diff --git a/docs/html/HTML/rebuild.sh b/docs/html/HTML/rebuild.sh deleted file mode 100644 index c9ea341..0000000 --- a/docs/html/HTML/rebuild.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/sh -# -# rebuild.sh: rebuild hypertext with the previous context. -# -# Usage: -# % sh rebuild.sh -# -cd /home/raelon/Projects/pyShelf/src/backend && GTAGSCONF=':langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.hh.cpp.cxx.hxx.hpp.C.H,php\:.php.php3.phtml:skip=HTML/,HTML.pub/,tags,TAGS,ID,y.tab.c,y.tab.h,gtags.files,cscope.files,cscope.out,cscope.po.out,cscope.in.out,SCCS/,RCS/,CVS/,CVSROOT/,{arch}/,autom4te.cache/,*.orig,*.rej,*.bak,*~,#*#,*.swp,*.tmp,*_flymake.*,*_flymake,*.o,*.a,*.so,*.lo,*.zip,*.gz,*.bz2,*.xz,*.lzh,*.Z,*.tgz,*.min.js,*min.css:' htags -g -s -a -n -v -w -t 'pyShelf Open Source Ebook Server-0.4.0' /home/raelon/Projects/pyShelf/docs/html diff --git a/docs/html/HTML/style.css b/docs/html/HTML/style.css deleted file mode 100755 index d7db34a..0000000 --- a/docs/html/HTML/style.css +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Copyright (c) 2005, 2010, 2011 Tama Communications Corporation - * - * This file is free software; as a special exception the author gives - * unlimited permission to copy and/or distribute it, with or without - * modifications, as long as this notice is preserved. - * - * This program is distributed in the hope that it will be useful, but - * WITHOUT ANY WARRANTY, to the extent permitted by law; without even the - * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. - */ -/* - * Souce code - */ -body { color: #191970; background-color: #f5f5dc; } -a.visited { color: gray; } -.title { color: #cc0000; } -.poweredby { text-align: right; } -.error { color: red; } -.loading { color: white; background-color: red; } -.cvs { font-size: 90%; } -.caution { text-align: center; margin: 1em 40px; } -img.icon { vertical-align: top; border: 0; } -.curline:hover { background-color:lightgray; } -table.flist { border-spacing: 2px; width: 100%; } -/* - * Parts - */ -em { font-style: normal; } -em.comment { color: green; font-style: italic; } -em.sharp { color: #8b0000; } -em.brace { color: red; } -em.warned { background-color: yellow; } -em.string { text-decoration: underline; } -strong.reserved { font-weight: bold; } -/* - * Tag list using table (--table-list) - */ -th, td { white-space: nowrap; } -th.tag { text-align: left; } -th.line { text-align: right; } -th.file { text-align: left; } -th.code { text-align: left; } -td.tag { text-align: left; } -td.line { text-align: right; } -td.file { text-align: left; } -td.code { text-align: left; } -/* end of TAG LIST */ -/* - * Fixed guide (--fixed-guide) - */ -#guide { - height: 35px; - position: fixed; - bottom:0px; left:0px; right:0px; - background: #f5f5dc; - border: 1px solid #ccc; -} -#guide ul { - height: 25px; - margin: 5px; - width: 90%; -} -#guide ul li { - float: left; - display: inline; - margin: 1px 1px; -} -#guide a { - line-height: 24px; -} -#guide ul li.standout span { - margin: 0px 4px; - font-size: 115%; - font-weight: bold; -} -/* end of FIXED GUIDE */ diff --git a/docs/html/annotated.html b/docs/html/annotated.html index fa4ac12..f099159 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: Class List @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
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 deleted file mode 100644 index b859d5b..0000000 --- a/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - -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/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html index 626db33..2991047 100644 --- a/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html +++ b/docs/html/d1/dca/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: Member List @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.lib.storage.Storage Class Reference
-
-
- - - - - - - - - - - - - - -

-Public Member Functions

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

-Public Attributes

- sql
 
- user
 
- password
 
- db_host
 
- db_port
 
- db
 
- cursor
 
-

Detailed Description

-
Contains all methods for system storage

Member Function Documentation

- -

◆ book_paths_list()

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

◆ close()

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

◆ commit()

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

◆ create_tables()

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

◆ insert_book()

- -
-
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.storage.Storage.insert_book ( self,
 book 
)
-
-
Insert book in database
-:returns: True if succeeds False if not
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d2/dd1/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 deleted file mode 100644 index 7ad638a..0000000 --- a/docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html +++ /dev/null @@ -1,206 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.lib.pyShelf.BookDisplay Class Reference
-
-
- - - - - - - - - - -

-Public Member Functions

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

-Public Attributes

- books_per_page
 
- current_page
 
- thumbnail_size
 
- thumbnail_scale
 
- total_pages
 
- screen_size
 
-

Detailed Description

-
All functions related to displaying book information in the HTML UI

Constructor & Destructor Documentation

- -

◆ __init__()

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

Member Function Documentation

- -

◆ booksPerPage()

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

◆ nextPage()

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

◆ previousPage()

- -
-
- - - - - - - - -
def pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage ( self)
-
-
## TODO Remove me
-Goto previous book page
-:return: new current_page
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html b/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html index d4e8a48..585ec70 100644 --- a/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html +++ b/docs/html/d3/d29/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.tests.library_test.Test_Config Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Static Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.lib.library.Catalogue Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.backend.lib.library.Catalogue:
-
-
- - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

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

-Static Public Member Functions

def process_book (book)
 
- - - - - - - - - - - - - - - - - - - - - -

-Public Attributes

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

Detailed Description

-
Decodes book metadata for storage
-

Member Function Documentation

- -

◆ compare_shelf_current()

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

◆ extract_content()

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

◆ extract_cover_html()

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

◆ extract_cover_image()

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

◆ extract_metadata()

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

◆ filter_books()

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

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

- -
-
- -

◆ import_books()

- -
-
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.library.Catalogue.import_books ( self,
 list = None 
)
-
-
Main entry point for import operations.
-Gets a list of new files via compare_shelf_current.
-Iterates over list and inserts new books into database.
-
-
-
- -

◆ process_book()

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

◆ scan_folder()

- -
-
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.library.Catalogue.scan_folder ( self,
 _path = None 
)
-
-
Scan folder by _path, allows recurisive scanning
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d4/d49/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 deleted file mode 100644 index 9198213..0000000 Binary files a/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png and /dev/null differ diff --git a/docs/html/d4/d5d/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 deleted file mode 100644 index e713b7a..0000000 --- a/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html +++ /dev/null @@ -1,462 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Static Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.tests.library_test.Test_Catalogue Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Catalogue:
-
-
- - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

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

-Static Public Member Functions

def process_book (book)
 
- - - - - - - - - - - - - - - - - - - - - -

-Public Attributes

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

Detailed Description

-

Member Function Documentation

- -

◆ compare_shelf_current()

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

◆ extract_content()

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

◆ extract_cover_html()

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

◆ extract_cover_image()

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

◆ extract_metadata()

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

◆ filter_books()

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

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

- -
-
- -

◆ import_books()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.library.Catalogue.import_books ( self,
 list = None 
)
- 		-inherited
-
-
Main entry point for import operations.
-Gets a list of new files via compare_shelf_current.
-Iterates over list and inserts new books into database.
-
-
-
- -

◆ process_book()

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

◆ scan_folder()

- -
-
- - - - - -
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.library.Catalogue.scan_folder ( self,
 _path = None 
)
- 		-inherited
-
-
Scan folder by _path, allows recurisive scanning
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d4/d5d/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 deleted file mode 100644 index 33ae867..0000000 Binary files a/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png and /dev/null differ 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 deleted file mode 100644 index bea88e3..0000000 --- a/docs/html/d5/d74/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.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/d5/d85/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 deleted file mode 100644 index 19ce362..0000000 --- a/docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Static Public Attributes | -List of all members
-
-
pyShelf.src.backend.tests.library_test.TestCatalogue Class Reference
-
-
- - - - -

-Public Member Functions

-def test_filter_books (self)
 
- - - - - -

-Static Public Attributes

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

Detailed Description

-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html b/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html index ee4ff15..9ed75d7 100644 --- a/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html +++ b/docs/html/d5/da5/classsrc_1_1backend_1_1lib_1_1library_1_1Catalogue.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.lib.library.Catalogue Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.tests.library_test.Test_Config Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.backend.tests.library_test.Test_Config:
-
-
- - - - - - - -

-Public Member Functions

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

-Public Attributes

- book_path
 
- TITLE
 
- VERSION
 
- book_shelf
 
- catalogue_db
 
- user
 
- password
 
- db_host
 
- db_port
 
- file_array
 
- root
 
- auto_scan
 
-

Detailed Description

-

Member Function Documentation

- -

◆ open_file()

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

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

- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d7/d46/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 deleted file mode 100644 index f564331..0000000 Binary files a/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png and /dev/null differ diff --git a/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html index 7432d9d..6d7ecaa 100644 --- a/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html +++ b/docs/html/d7/d69/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: Member List @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
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/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html b/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html index e86078a..cb4e721 100644 --- a/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +++ b/docs/html/d7/d88/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.lib.api_hooks.DuckDuckGo Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.lib.config.Config Class Reference
-
-
-
- + Inheritance diagram for pyShelf.src.backend.lib.config.Config:
-
-
- - - - - - - -

-Public Member Functions

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

-Public Attributes

- book_path
 
- TITLE
 
- VERSION
 
- book_shelf
 
- catalogue_db
 
- user
 
- password
 
- db_host
 
- db_port
 
- file_array
 
- root
 
- auto_scan
 
-

Detailed Description

-
Main System Configuration
-

Constructor & Destructor Documentation

- -

◆ __init__()

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

Member Function Documentation

- -

◆ open_file()

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

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

- -
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/d7/dc4/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 deleted file mode 100644 index b7d4d5a..0000000 Binary files a/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png and /dev/null differ diff --git a/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html b/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html index c978887..0bf38c5 100644 --- a/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html +++ b/docs/html/d8/d3d/classsrc_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.tests.library_test.TestCatalogue Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
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/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html b/docs/html/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html index 50ebda1..6c7ab61 100644 --- a/docs/html/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html +++ b/docs/html/da/d3c/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.InitFiles Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-
pyShelf.src.backend.lib.pyShelf.InitFiles Member List
-
-
- -

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
- -
-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/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html b/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html index fcbeb4b..c80f7b9 100644 --- a/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html +++ b/docs/html/db/d7d/classsrc_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.lib.pyShelf.BookDisplay Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
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/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html b/docs/html/dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html index 921410a..1ec875b 100644 --- a/docs/html/dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html +++ b/docs/html/dc/d3e/classsrc_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: Member List @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
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/dd/d4a/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 deleted file mode 100644 index de26674..0000000 --- a/docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Public Attributes | -List of all members
-
-
pyShelf.src.backend.lib.api_hooks.DuckDuckGo Class Reference
-
-
- - - - - - -

-Public Member Functions

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

-Public Attributes

- url
 
-

Detailed Description

-
duckduckgo related searching

Member Function Documentation

- -

◆ image_result()

- -
-
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result ( self,
 query 
)
-
-
Returns json containing url to image
-:param _key: &t=h_&iar=images&iax=images&ia=images&format=json&pretty=1
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/dd/d7e/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 deleted file mode 100644 index af54bd7..0000000 --- a/docs/html/dd/d7e/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - - -pyShelf Open Source Ebook Server: pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference - - - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -List of all members
-
-
pyShelf.src.backend.lib.pyShelf.InitFiles Class Reference
-
-
- - - - - - -

-Public Member Functions

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

Detailed Description

-
First run file creation operations

Member Function Documentation

- -

◆ CreateFile()

- -
-
- - - - - - - - - - - - - - - - - - -
def pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile ( self,
 _pointer 
)
-
-
Checks if file exists and creates it if not
-
-
-
-
The documentation for this class was generated from the following file: -
- -
-Generated on 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 deleted file mode 100644 index d0abc73..0000000 --- a/docs/html/dd/df1/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.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 deleted file mode 100644 index e448586..0000000 --- a/docs/html/dd/df7/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.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/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html index 55b343e..0a29e3e 100644 --- a/docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html +++ b/docs/html/de/d11/classsrc_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: Member List @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - + - - - - -
-
- - - - - - -
-
pyShelf Open Source Ebook Server -  0.3.0 -
-
Open source, console based E-book server
-
-
- - - - - - - -
-
-
-Public Member Functions | -Static Public Attributes | -List of all members
-
-
pyShelf.src.backend.tests.config_test.TestConfig Class Reference
-
-
- - - - - - - - -

-Public Member Functions

-def test_book_dir (self)
 
-def test_title (self)
 
-def test_version (self)
 
- - - -

-Static Public Attributes

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

Detailed Description

-
The documentation for this class was generated from the following file: -
- -
-Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by   -doxygen - 1.8.16 -
- - diff --git a/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html b/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html index bc28bae..2a36542 100644 --- a/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html +++ b/docs/html/df/d83/classsrc_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html @@ -3,7 +3,7 @@ - + pyShelf Open Source Ebook Server: src.backend.tests.config_test.TestConfig Class Reference @@ -19,7 +19,7 @@
pyShelf Open Source Ebook Server -  0.4.0 +  0.4.1
Open source, console based E-book server
@@ -28,7 +28,7 @@ - +