diff --git a/.gitignore b/.gitignore index 52ee07a..b255847 100755 --- a/.gitignore +++ b/.gitignore @@ -4,13 +4,14 @@ books/* *.pyc app/content.opf .vscode -app/data/* fontend/db.sqlite3 GPATH GRTAGS GTAGS +data/shelf.json .#* frontend/interface/migrations/* +src/backend/data/*.json # Standard Python gitignore below # Created by https://www.gitignore.io/api/python # Edit at https://www.gitignore.io/?templates=python @@ -122,3 +123,4 @@ dmypy.json .pyre/ # End of https://www.gitignore.io/api/python +0 diff --git a/README.md b/README.md index d22f8cf..1aef713 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,68 @@ -# pyShelf 0.2.1 -## Patch Notes. -* fixed missing src/interface/models.py. thanks to u/thelastpenguin212 -* Removed un necessary data files from repo +# pyShelf 0.3.0 -
A simple terminal based ebook server
+Terminal based ebook server. Open source & Lightweight.
+ +Having used Calibre for hosting my eBook collection in the past, I found myself frustrated having to install X on my server, or manage my library externally, Thus I have decided to spin up my own. + +## Current Features +* Recursive Scanning +* Fast database access +* Django based frontend +* Basic seaching via a SearchVector of author, title, & file_name fields. + +## Currently Supported Formats +* epub + +## Installation Example
-Frustrated with Calibre being my only option for hosting my eBook collection, I have decided to spin up my own.
+## 0.3.0 Patch Notes.
+### "And now we search."
-Calibre is a great organizational tool for your books, however not having a terminal based option for running and maintaining
-a server is cumbersome when running on a headless server.
-Calibre does have a console based server solution, However there is currently no way to create, and manage your library in a headless enviroment.
-
-Thus I am creating pyShelf and I hope to be able to provide all the functionality required to organize and host all your ebooks.
-
-I am open to and hoping for community help in the design and execution of this program.
+Just about all the changes in this release were in some way related to implementing the search features.
+There is one new requirement
+* Requirement: **PostgreSQL**
+*This is what I believe to be the last infrastructure requirement, users with larger libraries should notice an increase in access speed.*
+* Feature: **Searching**
+*The search feature is now implemented. In its current incarnation you will by default search the author, title, & file_name fields. More defined search options will be available in future releases. Searches are paginated @ 20 results per page.*
+* Discord [https://discord.gg/H9TbNJS](https://discord.gg/H9TbNJS)
+* IRC find us on freenode.net @ #pyshelf
## Development
-pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks.
-Before developing, run `pre-commit install`.
-See the [documentation](https://pre-commit.com/) for more information.
+* [`pre-commit`](https://pre-commit.com/)
+_Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._
-pyShelf uses ['Doxygen'](http://www.doxygen.nl/) for source code documentation.
-Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting.
+* ['Doxygen'](http://www.doxygen.nl/)
+_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._
-pyShelf follows ['sem-ver'](https://semver.org) standards. Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly.
+* ['sem-ver'](https://semver.org)
+_Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._
## Configuration
-All pyShelf configuration is done in config.py.
-### Nginx configuration
-I have included a default nginx config file pyshelf_nginx.conf. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact.
+### Nginx
+Included is a default nginx config file {pyshelf_nginx.conf}. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact.
Further resources for nginx setup may be found @ [This nginx, django, & uwsgi, guide](https://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html)
-### uwsgi configuration
+### uwsgi
Inside uwsgi.ini you should make changes to reflect your install directory, and the port you wish uwsgi to listen on. Alternativly you can make the requisite changes to listen on a socket instead. This change would also require a change to the pyshelf_nginx.conf file as well.
-### pyShelf configuration
-User configuration is contained within config.json in the project root. The only currently required configuration is to set book_path to the location of your books.
+### pyShelf
+User configuration is contained within config.json in the project root. You must set book_path to the location of your books, and change the database connection details to match your environment.
-## Current Features
-Currently pyShelf will recursively scan your collection, extract and store some metadata in the sqlite database. It will also provide you with a web based frontend to view and download your books. Note that this is a very early alpha and lacking the ability to sort and search your collection. This feature is coming however.
-
-Django has been implemented to power the frontend experience, and web based database maintenance. The first steps of which are included in this commit. Also the book database has been switched over to reflect this. A properly configured web server is required for hosting the frontend, configuration of which is outside of the scope of this readme. Running via the Django test server might be possible, albeit not recomended.
-
-## New in 0.2.0
-* UI
- * The UI has moved closer to what I have envisioned for this project, however more features and changes will be coming as needed to both the form and function.
-* UX
- * Results have now been limited to 20 per page. Currently this is hardcoded in however in the future it will be user definable.
- * Previous page & next page buttons have been implemented, and are working.
+## Misc
+Django has been implemented to power the frontend experience, and web based database maintenance. A properly configured web server is required for hosting the frontend, and a PostgreSQL server for the database, configuration of these servers is outside of the scope of this readme.
+Running via the Django test server might be possible, albeit not recomended.
## In Progress
-* UI/UX tweaks, including making the book display responsive. and not so ugly.
* Searching, & further organizational tools.
+* Docker image for those who need it.
* Improved cover image storage, and acquisition.
## Future Goals
@@ -66,6 +70,4 @@ Django has been implemented to power the frontend experience, and web based data
* Terminal Backend for catalogue maintenance
* Calculate page count from total characters
* (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3
-* Move towards sqlAlchemy and enable user to specify desired storage system
- * (Thanks to Sarcism) over on r/opensource for this idea!
-* Android app for easy integration with your catalogue
+* Reader for easy integration with your catalogue
diff --git a/config.json b/config.json
index f89c692..77f2b02 100644
--- a/config.json
+++ b/config.json
@@ -1,7 +1,11 @@
{
"TITLE": "pyShelf E-Book Server",
- "VERSION": "0.2.0",
+ "VERSION": "0.3.0",
"BOOKPATH": "books/",
- "DATABASE": "src/db.sqlite3",
+ "DB_HOST": "localhost",
+ "DB_PORT": "5432",
+ "DATABASE": "pyshelf",
+ "USER": "pyshelf",
+ "PASSWORD": "pyshelf",
"BOOKSHELF": "data/shelf.json"
}
diff --git a/data/.track_me b/data/.track_this_folder
similarity index 100%
rename from data/.track_me
rename to data/.track_this_folder
diff --git a/docs/html/HTML/D/index.html b/docs/html/HTML/D/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/FILEMAP b/docs/html/HTML/FILEMAP
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/GTAGSROOT b/docs/html/HTML/GTAGSROOT
old mode 100755
new mode 100644
index 3da86ee..c725022
--- a/docs/html/HTML/GTAGSROOT
+++ b/docs/html/HTML/GTAGSROOT
@@ -1 +1 @@
-/home/raelon/Projects/pyShelf
+/home/raelon/Projects/pyShelf/src/backend
diff --git a/docs/html/HTML/I/index.html b/docs/html/HTML/I/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/J/index.html b/docs/html/HTML/J/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/R/index.html b/docs/html/HTML/R/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/S/index.html b/docs/html/HTML/S/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/Y/index.html b/docs/html/HTML/Y/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/defines.html b/docs/html/HTML/defines.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/defines/index.html b/docs/html/HTML/defines/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/files.html b/docs/html/HTML/files.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/files/index.html b/docs/html/HTML/files/index.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/help.html b/docs/html/HTML/help.html
old mode 100755
new mode 100644
diff --git a/docs/html/HTML/index.html b/docs/html/HTML/index.html
old mode 100755
new mode 100644
index 1fc2c79..c610c6b
--- a/docs/html/HTML/index.html
+++ b/docs/html/HTML/index.html
@@ -1,16 +1,16 @@
-| ▼Napp | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Nconfig | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CConfig | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Nlib | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Napi_hooks | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CDuckDuckGo | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Ndisplay | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CFrontend | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Nlibrary | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CCatalogue | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼NpyShelf | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CBookDisplay | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CBookServer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CInitFiles | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CRequestHandler | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼Nstorage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CStorage | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▼NpyShelf | |
| ▼Nsrc | |
| ▼Nbackend | |
| ▼Nlib | |
| ▼Napi_hooks | |
| CDuckDuckGo | |
| ▼Nconfig | |
| CConfig | |
| ▼Nlibrary | |
| CCatalogue | |
| ▼NpyShelf | |
| CBookDisplay | |
| CInitFiles | |
| ▼Nstorage | |
| CStorage | |
| ▼Ntests | |
| ▼Nconfig_test | |
| CTestConfig | |
| ▼Nlibrary_test | |
| CTest_Catalogue | |
| CTest_Config | |
| CTestCatalogue |
1.8.16
diff --git a/docs/html/bc_s.png b/docs/html/bc_s.png
old mode 100755
new mode 100644
diff --git a/docs/html/bdwn.png b/docs/html/bdwn.png
old mode 100755
new mode 100644
diff --git a/docs/html/classapp_1_1config_1_1Config-members.html b/docs/html/classapp_1_1config_1_1Config-members.html
deleted file mode 100755
index 0a78d67..0000000
--- a/docs/html/classapp_1_1config_1_1Config-members.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.config.Config, including all inherited members.
-| __init__(self) (defined in app.config.Config) | app.config.Config | |
| auto_scan (defined in app.config.Config) | app.config.Config | |
| book_path (defined in app.config.Config) | app.config.Config | |
| book_shelf (defined in app.config.Config) | app.config.Config | |
| catalogue_db (defined in app.config.Config) | app.config.Config | |
| file_array (defined in app.config.Config) | app.config.Config | |
| TITLE (defined in app.config.Config) | app.config.Config |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1config_1_1Config.html b/docs/html/classapp_1_1config_1_1Config.html
deleted file mode 100755
index 044db30..0000000
--- a/docs/html/classapp_1_1config_1_1Config.html
+++ /dev/null
@@ -1,95 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| -def | __init__ (self) |
-Public Attributes | |
| - | book_path |
| - | TITLE |
| - | book_shelf |
| - | catalogue_db |
| - | file_array |
| - | auto_scan |
Main System Configuration
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html
deleted file mode 100755
index be81301..0000000
--- a/docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html
+++ /dev/null
@@ -1,65 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.api_hooks.DuckDuckGo, including all inherited members.
-| __init__(self) (defined in app.lib.api_hooks.DuckDuckGo) | app.lib.api_hooks.DuckDuckGo | |
| image_result(self, query) | app.lib.api_hooks.DuckDuckGo | |
| url (defined in app.lib.api_hooks.DuckDuckGo) | app.lib.api_hooks.DuckDuckGo |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html b/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html
deleted file mode 100755
index dfd3cbc..0000000
--- a/docs/html/classapp_1_1lib_1_1display_1_1Frontend-members.html
+++ /dev/null
@@ -1,70 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.display.Frontend, including all inherited members.
-| __init__(self, dimensions=[0, 0]) | app.lib.display.Frontend | |
| app_body(self, nav, shelf) | app.lib.display.Frontend | |
| app_footer(self) | app.lib.display.Frontend | |
| app_Headers(self) | app.lib.display.Frontend | |
| compile(self, nav, shelf) | app.lib.display.Frontend | |
| dimensions (defined in app.lib.display.Frontend) | app.lib.display.Frontend | |
| html_Headers(self) | app.lib.display.Frontend | |
| TITLE (defined in app.lib.display.Frontend) | app.lib.display.Frontend |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html b/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html
deleted file mode 100755
index e6e3239..0000000
--- a/docs/html/classapp_1_1lib_1_1display_1_1Frontend.html
+++ /dev/null
@@ -1,257 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| def | __init__ (self, dimensions=[0, 0]) |
| def | html_Headers (self) |
| def | app_Headers (self) |
| def | app_body (self, nav, shelf) |
| def | app_footer (self) |
| def | compile (self, nav, shelf) |
-Public Attributes | |
| - | dimensions |
| - | TITLE |
Dynamic frontend display functions
| def app.lib.display.Frontend.__init__ | -( | -- | self, | -
| - | - | - | dimensions = [0, 0] |
-
| - | ) | -- |
:param dimensions: array containing screen size [x, y] --
| def app.lib.display.Frontend.app_body | -( | -- | self, | -
| - | - | - | nav, | -
| - | - | - | shelf | -
| - | ) | -- |
Main interface body, and navigation
-:param nav: nav[] system navigation list
-:param shelf: shelf[0{path:"",title:"",cover:"",author:""}]
-:returns _body: HTML render of page body
-
-| def app.lib.display.Frontend.app_footer | -( | -- | self | ) | -- |
Main interface footer; Closes HTML -:returns _footer: HTML render of page footer --
| def app.lib.display.Frontend.app_Headers | -( | -- | self | ) | -- |
App specific headers -:returns _head: HTML render of application specific headers --
| def app.lib.display.Frontend.compile | -( | -- | self, | -
| - | - | - | nav, | -
| - | - | - | shelf | -
| - | ) | -- |
Compiles user interface -:returns _ui: Compiled HTML for page layout --
| def app.lib.display.Frontend.html_Headers | -( | -- | self | ) | -- |
HTML headers -:returns _head: HTML render of page headers --
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html
deleted file mode 100755
index e68e270..0000000
--- a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue-members.html
+++ /dev/null
@@ -1,78 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.library.Catalogue, including all inherited members.
-
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html b/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html
deleted file mode 100755
index f1886d7..0000000
--- a/docs/html/classapp_1_1lib_1_1library_1_1Catalogue.html
+++ /dev/null
@@ -1,229 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| -def | __init__ (self) |
| -def | scan_folder (self, folder=config.book_path) |
| def | scan_book (self, book) |
| def | filter_books (self) |
| def | process_book (self, book) |
| def | extract_metadata (self, book) |
| -def | extract_content (self, book_zip, book) |
| -def | extract_cover_html (self, book_zip, book) |
| -def | extract_cover_image (self, book_zip, book) |
| -def | compare_shelf_current (self) |
| -def | import_books (self, list=None) |
-Public Attributes | |
| - | file_list |
| - | opf_regx |
| - | cover_regx |
| - | html_regx |
| - | books |
Decodes and stores book information
Step One: filter_books
| def app.lib.library.Catalogue.extract_metadata | -( | -- | self, | -
| - | - | - | book | -
| - | ) | -- |
Return extracted metadata and cover picture -book['path'] == Full path to ebook file -book['files'] == list of files from self.process_book(book) --
| def app.lib.library.Catalogue.filter_books | -( | -- | self | ) | -- |
Scan book folder recursively for epub files - filter_books(0) -> Catalogue.books - filter_books(1) -> self.books[] - :param ret: 0 -> create class property -> dump json - :param ret: 1 -> create & return class property --
| def app.lib.library.Catalogue.process_book | -( | -- | self, | -
| - | - | - | book | -
| - | ) | -- |
Return dictionary of epub file contents-
| def app.lib.library.Catalogue.scan_book | -( | -- | self, | -
| - | - | - | book | -
| - | ) | -- |
REMOVE ME?-
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html
deleted file mode 100755
index 4553e03..0000000
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay-members.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.pyShelf.BookDisplay, including all inherited members.
-| __init__(self) | app.lib.pyShelf.BookDisplay | |
| books_per_page (defined in app.lib.pyShelf.BookDisplay) | app.lib.pyShelf.BookDisplay | |
| booksPerPage(self, screen_size) | app.lib.pyShelf.BookDisplay | |
| current_page (defined in app.lib.pyShelf.BookDisplay) | app.lib.pyShelf.BookDisplay | |
| nextPage(self) | app.lib.pyShelf.BookDisplay | |
| previousPage(self) | app.lib.pyShelf.BookDisplay | |
| thumbnail_scale (defined in app.lib.pyShelf.BookDisplay) | app.lib.pyShelf.BookDisplay | |
| thumbnail_size (defined in app.lib.pyShelf.BookDisplay) | app.lib.pyShelf.BookDisplay | |
| total_pages (defined in app.lib.pyShelf.BookDisplay) | app.lib.pyShelf.BookDisplay |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html
deleted file mode 100755
index e28a867..0000000
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookDisplay.html
+++ /dev/null
@@ -1,191 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| def | __init__ (self) |
| def | nextPage (self) |
| def | previousPage (self) |
| def | booksPerPage (self, screen_size) |
-Public Attributes | |
| - | books_per_page |
| - | current_page |
| - | thumbnail_size |
| - | thumbnail_scale |
| - | total_pages |
All functions related to displaying book information in the HTML UI
| def app.lib.pyShelf.BookDisplay.__init__ | -( | -- | self | ) | -- |
Initialize class variables -:return: None --
| def app.lib.pyShelf.BookDisplay.booksPerPage | -( | -- | self, | -
| - | - | - | screen_size | -
| - | ) | -- |
Set books per page - -:param screen_size: Array containing x,y pixel sizes -:return: self.books_per_page --
| def app.lib.pyShelf.BookDisplay.nextPage | -( | -- | self | ) | -- |
Goto next book page -:return: new current_page --
| def app.lib.pyShelf.BookDisplay.previousPage | -( | -- | self | ) | -- |
Goto previous book page -:return: new current_page --
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html
deleted file mode 100755
index 9521817..0000000
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer-members.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.pyShelf.BookServer, including all inherited members.
-| __init__(self) (defined in app.lib.pyShelf.BookServer) | app.lib.pyShelf.BookServer | |
| close(self) | app.lib.pyShelf.BookServer | |
| close_prompt(self) | app.lib.pyShelf.BookServer | |
| handler (defined in app.lib.pyShelf.BookServer) | app.lib.pyShelf.BookServer | |
| httpd (defined in app.lib.pyShelf.BookServer) | app.lib.pyShelf.BookServer | |
| run(self) | app.lib.pyShelf.BookServer | |
| server_address (defined in app.lib.pyShelf.BookServer) | app.lib.pyShelf.BookServer |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html
deleted file mode 100755
index 98764ae..0000000
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1BookServer.html
+++ /dev/null
@@ -1,148 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| -def | __init__ (self) |
| def | close_prompt (self) |
| def | run (self) |
| def | close (self) |
-Public Attributes | |
| - | server_address |
| - | handler |
| - | httpd |
HTTP server functions required to display e-books -
| def app.lib.pyShelf.BookServer.close | -( | -- | self | ) | -- |
Stop HTTP Server-
| def app.lib.pyShelf.BookServer.close_prompt | -( | -- | self | ) | -- |
Prompt to close server-
| def app.lib.pyShelf.BookServer.run | -( | -- | self | ) | -- |
Start HTTP Server-
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html b/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html
deleted file mode 100755
index def0079..0000000
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.html
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
Inheritance diagram for app.lib.pyShelf.RequestHandler:-Public Member Functions | |
| -def | do_GET (self) |
-Public Attributes | |
| - | path |
Request Handler
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png b/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png
deleted file mode 100755
index 1dc1265..0000000
Binary files a/docs/html/classapp_1_1lib_1_1pyShelf_1_1RequestHandler.png and /dev/null differ
diff --git a/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html
deleted file mode 100755
index 130aa15..0000000
--- a/docs/html/classapp_1_1lib_1_1storage_1_1Storage-members.html
+++ /dev/null
@@ -1,72 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
This is the complete list of members for app.lib.storage.Storage, including all inherited members.
-| __init__(self) (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| book_paths_list(self) (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| close(self) (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| commit(self) (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| create_tables(self) | app.lib.storage.Storage | |
| cursor (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| database(self) | app.lib.storage.Storage | |
| db (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| db_file (defined in app.lib.storage.Storage) | app.lib.storage.Storage | |
| insert_book(self, book) | app.lib.storage.Storage |
- 1.8.16
-
-
-
diff --git a/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html b/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html
deleted file mode 100755
index 5e4c61f..0000000
--- a/docs/html/classapp_1_1lib_1_1storage_1_1Storage.html
+++ /dev/null
@@ -1,168 +0,0 @@
-
-
-
-
-
-
-
-|
- pyShelf Open Source Ebook Server
- 0.1.0
-
- Open source, console based E-book server
- |
-
-Public Member Functions | |
| -def | __init__ (self) |
| def | database (self) |
| def | create_tables (self) |
| def | insert_book (self, book) |
| -def | book_paths_list (self) |
| -def | commit (self) |
| -def | close (self) |
-Public Attributes | |
| - | db_file |
| - | db |
| - | cursor |
Contains all methods for system storage
| def app.lib.storage.Storage.create_tables | -( | -- | self | ) | -- |
Create table structure-
| def app.lib.storage.Storage.database | -( | -- | self | ) | -- |
Create database cursor-
| def app.lib.storage.Storage.insert_book | -( | -- | self, | -
| - | - | - | book | -
| - | ) | -- |
Insert book in database -:returns: True if succeeds False if not --
- 1.8.16
-
-
-
diff --git a/docs/html/classes.html b/docs/html/classes.html
old mode 100755
new mode 100644
index 5d9cb4e..98d2ccf
--- a/docs/html/classes.html
+++ b/docs/html/classes.html
@@ -19,7 +19,7 @@
|
-Config (app.config) | -
|
+Config (pyShelf.src.backend.lib.config) |
|
+Test_Config (pyShelf.src.backend.tests.library_test) | |||
|
+TestCatalogue (pyShelf.src.backend.tests.library_test) | |||||||
| BookDisplay (app.lib.pyShelf) | -InitFiles (app.lib.pyShelf) | -Storage (app.lib.storage) | +||||||
| BookDisplay (pyShelf.src.backend.lib.pyShelf) | +Storage (pyShelf.src.backend.lib.storage) | +TestConfig (pyShelf.src.backend.tests.config_test) | ||||||
| BookServer (app.lib.pyShelf) | -DuckDuckGo (app.lib.api_hooks) | -
|
-||||||
|
-
| DuckDuckGo (pyShelf.src.backend.lib.api_hooks) | +
|
|||||
| RequestHandler (app.lib.pyShelf) | +||||||||
|
||||||||
| Catalogue (app.lib.library) | -Frontend (app.lib.display) | +|||||||
| Catalogue (pyShelf.src.backend.lib.library) | +Test_Catalogue (pyShelf.src.backend.tests.library_test) | +|||||||
| InitFiles (pyShelf.src.backend.lib.pyShelf) | ||||||||
1.8.16
diff --git a/docs/html/closed.png b/docs/html/closed.png
old mode 100755
new mode 100644
diff --git a/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html b/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html
new file mode 100644
index 0000000..525af54
--- /dev/null
+++ b/docs/html/d1/d06/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config-members.html
@@ -0,0 +1,76 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
This is the complete list of members for pyShelf.src.backend.lib.config.Config, including all inherited members.
+
+ 1.8.16
+
+
+
diff --git a/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html b/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html
new file mode 100644
index 0000000..b859d5b
--- /dev/null
+++ b/docs/html/d1/d44/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config-members.html
@@ -0,0 +1,77 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
This is the complete list of members for pyShelf.src.backend.tests.library_test.Test_Config, including all inherited members.
+
+ 1.8.16
+
+
+
diff --git a/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html b/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html
new file mode 100644
index 0000000..5dd90d5
--- /dev/null
+++ b/docs/html/d2/d53/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage.html
@@ -0,0 +1,214 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
+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 |
Contains all methods for system storage
| def pyShelf.src.backend.lib.storage.Storage.book_paths_list | +( | ++ | self | ) | ++ |
Get file paths from database for comparison to system files ++
| def pyShelf.src.backend.lib.storage.Storage.close | +( | ++ | self | ) | ++ |
Close database connection ++
| def pyShelf.src.backend.lib.storage.Storage.commit | +( | ++ | self | ) | ++ |
Commit database transactions ++
| def pyShelf.src.backend.lib.storage.Storage.create_tables | +( | ++ | self | ) | ++ |
Create table structure+
| def pyShelf.src.backend.lib.storage.Storage.insert_book | +( | ++ | self, | +
| + | + | + | book | +
| + | ) | ++ |
Insert book in database +:returns: True if succeeds False if not ++
+ 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
new file mode 100644
index 0000000..7ad638a
--- /dev/null
+++ b/docs/html/d2/dd1/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay.html
@@ -0,0 +1,206 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
+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 |
All functions related to displaying book information in the HTML UI
| def pyShelf.src.backend.lib.pyShelf.BookDisplay.__init__ | +( | ++ | self, | +
| + | + | ** | +kwargs | +
| + | ) | ++ |
Initialize class variables +:return: None ++
| 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 ++
| def pyShelf.src.backend.lib.pyShelf.BookDisplay.nextPage | +( | ++ | self | ) | ++ |
## TODO Remove me +Goto next book page +:return: new current_page ++
| def pyShelf.src.backend.lib.pyShelf.BookDisplay.previousPage | +( | ++ | self | ) | ++ |
## TODO Remove me +Goto previous book page +:return: new current_page ++
+ 1.8.16
+
+
+
diff --git a/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html
new file mode 100644
index 0000000..4327dbb
--- /dev/null
+++ b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.html
@@ -0,0 +1,407 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
Decodes book metadata for storage +
| 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 ++
| 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 ++
| 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 ++
| 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 ++
| 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) ++
| 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.
+ +| 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. ++
+
|
+ +static | +
Return dictionary of epub file contents+
| def pyShelf.src.backend.lib.library.Catalogue.scan_folder | +( | ++ | self, | +
| + | + | + | _path = None |
+
| + | ) | ++ |
Scan folder by _path, allows recurisive scanning ++
+ 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
new file mode 100644
index 0000000..9198213
Binary files /dev/null and b/docs/html/d4/d49/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue.png 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
new file mode 100644
index 0000000..e713b7a
--- /dev/null
+++ b/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.html
@@ -0,0 +1,462 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
+
|
+ +inherited | +
Calls storage system, gets list of books stored and compares against files on disk ++
+
|
+ +inherited | +
Opens epub as zip file filters then stores as list any files matching opf_regx ++
+
|
+ +inherited | +
Opens epub as zip file filters then stores as list any files matching html_regx ++
+
|
+ +inherited | +
Opens epub as zip file filters then stores as list any files matching cover_regx ++
+
|
+ +inherited | +
Return extracted metadata and cover picture +book['path'] == Full path to ebook file +book['files'] == list of files from self.process_book(book) ++
| 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.
+ +
+
|
+ +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. ++
+
|
+ +staticinherited | +
Return dictionary of epub file contents+
+
|
+ +inherited | +
Scan folder by _path, allows recurisive scanning ++
+ 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
new file mode 100644
index 0000000..33ae867
Binary files /dev/null and b/docs/html/d4/d5d/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue.png 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
new file mode 100644
index 0000000..bea88e3
--- /dev/null
+++ b/docs/html/d5/d74/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue-members.html
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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.TestCatalogue | static |
| root (defined in pyShelf.src.backend.tests.library_test.TestCatalogue) | pyShelf.src.backend.tests.library_test.TestCatalogue | static |
| test_filter_books(self) (defined in pyShelf.src.backend.tests.library_test.TestCatalogue) | pyShelf.src.backend.tests.library_test.TestCatalogue |
+ 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
new file mode 100644
index 0000000..19ce362
--- /dev/null
+++ b/docs/html/d5/d85/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1TestCatalogue.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
+Public Member Functions | |
| +def | test_filter_books (self) |
+Static Public Attributes | |
| + | root = os.path.abspath(os.path.curdir) |
| + | config = Test_Config() |
+ 1.8.16
+
+
+
diff --git a/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html
new file mode 100644
index 0000000..6520f9b
--- /dev/null
+++ b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.html
@@ -0,0 +1,158 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
| 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.
+ +
+ 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
new file mode 100644
index 0000000..f564331
Binary files /dev/null and b/docs/html/d7/d46/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Config.png differ
diff --git a/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html b/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html
new file mode 100644
index 0000000..d76ee83
--- /dev/null
+++ b/docs/html/d7/d7c/classpyShelf_1_1src_1_1backend_1_1tests_1_1library__test_1_1Test__Catalogue-members.html
@@ -0,0 +1,83 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
This is the complete list of members for pyShelf.src.backend.tests.library_test.Test_Catalogue, including all inherited members.
+
+ 1.8.16
+
+
+
diff --git a/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html
new file mode 100644
index 0000000..8cdaf01
--- /dev/null
+++ b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
Main System Configuration +
| def pyShelf.src.backend.lib.config.Config.__init__ | +( | ++ | self, | +
| + | + | + | root | +
| + | ) | ++ |
Initialize main configuration options ++
| 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.
+ +
+ 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
new file mode 100644
index 0000000..b7d4d5a
Binary files /dev/null and b/docs/html/d7/dc4/classpyShelf_1_1src_1_1backend_1_1lib_1_1config_1_1Config.png differ
diff --git a/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html b/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html
new file mode 100644
index 0000000..4fda3ab
--- /dev/null
+++ b/docs/html/da/d1e/classpyShelf_1_1src_1_1backend_1_1lib_1_1library_1_1Catalogue-members.html
@@ -0,0 +1,82 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
This is the complete list of members for pyShelf.src.backend.lib.library.Catalogue, including all inherited members.
+
+ 1.8.16
+
+
+
diff --git a/docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html
new file mode 100644
index 0000000..ce797d3
--- /dev/null
+++ b/docs/html/da/de5/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1InitFiles-members.html
@@ -0,0 +1,64 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
+ 1.8.16
+
+
+
diff --git a/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html b/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html
new file mode 100644
index 0000000..8069a15
--- /dev/null
+++ b/docs/html/dc/d11/classpyShelf_1_1src_1_1backend_1_1lib_1_1storage_1_1Storage-members.html
@@ -0,0 +1,75 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
This is the complete list of members for pyShelf.src.backend.lib.storage.Storage, including all inherited members.
+
+ 1.8.16
+
+
+
diff --git a/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html b/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html
new file mode 100644
index 0000000..943f51c
--- /dev/null
+++ b/docs/html/dc/deb/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo-members.html
@@ -0,0 +1,65 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
+ 1.8.16
+
+
+
diff --git a/docs/html/classapp_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
old mode 100755
new mode 100644
similarity index 58%
rename from docs/html/classapp_1_1lib_1_1api__hooks_1_1DuckDuckGo.html
rename to docs/html/dd/d4a/classpyShelf_1_1src_1_1backend_1_1lib_1_1api__hooks_1_1DuckDuckGo.html
index 6edec3e..de26674
--- a/docs/html/classapp_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
@@ -5,11 +5,11 @@
-Public Member Functions | |
| + | |
| def | __init__ (self) |
| def | image_result (self, query) |
| def | image_result (self, query) |
Public Attributes | |
| + | |
| url | |
duckduckgo related searching
| def app.lib.api_hooks.DuckDuckGo.image_result | +def pyShelf.src.backend.lib.api_hooks.DuckDuckGo.image_result | ( | self, | @@ -100,13 +100,13 @@ Public Attributes|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
pyShelf Open Source Ebook Server
- 0.1.0
+ 0.3.0
Open source, console based E-book server
|
@@ -29,47 +29,47 @@
-
-
+
+
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Public Member Functions | |
| + | |
| def | __init__ (self, file_array) |
| def | CreateFile (self, _pointer) |
| def | CreateFile (self, _pointer) |
First run file creation operations
| def app.lib.pyShelf.InitFiles.CreateFile | +def pyShelf.src.backend.lib.pyShelf.InitFiles.CreateFile | ( | self, | @@ -87,17 +87,18 @@ def__init__ (self, fi |
Create the file+
Checks if file exists and creates it if not +
+Generated on Sun Dec 15 2019 12:54:07 for pyShelf Open Source Ebook Server by
+
1.8.16
diff --git a/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html b/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html
new file mode 100644
index 0000000..d0abc73
--- /dev/null
+++ b/docs/html/dd/df1/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig-members.html
@@ -0,0 +1,66 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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.TestConfig | static |
| 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 |
+ 1.8.16
+
+
+
diff --git a/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html b/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html
new file mode 100644
index 0000000..e448586
--- /dev/null
+++ b/docs/html/dd/df7/classpyShelf_1_1src_1_1backend_1_1lib_1_1pyShelf_1_1BookDisplay-members.html
@@ -0,0 +1,72 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
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 |
+ 1.8.16
+
+
+
diff --git a/docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html b/docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html
new file mode 100644
index 0000000..20f0129
--- /dev/null
+++ b/docs/html/df/d16/classpyShelf_1_1src_1_1backend_1_1tests_1_1config__test_1_1TestConfig.html
@@ -0,0 +1,86 @@
+
+
+
+
+
+
+
+|
+ pyShelf Open Source Ebook Server
+ 0.3.0
+
+ Open source, console based E-book server
+ |
+
+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)) |
+ 1.8.16
+
+
+
diff --git a/docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html
old mode 100755
new mode 100644
similarity index 80%
rename from docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html
rename to docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html
index 6a79080..e0f30e1
--- a/docs/html/dir_9dc6c7acf21934bbaaf79b41db58c4e7.html
+++ b/docs/html/dir_1c7294442ce83d360610449d04c9d7fc.html
@@ -5,7 +5,7 @@
-
1.8.16
diff --git a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html
old mode 100755
new mode 100644
similarity index 58%
rename from docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html
rename to docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html
index 82b4f48..267c996
--- a/docs/html/classapp_1_1lib_1_1pyShelf_1_1InitFiles-members.html
+++ b/docs/html/dir_3f615ade772d23cefe5e20dcb18424a2.html
@@ -5,7 +5,7 @@
-This is the complete list of members for app.lib.pyShelf.InitFiles, including all inherited members.
-| __init__(self, file_array) (defined in app.lib.pyShelf.InitFiles) | app.lib.pyShelf.InitFiles | |
| CreateFile(self, _pointer) | app.lib.pyShelf.InitFiles |
+Directories |
1.8.16
diff --git a/docs/html/dir_d422163b96683743ed3963d4aac17747.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
old mode 100755
new mode 100644
similarity index 86%
rename from docs/html/dir_d422163b96683743ed3963d4aac17747.html
rename to docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
index 9672e63..aa80e43
--- a/docs/html/dir_d422163b96683743ed3963d4aac17747.html
+++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -5,7 +5,7 @@
-|
pyShelf Open Source Ebook Server
- 0.1.0
+ 0.3.0
Open source, console based E-book server
|
@@ -40,23 +40,18 @@ $(function() {
| do_GET(self) (defined in app.lib.pyShelf.RequestHandler) | app.lib.pyShelf.RequestHandler | |
| path (defined in app.lib.pyShelf.RequestHandler) | app.lib.pyShelf.RequestHandler |
1.8.16
diff --git a/docs/html/doc.png b/docs/html/doc.png
old mode 100755
new mode 100644
diff --git a/docs/html/doxygen.css b/docs/html/doxygen.css
old mode 100755
new mode 100644
diff --git a/docs/html/doxygen.png b/docs/html/doxygen.png
old mode 100755
new mode 100644
diff --git a/docs/html/dynsections.js b/docs/html/dynsections.js
old mode 100755
new mode 100644
diff --git a/docs/html/files.html b/docs/html/files.html
old mode 100755
new mode 100644
index cfd365b..44fb9b7
--- a/docs/html/files.html
+++ b/docs/html/files.html
@@ -19,7 +19,7 @@
| ▼ app | |
| ▼ lib | |
| __init__.py | |
| api_hooks.py | |
| display.py | |
| library.py | |
| pyShelf.py | |
| storage.py | |
| __init__.py | |
| config.py | |
| main.py |
| ▼ src | |
| ▼ backend | |
| ▼ lib | |
| __init__.py | |
| api_hooks.py | |
| config.py | |
| library.py | |
| pyShelf.py | |
| storage.py | |
| ▼ tests | |
| __init__.py | |
| config_test.py | |
| library_test.py | |
| __init__.py | |
| pyShelf_ScanLibrary.py |
1.8.16
diff --git a/docs/html/folderclosed.png b/docs/html/folderclosed.png
old mode 100755
new mode 100644
diff --git a/docs/html/folderopen.png b/docs/html/folderopen.png
old mode 100755
new mode 100644
diff --git a/docs/html/functions.html b/docs/html/functions.html
old mode 100755
new mode 100644
index 2236be4..d7ac943
--- a/docs/html/functions.html
+++ b/docs/html/functions.html
@@ -19,7 +19,7 @@
1.8.16
diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html
old mode 100755
new mode 100644
index 89bb656..c71a6b5
--- a/docs/html/functions_func.html
+++ b/docs/html/functions_func.html
@@ -19,7 +19,7 @@
1.8.16
diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html
old mode 100755
new mode 100644
index cf3cb18..bacea1f
--- a/docs/html/hierarchy.html
+++ b/docs/html/hierarchy.html
@@ -19,7 +19,7 @@
1.8.16
diff --git a/docs/html/index.hhc b/docs/html/index.hhc
old mode 100755
new mode 100644
index a1f54eb..d1f6a98
--- a/docs/html/index.hhc
+++ b/docs/html/index.hhc
@@ -4,6 +4,228 @@