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.
+ ++ 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. +
- +### You dont need an X server to host a website, Movies or Tv, so why should you need one to host ebooks? -### You dont need an X server to host a website, or your Movie & Tv collection, so why should you need one to host ebooks? +_Other solutions require you to have access to an X server to at the very least +generate your book database, pyShelf doesnt. the aim is to provide a fully featured +ebook server with minimal requirements, and no reliance on X._ -_Other solutions require you to have access to an X server to at the very least generate your book database, pyShelf doesnt. We aim to provide a fully featured ebook server with minimal requirements, and no reliance on X whatsoever._ -Follow or influence development @- Discord -
-## General Notes -You may need to click import books a second time if your import fails on the first attempt - -## 0.7.0 Patch Notes. - -# New Features - -* Administration System -* PDF Support - -## Current Features +## Features * Recursive Scanning -* [Django](https://www.djangoproject.com/) based frontend -* Seach via author, title, & file name fields. +* Cover Image Aggregation +* Fuzzy Search with optional specifiers + - tag:fiction + - author:Clancy + - title:"The Hunt for Red October" + - The Expanse * Download System -* Automated Collections - * A work in progress, the collections are based on your folder structure. -* User System -* Per User Favorites -* Expanded book information view -* Websocket server - * currently only responds to ping, and importBooks, more responders are planned. -* Full Docker integration. -* On Demand Importing - -| Branch | Support | Feature set | -| --- | --- | --- | -| Master | Bugs get priority | Most stable branch, may be behind in the core feature set | - | Development| Please report all bugs | Most active branch, this branch is a rolling release, containing the latest features. There will be bugs here hopefully nothing service killing | - | Others | Here there be dragons | These branches are used for day to day development, nothing here should be considered stable. +* Automated Collections based on folder structure ## Currently Supported Formats @@ -51,81 +34,44 @@ You may need to click import books a second time if your import fails on the fir * mobi * pdf -## Installation & Support Information +# Pre-requisites + - Git + - Curl # Installation + curl -fsSL https://raw.githubusercontent.com/th3r00t/pyShelf/refs/heads/master/install.sh | sudo bash -## Docker +pyShelf is installed as a systemd service, enabled by default, you can control it with the following commands: -The official Docker image for pyShelf is [`pyshelf/pyshelf`](https://hub.docker.com/r/pyshelf/pyshelf). The easiest way to get pyShelf running is through `docker-compose`. An example docker-compose.yml is included in the repo. +```bash +systemctl start pyShelf +systemctl restart pyshelf +systemctl stop pyshelf +systemctl disable pyshelf +systemctl enable pyshelf +```` -You'll need a `.env` file wich sets the `LOCAL_BOOK_DIR` variable, for example: +if your books are not in the default location (/mnt/books) edit the config file at /etc/pyShelf/config.json -``` -LOCAL_BOOK_DIR=/home/someone/books -``` - -The Docker image is still new, so there could still be some issues and missing features. Feel free to create a bug-issue when you encounter a bug. Development of the Docker image is discussed in https://github.com/th3r00t/pyShelf/pull/53 . Currently the database needs to be [PostgreSQL](https://www.postgresql.org/) with the account details shown in the example `docker-compose.yml`. - - Default User/Pass for web interface: pyshelf/pyshelf - -## Self Hosted -This is targeted towards Network Administrators, and home enthusiasts whom I assume will know how to setup a [Django](https://www.djangoproject.com/) app, and a [PostgreSQL](https://www.postgresql.org/) server. For those unfamiliar with the required setup please use the included docker-compose.yml - -### Pre-req Dependencies - -* gcc -* python3 -* pip -* postgresql - -Once your database is ready very little is required to get the system up and running: - -From the main directory - -`pip install -r requirements.txt` - -`./configure` - -`cd src/ && daphne frontend.asgi:application` add -b 0.0.0.0 -p 8000 as required to specify which interface\'s and port to bind too - -As of 0.6.0 Django is being served up via Daphne, and the static files are served up via whitenoise. - -## Import Books -The first step is to login, after logging in the button whill show your username, click on it once again, and a new menu will pop up with the option to logout, or import books. - -## In Progress - -### Organizational tools. - -- [x] Automated Collections +# Coming Soon - [ ] Manual Collections -- [x] Books Removal +- [ ] Books Removal - [ ] Access Restrictions - [ ] Metadata Manipulation -- [ ] Ui\Ux Improvements -- [ ] Others? - -### Improved cover image storage, and acquisition. - -### OPDS Support - -### Support for other formats - -- [x] .mobi -- [x] .pdf -- [ ] .cbz -- [ ] .zip (Zipped book folders, is this a new idea? (Consider storing your library folders zipped and retrieving a book on demand)) - -## Future Goals - -### Terminal Backend for catalogue maintenance +- [ ] UiUx Improvements +- [ ] Expanded book information view +- [ ] Improved Cover Image System +- [ ] OPDS Support ## Development * [`pre-commit`](https://pre-commit.com/) _Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._ -* ['Doxygen'](http://www.doxygen.nl/) -_Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._ * ['sem-ver'](https://semver.org) _Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly._ + +| Branch | Support | Feature set | +| --- | --- | --- | +| Master | Bugs get priority | Most stable branch, may be behind in the core feature set | + | Development| Please report all bugs | Most active branch, this branch is a rolling release, containing the latest features. There will be bugs here hopefully nothing service killing | + | Others | Here there be dragons | These branches are used for day to day development, nothing here should be considered stable. diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..dd3716f --- /dev/null +++ b/build.sh @@ -0,0 +1,6 @@ +#!/usr/bin/env sh +# uv export > requirements.txt +# mkdir if not exists release +mkdir -p release +python -m zipapp src --compress --output=release/pyshelf --python="/usr/bin/env python" +exit 0 diff --git a/config.json b/config.json deleted file mode 100644 index 8aff6e8..0000000 --- a/config.json +++ /dev/null @@ -1 +0,0 @@ -{"TITLE": "pyShelf E-Book Server", "VERSION": "0.7.0", "BOOKPATH": "/books", "DB_HOST": "localhost", "DB_PORT": "5432", "DATABASE": "pyshelf", "USER": "pyshelf", "PASSWORD": "pyshelf", "BOOKSHELF": "data/shelf.json", "ALLOWED_HOSTS": ["localhost", "127.0.0.1", "[::1]", "0.0.0.0"], "SECRET": "", "BUILD_MODE": "production"} diff --git a/configure b/configure deleted file mode 100755 index 62e60d4..0000000 --- a/configure +++ /dev/null @@ -1,53 +0,0 @@ -#!/usr/bin/env python3 -import os -import sys -import json -from pathlib import Path -from django.core.management.utils import get_random_secret_key -from src.backend.lib.pyShelf import Admin - - -def load_config(): - with open('config.json',"r") as file: - config = json.load(file) - file.close() - return config - - -def write_config(config): - with open('config.json',"w") as file: - json.dump(config, file) - file.close() - - -def set_secret(config=load_config()): - if config["SECRET"] == "": - config["SECRET"] = get_random_secret_key() - print(config["SECRET"]) - else: - print("Secret already set, skipping.") - -def set_book_directory(config=load_config(), *args): - if config["BOOKPATH"] == "": - try: config["BOOKPATH"] = args[0] - except IndexError: config["BOOKPATH"] = input("Input Book Directory ") - -def init_django_database(): - cmds = [ - 'python3 manage.py makemigrations', - 'python3 manage.py makemigrations interface', - 'python3 manage.py migrate', - 'python3 manage.py migrate interface', - ] - os.chdir("src") - for cmd in cmds: - os.system(cmd) - os.chdir("../") - -config = load_config() - -set_secret(config) -set_book_directory(config) -write_config(config) -init_django_database() -Admin(Path.cwd()).createsuperuser() diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 41c9655..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,24 +0,0 @@ -version: "3.7" - -services: - db: - image: "postgres" - restart: always - environment: - - "POSTGRES_PASSWORD=pyshelf" - - "POSTGRES_USER=pyshelf" - - "POSTGRES_DB=pyshelf" - volumes: - - "db_data:/var/lib/postgresql/data/" - pyshelf: - image: "pyshelf/pyshelf" - restart: always - ports: - - "8000:8000" - - "1337:1337" - volumes: - - "${LOCAL_BOOK_DIR}:/books" - depends_on: - - db -volumes: - db_data: diff --git a/docker/Dockerfile b/docker/Dockerfile deleted file mode 100644 index 8508064..0000000 --- a/docker/Dockerfile +++ /dev/null @@ -1,28 +0,0 @@ - -# This file is used to build the Dockerhub image. To host pyShelf yourself for -# production, please use the official pyShelf image on -# https://hub.docker.com/r/pyshelf/pyshelf - -# Use the following commands to build and push the docker image to Dockerhub: -# -# docker build -t pyshelf/pyshelf -f ./docker/Dockerfile . -# docker login -# docker push pyshelf/pyshelf - -FROM ubuntu - -EXPOSE 8000 -EXPOSE 1337 - -RUN apt-get update -y -RUN DEBIAN_FRONTEND=noninteractive apt-get install -y build-essential python3 python3-dev python3-pip python3-venv - -COPY . /pyshelf -COPY ./docker/config.json /pyshelf/config.json - -WORKDIR /pyshelf/ -RUN python3 -m pip install -r requirements.txt - -ENTRYPOINT python3 configure \ - && cd src/ \ - && daphne -b 0.0.0.0 -p 8000 frontend.asgi:application diff --git a/docker/README.md b/docker/README.md deleted file mode 100644 index 2c6f0d1..0000000 --- a/docker/README.md +++ /dev/null @@ -1,6 +0,0 @@ -Use `docker build -t pyshelf/pyshelf -f ./docker/Dockerfile .` in the project root to build the pyshelf image. - -Make sure the following files are in sync: -* config.json -* docker/pyshelf_nginx.conf -* uwsgi.ini \ No newline at end of file diff --git a/docker/config.json b/docker/config.json deleted file mode 100644 index 8aff6e8..0000000 --- a/docker/config.json +++ /dev/null @@ -1 +0,0 @@ -{"TITLE": "pyShelf E-Book Server", "VERSION": "0.7.0", "BOOKPATH": "/books", "DB_HOST": "localhost", "DB_PORT": "5432", "DATABASE": "pyshelf", "USER": "pyshelf", "PASSWORD": "pyshelf", "BOOKSHELF": "data/shelf.json", "ALLOWED_HOSTS": ["localhost", "127.0.0.1", "[::1]", "0.0.0.0"], "SECRET": "", "BUILD_MODE": "production"} diff --git a/docker/development.docker-compose.yml b/docker/development.docker-compose.yml deleted file mode 100644 index f6d97fe..0000000 --- a/docker/development.docker-compose.yml +++ /dev/null @@ -1,34 +0,0 @@ -version: "3.7" - -# This file is used to test the Dockerhub image. To host pyShelf yourself for -# production, please use the official pyShelf image on -# https://hub.docker.com/r/pyshelf/pyshelf - -# For development, use the following command in the root folder: -# -# docker-compose -f ./docker/development.docker-compose.yml up --build - -services: - db: - image: "postgres" - environment: - - "POSTGRES_PASSWORD=pyshelf" - - "POSTGRES_USER=pyshelf" - - "POSTGRES_DB=pyshelf" - volumes: - - "db_data:/var/lib/postgresql/data/" - - pyshelf: - build: - context: .. - dockerfile: ./docker/Dockerfile - ports: - - "8080:8000" - - "1337:1337" - volumes: - - "${LOCAL_BOOK_DIR}:/books" - depends_on: - - db - -volumes: - db_data: diff --git a/docker/pyshelf_nginx.conf b/docker/pyshelf_nginx.conf deleted file mode 100644 index 67c8724..0000000 --- a/docker/pyshelf_nginx.conf +++ /dev/null @@ -1,30 +0,0 @@ -upstream django { - server unix:///tmp/pyshelf_wsgi.sock; -} - -server { - listen 8000; - server_name localhost; - access_log /var/log/nginx/pyshelf.access.log; - error_log /var/log/nginx/pyshelf.error.log; - charset utf-8; - client_max_body_size 75M; - - location /media { - root /pyshelf/src/interface; - } - - location /static { - root /pyshelf/src/interface; - } - - location /books { - internal; - alias /pyshelf; - } - - location / { - uwsgi_pass django; - include uwsgi_params; - } -} \ No newline at end of file diff --git a/docs/pyShelf/html/annotated.html b/docs/pyShelf/html/annotated.html new file mode 100644 index 0000000..b1301d8 --- /dev/null +++ b/docs/pyShelf/html/annotated.html @@ -0,0 +1,104 @@ + + + + + + + +|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
| NDataHooks | |
| CBookInterface | |
| NFastAPIServer | |
| CFastAPIServer | |
| Nobjects | |
| CJSInterface | |
| Nsrc | |
| Nbackend | |
| Nlib | |
| Napi_hooks | |
| CDuckDuckGo | |
| Nconfig | |
| CConfig | |
| Nlibrary | |
| CCatalogue | |
| Nmodels | |
| CBase | |
| CBook | |
| CBookCollection | |
| CCollection | |
| CUser | |
| Noveride | |
| CACatalogue | |
| NpyShelf | |
| CInitFiles | |
| CServer | |
| Nstorage | |
| CStorage | |
| Ntests | |
| Nconfig_test | |
| CTestConfig | |
| Nlibrary_test | |
| CTest_Catalogue | |
| CTest_Config | |
| CTestCatalogue |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.models.Collection, including all inherited members.
+| book_collections (defined in src.backend.lib.models.Collection) | src.backend.lib.models.Collection | static |
| id (defined in src.backend.lib.models.Collection) | src.backend.lib.models.Collection | static |
| name (defined in src.backend.lib.models.Collection) | src.backend.lib.models.Collection | static |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.pyShelf.InitFiles, including all inherited members.
+| __init__(self, file_array) (defined in src.backend.lib.pyShelf.InitFiles) | src.backend.lib.pyShelf.InitFiles | |
| CreateFile(self, _pointer) | src.backend.lib.pyShelf.InitFiles |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for objects.JSInterface, including all inherited members.
+| __init__(self, Config config) | objects.JSInterface | |
| config (defined in objects.JSInterface) | objects.JSInterface | |
| install(self) | objects.JSInterface | |
| package_json (defined in objects.JSInterface) | objects.JSInterface |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Public Member Functions | |
| __init__ (self) | |
| open_file (self, root="config.json") | |
| init_config (self) | |
| get_logger (self) | |
+Public Attributes | |
| root = root | |
| dict | config_structure |
| logger = self.get_logger() | |
| book_path = env.get("BOOKPATH", self._data["BOOKPATH"]) | |
| str | TITLE = env.get("TITLE", self._data["TITLE"]) |
| VERSION = env.get("VERSION", self._data["VERSION"]) | |
| book_shelf = env.get("BOOKSHELF", self._data["BOOKSHELF"]) | |
| catalogue_db = env.get("DATABASE", self._data["DATABASE"]) | |
| user = self._data["USER"] | |
| password = self._data["PASSWORD"] | |
| db_host = env.get("DB_HOST", self._data["DB_HOST"]) | |
| db_port = env.get("DB_PORT", self._data["DB_PORT"]) | |
| list | file_array = [self.book_shelf] |
| bool | auto_scan = True |
| allowed_hosts | |
| db_engine = env.get("DB_ENGINE", self._data["DB_ENGINE"]) | |
| db_user = env.get("USER", self._data["USER"]) | |
| db_pass = env.get("PASSWORD", self._data["PASSWORD"]) | |
| build_mode = env.get("BUILD_MODE", self._data["BUILD_MODE"]) | |
+Protected Attributes | |
| str | _fp = "config.json" |
| _cp = Path.joinpath(root, self._fp) | |
| _data = self.init_config() | |
| src.backend.tests.library_test.Test_Config.__init__ | +( | +self | ) | ++ |
+
|
+ +inherited | +
Instantiate logging system.+
+
|
+ +inherited | +
| src.backend.tests.library_test.Test_Config.open_file | +( | +self, | +|
| + | + | root = "config.json" ) | +
Open config.json and reads in configuration options.+
Reimplemented from src.backend.lib.config.Config.
+ +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.config.Config, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.tests.library_test.TestCatalogue, including all inherited members.
+| config (defined in src.backend.tests.library_test.TestCatalogue) | src.backend.tests.library_test.TestCatalogue | static |
| root (defined in src.backend.tests.library_test.TestCatalogue) | src.backend.tests.library_test.TestCatalogue | static |
| test_filter_books(self) (defined in src.backend.tests.library_test.TestCatalogue) | src.backend.tests.library_test.TestCatalogue |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for FastAPIServer.FastAPIServer, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for DataHooks.BookInterface, including all inherited members.
+| config (defined in DataHooks.BookInterface) | DataHooks.BookInterface | |
| db (defined in DataHooks.BookInterface) | DataHooks.BookInterface |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Static Public Attributes | |
| Mapped | id = mapped_column(primary_key=True) |
| Mapped | book_id = mapped_column(ForeignKey("Book.id")) |
| Mapped | collection_id = mapped_column(ForeignKey("Collection.id")) |
| book = relationship("Book", back_populates="book_collections") | |
| collection = relationship("Collection", back_populates="book_collections") | |
Association table linking Books and Collections.
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Public Member Functions | |
| __init__ (self, config) | |
| scan_folder (self, _path=None) | |
| filter_books (self) | |
| process_by_filetype (self, book) | |
| extract_metadata_epub (self, book) | |
| extract_metadata_pdf (self, book) | |
| extract_metadata_mobi (self, book) | |
| extract_content (self, book_zip, book) | |
| extract_cover_html (self, book_zip, book) | |
| extract_cover_image (self, book_zip, book) | |
| compare_shelf_current (self) | |
| import_books (self, list=None, **kwargs) | |
+Static Public Member Functions | |
| process_epub (book) | |
| stripTags (source) | |
+Public Attributes | |
| list | file_list = [] |
| opf_regx = re.compile(r"\.opf") | |
| cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif") | |
| html_regx = re.compile(r"\.html") | |
| title_sanitization_regx = re.compile(r"^(Book )+[0-9]*") | |
| title_sanitization_lvl2_regx | |
| title_sanitization_dirs_regx = re.compile(r"/") | |
| root_dir = config.root | |
| book_folder = config.book_path | |
| books = None | |
| db_pointer = config.catalogue_db | |
| config = config | |
Decodes book metadata for storage +
| src.backend.lib.library.Catalogue.__init__ | +( | +self, | +|
| + | + | config ) | +
| src.backend.lib.library.Catalogue.compare_shelf_current | +( | +self | ) | ++ |
Calls storage system, gets list of books stored and compares against files on disk ++
| 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 ++
| 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 ++
| 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 ++
| src.backend.lib.library.Catalogue.extract_metadata_epub | +( | +self, | +|
| + | + | book ) | +
Extract metadata from epub file + +:param book: Dictionary of epub file contents +:returns: Dictionary of book metadata ++
| src.backend.lib.library.Catalogue.extract_metadata_mobi | +( | +self, | +|
| + | + | book ) | +
| src.backend.lib.library.Catalogue.extract_metadata_pdf | +( | +self, | +|
| + | + | book ) | +
Return extracted metadata +:NOTES: Retrieval of data has been problematic, some pdf's providing +reliable titles that corespond with the actual, and others being +nonsense. ++
| src.backend.lib.library.Catalogue.filter_books | +( | +self | ) | ++ |
Calls scan_folder and filters out book files. + +:returns self._book_list_expanded: json string containing +all book metadata ++
Reimplemented in src.backend.tests.library_test.Test_Catalogue.
+ +| src.backend.lib.library.Catalogue.import_books | +( | +self, | +|
| + | + | list = None, | +|
| + | + | ** | kwargs ) | +
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. ++
Reimplemented in src.backend.lib.overide.ACatalogue.
+ +| src.backend.lib.library.Catalogue.process_by_filetype | +( | +self, | +|
| + | + | book ) | +
Determine books filetype and process.+
+
|
+ +static | +
Return dictionary of epub file contents+
| src.backend.lib.library.Catalogue.scan_folder | +( | +self, | +|
| + | + | _path = None ) | +
Scan folder by _path, allows recurisive scanning + +:param _path: Path to scan ++
Reimplemented in src.backend.lib.overide.ACatalogue.
+ +
+
|
+ +static | +
| src.backend.lib.library.Catalogue.book_folder = config.book_path | +
| src.backend.lib.library.Catalogue.books = None | +
| src.backend.lib.library.Catalogue.config = config | +
| src.backend.lib.library.Catalogue.cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif") | +
| src.backend.lib.library.Catalogue.db_pointer = config.catalogue_db | +
| list src.backend.lib.library.Catalogue.file_list = [] | +
| src.backend.lib.library.Catalogue.html_regx = re.compile(r"\.html") | +
| src.backend.lib.library.Catalogue.opf_regx = re.compile(r"\.opf") | +
| src.backend.lib.library.Catalogue.root_dir = config.root | +
| src.backend.lib.library.Catalogue.title_sanitization_dirs_regx = re.compile(r"/") | +
| src.backend.lib.library.Catalogue.title_sanitization_lvl2_regx | +
| src.backend.lib.library.Catalogue.title_sanitization_regx = re.compile(r"^(Book )+[0-9]*") | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.tests.library_test.Test_Config, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.tests.config_test.TestConfig, including all inherited members.
+| config (defined in src.backend.tests.config_test.TestConfig) | src.backend.tests.config_test.TestConfig | static |
| test_book_dir(self) (defined in src.backend.tests.config_test.TestConfig) | src.backend.tests.config_test.TestConfig | |
| test_title(self) (defined in src.backend.tests.config_test.TestConfig) | src.backend.tests.config_test.TestConfig | |
| test_version(self) (defined in src.backend.tests.config_test.TestConfig) | src.backend.tests.config_test.TestConfig |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.library.Catalogue, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Static Public Attributes | |
| Mapped | id = mapped_column(primary_key=True, nullable=False) |
| Mapped | title [str] |
| Mapped | author [Optional[str]] |
| Mapped | categories [Optional[str]] |
| Mapped | cover [Optional[bytes]] |
| Mapped | pages [Optional[int]] |
| Mapped | progress [Optional[float]] |
| Mapped | file_name [str] |
| Mapped | description [Optional[str]] |
| Mapped | date [timestamp] |
| Mapped | rights [Optional[str]] |
| Mapped | tags [Optional[str]] |
| Mapped | identifier [Optional[str]] |
| Mapped | publisher [Optional[str]] |
| book_collections | |
Book model.
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
+Base class for all models.
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self, config) | |
| get_connection_string (self) | |
| create_tables (self) | |
| insert_book (self, book) | |
| book_paths_list (self) | |
| list() | parse_collections_from_path (self, dict() book) |
| make_collections (self) | |
| get_books (self, collection=None, skip=None, limit=None) | |
| get_book (self, id) | |
| get_collections (self) | |
| get_collection (self, name) | |
| dict | parse_advanced_query (self, str query) |
| fuzzy_search_books (self, str query, int limit=30) | |
+Public Attributes | |
| config = config | |
| sql = self.config.catalogue_db | |
| user = self.config.user | |
| password = self.config.password | |
| db_host = self.config.db_host | |
| db_port = self.config.db_port | |
| engine | |
Create a new Storage object. + +>>> db = Storage(config) + +Parameters +---------- +config : Config() + Main program configuration. + +Attributes +---------- +config : Stores configuration +sql : Database Name +user : Database User Name +password : Database Password +db_host : Database Host +db_port : Database Port +engine : sqlalchemy.create_engine(url, executor, kw) +
| src.backend.lib.storage.Storage.__init__ | +( | +self, | +|
| + | + | config ) | +
Initialize storage object.+
| src.backend.lib.storage.Storage.book_paths_list | +( | +self | ) | ++ |
Get file paths from database for comparison to system files. + +Returns +------- +_result : ScalarResult Object ++
| src.backend.lib.storage.Storage.create_tables | +( | +self | ) | ++ |
Create table structure.+
| src.backend.lib.storage.Storage.fuzzy_search_books | +( | +self, | +|
| + | + | str | query, | +
| + | + | int | limit = 30 ) | +
| src.backend.lib.storage.Storage.get_book | +( | +self, | +|
| + | + | id ) | +
Get book from database. + +Parameters +---------- +id : int + Book ID to filter by. + +Returns +------- +_result : ScalarResult Object ++
| src.backend.lib.storage.Storage.get_books | +( | +self, | +|
| + | + | collection = None, | +|
| + | + | skip = None, | +|
| + | + | limit = None ) | +
Get books from database. + +Parameters +---------- +collection : int or None + Collection ID to filter by. +skip : int or None + Number of records to skip (offset). +limit : int or None + Maximum number of records to return. ++
| src.backend.lib.storage.Storage.get_collection | +( | +self, | +|
| + | + | name ) | +
Get collection from database. + +Returns +------- +_result : ScalarResult Object ++
| src.backend.lib.storage.Storage.get_collections | +( | +self | ) | ++ |
Get collections from database. + +Returns +------- +_result : ScalarResult Object ++
| src.backend.lib.storage.Storage.get_connection_string | +( | +self | ) | ++ |
Get connection string. + +Engine type references config.json:DB_ENGINE. + +Returns +------- +str : sqlalchemy Connection String ++
| src.backend.lib.storage.Storage.insert_book | +( | +self, | +|
| + | + | book ) | +
Insert a new book into the database. + +Parameters +---------- +book: dict() + Book object to insert. + +Returns +------- +bool + True on success False on failure ++
| src.backend.lib.storage.Storage.make_collections | +( | +self | ) | ++ |
Ensure collections exist and link them to books (many-to-many).+
| dict src.backend.lib.storage.Storage.parse_advanced_query | +( | +self, | +|
| + | + | str | query ) | +
Parse a query like 'title:"dark tower" author:king tags:fantasy'+
| list() src.backend.lib.storage.Storage.parse_collections_from_path | +( | +self, | +|
| + | + | dict() | book ) | +
Parse book path's to determine common folder structure. + +Stores collections based on shared paths. + +Parameters +---------- +book : dict() + Book object to parse. + +Returns +------- +collections : list() + List of collections. ++
| src.backend.lib.storage.Storage.config = config | +
| src.backend.lib.storage.Storage.db_host = self.config.db_host | +
| src.backend.lib.storage.Storage.db_port = self.config.db_port | +
| src.backend.lib.storage.Storage.engine | +
| src.backend.lib.storage.Storage.password = self.config.password | +
| src.backend.lib.storage.Storage.sql = self.config.catalogue_db | +
| src.backend.lib.storage.Storage.user = self.config.user | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self) | |
| image_result (self, query) | |
| description_result (self, query) | |
+Public Attributes | |
| str | url = "https://api.duckduckgo.com/?q=" |
| str | imageurl = "https://duckduckgo.com" |
duckduckgo related searching
| src.backend.lib.api_hooks.DuckDuckGo.__init__ | +( | +self | ) | ++ |
| src.backend.lib.api_hooks.DuckDuckGo.description_result | +( | +self, | +|
| + | + | query ) | +
| 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 ++
| str src.backend.lib.api_hooks.DuckDuckGo.imageurl = "https://duckduckgo.com" | +
| str src.backend.lib.api_hooks.DuckDuckGo.url = "https://api.duckduckgo.com/?q=" | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self, root) | |
| __aexit__ (self, *args, **kwargs) | |
| initialize_server (self) | |
| runImport (self) | |
| socketio (self, websocket, path) | |
| pong (self) | |
| start (self) | |
+Public Attributes | |
| root = root | |
| tuple | host = ("127.0.0.1", 1337) |
| config = Config(self.root) | |
| loop = None | |
| serve = None | |
| socketio | |
Main Server Container +:TODO: Document this +
| src.backend.lib.pyShelf.Server.__init__ | +( | +self, | +|
| + | + | root ) | +
| src.backend.lib.pyShelf.Server.__aexit__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
| src.backend.lib.pyShelf.Server.initialize_server | +( | +self | ) | ++ |
| src.backend.lib.pyShelf.Server.pong | +( | +self | ) | ++ |
| src.backend.lib.pyShelf.Server.runImport | +( | +self | ) | ++ |
| src.backend.lib.pyShelf.Server.socketio | +( | +self, | +|
| + | + | websocket, | +|
| + | + | path ) | +
| src.backend.lib.pyShelf.Server.start | +( | +self | ) | ++ |
| src.backend.lib.pyShelf.Server.config = Config(self.root) | +
| tuple src.backend.lib.pyShelf.Server.host = ("127.0.0.1", 1337) | +
| src.backend.lib.pyShelf.Server.loop = None | +
| src.backend.lib.pyShelf.Server.root = root | +
| src.backend.lib.pyShelf.Server.serve = None | +
| src.backend.lib.pyShelf.Server.socketio | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Functions | |
| run_import () | |
| main () | |
+Variables | |
| root = Path.cwd() | |
| config = Config(root) | |
| PRG_PATH = Path.cwd().__str__() | |
PyShelf Entrypoint.
| src.__main__.main | +( | +) | ++ |
Program entrypoint.+
| src.__main__.run_import | +( | +) | ++ |
Begin live import of books.+
| src.__main__.config = Config(root) | +
| src.__main__.PRG_PATH = Path.cwd().__str__() | +
| src.__main__.root = Path.cwd() | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| test_filter_books (self) | |
+Static Public Attributes | |
| root = os.path.abspath(os.path.curdir) | |
| config = Test_Config() | |
| src.backend.tests.library_test.TestCatalogue.test_filter_books | +( | +self | ) | ++ |
+
|
+ +static | +
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self, Config config) | |
| install (self) | |
+Public Attributes | |
| Path | package_json = Path(config.root, "src/frontend/package.json") |
| Config | config = config |
A class to interface with the JavaScript side of pyShelf.
| objects.JSInterface.__init__ | +( | +self, | +|
| + | + | Config | config ) | +
Initialize the JSInterface object.+
| objects.JSInterface.install | +( | +self | ) | ++ |
Install the JavaScript dependencies.+
| Config objects.JSInterface.config = config | +
| Path objects.JSInterface.package_json = Path(config.root, "src/frontend/package.json") | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Public Member Functions | |
| __init__ (self, root) | |
| init_config (self) | |
| get_logger (self) | |
| open_file (self) | |
+Public Attributes | |
| root = root | |
| dict | config_structure |
| logger = self.get_logger() | |
| book_path = env.get("BOOKPATH", self._data["BOOKPATH"]) | |
| str | TITLE = env.get("TITLE", self._data["TITLE"]) |
| VERSION = env.get("VERSION", self._data["VERSION"]) | |
| book_shelf = env.get("BOOKSHELF", self._data["BOOKSHELF"]) | |
| catalogue_db = env.get("DATABASE", self._data["DATABASE"]) | |
| user = self._data["USER"] | |
| password = self._data["PASSWORD"] | |
| db_host = env.get("DB_HOST", self._data["DB_HOST"]) | |
| db_port = env.get("DB_PORT", self._data["DB_PORT"]) | |
| list | file_array = [self.book_shelf] |
| bool | auto_scan = True |
| allowed_hosts | |
| db_engine = env.get("DB_ENGINE", self._data["DB_ENGINE"]) | |
| db_user = env.get("USER", self._data["USER"]) | |
| db_pass = env.get("PASSWORD", self._data["PASSWORD"]) | |
| build_mode = env.get("BUILD_MODE", self._data["BUILD_MODE"]) | |
+Protected Attributes | |
| str | _fp = "config.json" |
| _cp = Path.joinpath(root, self._fp) | |
| _data = self.init_config() | |
Main System Configuration. + +>>> config = Config(root) + +Parameters +---------- +root : File system root of program + +Attributes +---------- +root : str() stores root. +config_structure : dict() Default Configuration Structure. +_fp : str() file pointer to main configuration. +_cp : Path() object of configuration file. +_data : dict() parsed json of _fp. +logger : holds logging configuration from get_logger(). +book_path : directory pointer to main books folder. +TITLE : str() Program title. +VERSION : str() Program version. +TITLE : str() Combines TITLE & VERSION. +book_shelf : Deprecation TODO: Is this still in use? +catalogue_db : str() Database Name. +user : str() Database user name. +password : str() Database password. +db_host : str() Database host. +db_port : int() Database port. +file_array : list() copy of book_shelf TODO: See book_shelf +auto_scan: bool() Do we auto scan on launch? +allowed_hosts : list() Allowed host list. +db_engine : str() Desired database engine type. +db_user : str() Database user name. Duplication Warning. +db_pass : str() Database password. Duplication Warning. +build_mode : str() Production | Development mode. + +Methods +------- +get_logger : Setup loguru. +open_file : Parse configuration file. +
| src.backend.lib.config.Config.__init__ | +( | +self, | +|
| + | + | root ) | +
Initialize main configuration options.+
| src.backend.lib.config.Config.get_logger | +( | +self | ) | ++ |
Instantiate logging system.+
| src.backend.lib.config.Config.init_config | +( | +self | ) | ++ |
| src.backend.lib.config.Config.open_file | +( | +self | ) | ++ |
Open config.json and reads in configuration options.+
Reimplemented in src.backend.tests.library_test.Test_Config.
+ +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| src.backend.lib.config.Config.allowed_hosts | +
| bool src.backend.lib.config.Config.auto_scan = True | +
| src.backend.lib.config.Config.book_path = env.get("BOOKPATH", self._data["BOOKPATH"]) | +
| src.backend.lib.config.Config.book_shelf = env.get("BOOKSHELF", self._data["BOOKSHELF"]) | +
| src.backend.lib.config.Config.build_mode = env.get("BUILD_MODE", self._data["BUILD_MODE"]) | +
| src.backend.lib.config.Config.catalogue_db = env.get("DATABASE", self._data["DATABASE"]) | +
| src.backend.lib.config.Config.config_structure | +
| src.backend.lib.config.Config.db_engine = env.get("DB_ENGINE", self._data["DB_ENGINE"]) | +
| src.backend.lib.config.Config.db_host = env.get("DB_HOST", self._data["DB_HOST"]) | +
| src.backend.lib.config.Config.db_pass = env.get("PASSWORD", self._data["PASSWORD"]) | +
| src.backend.lib.config.Config.db_port = env.get("DB_PORT", self._data["DB_PORT"]) | +
| src.backend.lib.config.Config.db_user = env.get("USER", self._data["USER"]) | +
| list src.backend.lib.config.Config.file_array = [self.book_shelf] | +
| src.backend.lib.config.Config.logger = self.get_logger() | +
| src.backend.lib.config.Config.password = self._data["PASSWORD"] | +
| src.backend.lib.config.Config.root = root | +
| str src.backend.lib.config.Config.TITLE = env.get("TITLE", self._data["TITLE"]) | +
| src.backend.lib.config.Config.user = self._data["USER"] | +
| src.backend.lib.config.Config.VERSION = env.get("VERSION", self._data["VERSION"]) | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.models.User, including all inherited members.
+| date_joined (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| email (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| id (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| is_active (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| is_admin (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| is_superuser (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| last_login (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| password (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
| username (defined in src.backend.lib.models.User) | src.backend.lib.models.User | static |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Attributes | |
| config = config | |
| db = Storage(self.config) | |
Access point for book database.
| DataHooks.BookInterface.config = config | +
| DataHooks.BookInterface.db = Storage(self.config) | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.overide.ACatalogue, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self, file_array) | |
| CreateFile (self, _pointer) | |
First run file creation operations
| src.backend.lib.pyShelf.InitFiles.__init__ | +( | +self, | +|
| + | + | file_array ) | +
| src.backend.lib.pyShelf.InitFiles.CreateFile | +( | +self, | +|
| + | + | _pointer ) | +
Checks if file exists and creates it if not ++
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.models.Book, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.storage.Storage, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Classes | |
| class | FastAPIServer |
+Functions | |
| str | base64decode (string) |
| str | summarize (string) |
| str | convertDateTime (datetime timestamp) |
| dumps | books_tojson (obj) |
| dumps | book_tojson (book) |
| dumps | tojson (obj) |
| dumps | collections_tojson (collection) |
+Variables | |
| app = FastAPI() | |
| STATIC_DIR | |
| TEMPLATES_DIR | |
| templates = Jinja2Templates(directory=str(TEMPLATES_DIR)) | |
| list | origins |
| allow_origins | |
| allow_credentials | |
| allow_methods | |
| allow_headers | |
pyShelf's main frontend library.
| str FastAPIServer.base64decode | +( | +string | ) | ++ |
Decode a base64 string.+
| dumps FastAPIServer.book_tojson | +( | +book | ) | ++ |
Convert a book object to a json.+
| dumps FastAPIServer.books_tojson | +( | +obj | ) | ++ |
Convert an object to a dictionary.+
| dumps FastAPIServer.collections_tojson | +( | +collection | ) | ++ |
Convert a collections object to json.+
| str FastAPIServer.convertDateTime | +( | +datetime | timestamp | ) | ++ |
Convert a datetime object to a string.+
| str FastAPIServer.summarize | +( | +string | ) | ++ |
Summarize a string.+
| dumps FastAPIServer.tojson | +( | +obj | ) | ++ |
| FastAPIServer.allow_credentials | +
| FastAPIServer.allow_headers | +
| FastAPIServer.allow_methods | +
| FastAPIServer.allow_origins | +
| FastAPIServer.app = FastAPI() | +
| list FastAPIServer.origins | +
| FastAPIServer.STATIC_DIR | +
| FastAPIServer.templates = Jinja2Templates(directory=str(TEMPLATES_DIR)) | +
| FastAPIServer.TEMPLATES_DIR | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Public Member Functions | |
| __init__ (self) | |
| filter_books (self) | |
| scan_folder (self, _path=None) | |
| process_by_filetype (self, book) | |
| extract_metadata_epub (self, book) | |
| extract_metadata_pdf (self, book) | |
| extract_metadata_mobi (self, book) | |
| extract_content (self, book_zip, book) | |
| extract_cover_html (self, book_zip, book) | |
| extract_cover_image (self, book_zip, book) | |
| compare_shelf_current (self) | |
| import_books (self, list=None, **kwargs) | |
+Static Public Member Functions | |
| process_epub (book) | |
| stripTags (source) | |
+Public Attributes | |
| str | book_shelf = "app/" + self.book_shelf |
| list | file_list = [] |
| opf_regx = re.compile(r"\.opf") | |
| cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif") | |
| html_regx = re.compile(r"\.html") | |
| title_sanitization_regx = re.compile(r"^(Book )+[0-9]*") | |
| title_sanitization_lvl2_regx | |
| title_sanitization_dirs_regx = re.compile(r"/") | |
| root_dir = config.root | |
| book_folder = config.book_path | |
| books = None | |
| db_pointer = config.catalogue_db | |
| config = config | |
| src.backend.tests.library_test.Test_Catalogue.__init__ | +( | +self | ) | ++ |
+
|
+ +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 | +
Extract metadata from epub file + +:param book: Dictionary of epub file contents +:returns: Dictionary of book metadata ++
+
|
+ +inherited | +
+
|
+ +inherited | +
Return extracted metadata +:NOTES: Retrieval of data has been problematic, some pdf's providing +reliable titles that corespond with the actual, and others being +nonsense. ++
| src.backend.tests.library_test.Test_Catalogue.filter_books | +( | +self | ) | ++ |
Calls scan_folder and filters out book files. + +:returns self._book_list_expanded: json string containing +all book metadata ++
Reimplemented from 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. ++
Reimplemented in src.backend.lib.overide.ACatalogue.
+ +
+
|
+ +inherited | +
Determine books filetype and process.+
+
|
+ +staticinherited | +
Return dictionary of epub file contents+
+
|
+ +inherited | +
Scan folder by _path, allows recurisive scanning + +:param _path: Path to scan ++
Reimplemented in src.backend.lib.overide.ACatalogue.
+ +
+
|
+ +staticinherited | +
+
|
+ +inherited | +
| str src.backend.tests.library_test.Test_Catalogue.book_shelf = "app/" + self.book_shelf | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.tests.library_test.Test_Catalogue, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Public Member Functions | |
| __init__ (self) | |
| scan_folder (self, _path=None) | |
| import_books (self, **kwargs) | |
| filter_books (self) | |
| process_by_filetype (self, book) | |
| extract_metadata_epub (self, book) | |
| extract_metadata_pdf (self, book) | |
| extract_metadata_mobi (self, book) | |
| extract_content (self, book_zip, book) | |
| extract_cover_html (self, book_zip, book) | |
| extract_cover_image (self, book_zip, book) | |
| compare_shelf_current (self) | |
+Static Public Member Functions | |
| process_epub (book) | |
| stripTags (source) | |
+Public Attributes | |
| list | file_list = [] |
| opf_regx = re.compile(r"\.opf") | |
| cover_regx = re.compile(r"\.jpg|\.jpeg|\.png|\.bmp|\.gif") | |
| html_regx = re.compile(r"\.html") | |
| title_sanitization_regx = re.compile(r"^(Book )+[0-9]*") | |
| title_sanitization_lvl2_regx | |
| title_sanitization_dirs_regx = re.compile(r"/") | |
| root_dir = config.root | |
| book_folder = config.book_path | |
| books = None | |
| db_pointer = config.catalogue_db | |
| config = config | |
Aynchronous overide of library.Catalogue, +: TODO : Complete or discard this overide +
| src.backend.lib.overide.ACatalogue.__init__ | +( | +self | ) | ++ |
+
|
+ +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 | +
Extract metadata from epub file + +:param book: Dictionary of epub file contents +:returns: Dictionary of book metadata ++
+
|
+ +inherited | +
+
|
+ +inherited | +
Return extracted metadata +:NOTES: Retrieval of data has been problematic, some pdf's providing +reliable titles that corespond with the actual, and others being +nonsense. ++
+
|
+ +inherited | +
Calls scan_folder and filters out book files. + +:returns self._book_list_expanded: json string containing +all book metadata ++
Reimplemented in src.backend.tests.library_test.Test_Catalogue.
+ +| src.backend.lib.overide.ACatalogue.import_books | +( | +self, | +|
| + | + | ** | kwargs ) | +
Async overide of import_books ++
Reimplemented from src.backend.lib.library.Catalogue.
+ +
+
|
+ +inherited | +
Determine books filetype and process.+
+
|
+ +staticinherited | +
Return dictionary of epub file contents+
| src.backend.lib.overide.ACatalogue.scan_folder | +( | +self, | +|
| + | + | _path = None ) | +
Scan folder by _path, allows recurisive scanning ++
Reimplemented from src.backend.lib.library.Catalogue.
+ +
+
|
+ +staticinherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| __init__ (self, config) | |
| compile_static_files (self) | |
| None | use_route_names_as_operation_ids (self, FastAPI app) |
| index (Request request, int skip=0, int limit=30) | |
| books (Request request, int skip=0, int limit=10, collection=None) | |
| book (Request request, int book_id) | |
| book (Request request, int book_id) | |
| collections (Request request) | |
| collection (Request request, str collection, int skip=0, int limit=30) | |
| search_books_api (Request request, str search) | |
| run (self) | |
+Public Attributes | |
| config = config | |
| fe_config | |
| fe_server = uvicorn.Server(self.fe_config) | |
| JSInterface | JSInterface = JSInterface(self.config) |
Entry point for FastAPI server.
| FastAPIServer.FastAPIServer.__init__ | +( | +self, | +|
| + | + | config ) | +
Initialize FastAPIServer object parameters.+
| FastAPIServer.FastAPIServer.book | +( | +Request | request, | +
| + | + | int | book_id ) | +
| FastAPIServer.FastAPIServer.book | +( | +Request | request, | +
| + | + | int | book_id ) | +
| FastAPIServer.FastAPIServer.books | +( | +Request | request, | +
| + | + | int | skip = 0, | +
| + | + | int | limit = 10, | +
| + | + | collection = None ) | +
| FastAPIServer.FastAPIServer.collection | +( | +Request | request, | +
| + | + | str | collection, | +
| + | + | int | skip = 0, | +
| + | + | int | limit = 30 ) | +
Collection file responder.+
| FastAPIServer.FastAPIServer.collections | +( | +Request | request | ) | ++ |
| FastAPIServer.FastAPIServer.compile_static_files | +( | +self | ) | ++ |
Compile static files for web frontend.+
| FastAPIServer.FastAPIServer.index | +( | +Request | request, | +
| + | + | int | skip = 0, | +
| + | + | int | limit = 30 ) | +
| FastAPIServer.FastAPIServer.run | +( | +self | ) | ++ |
Front end server entrypoint.+
| FastAPIServer.FastAPIServer.search_books_api | +( | +Request | request, | +
| + | + | str | search ) | +
Collection file responder.+
| None FastAPIServer.FastAPIServer.use_route_names_as_operation_ids | +( | +self, | +|
| + | + | FastAPI | app ) | +
Use route name as operation id.+
| FastAPIServer.FastAPIServer.config = config | +
| FastAPIServer.FastAPIServer.fe_config | +
| FastAPIServer.FastAPIServer.fe_server = uvicorn.Server(self.fe_config) | +
| JSInterface FastAPIServer.FastAPIServer.JSInterface = JSInterface(self.config) | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Static Public Attributes | |
| Mapped | id = mapped_column(primary_key=True, nullable=False) |
| Mapped | username = mapped_column(unique=True, nullable=False) |
| Mapped | password = mapped_column(nullable=False) |
| Mapped | email = mapped_column(unique=True, nullable=True) |
| Mapped | date_joined |
| Mapped | last_login |
| Mapped | is_active = mapped_column(nullable=False, default=True) |
| Mapped | is_admin = mapped_column(nullable=False, default=False) |
| Mapped | is_superuser = mapped_column(nullable=False, default=False) |
User model.
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.api_hooks.DuckDuckGo, including all inherited members.
+| __init__(self) (defined in src.backend.lib.api_hooks.DuckDuckGo) | src.backend.lib.api_hooks.DuckDuckGo | |
| description_result(self, query) (defined in src.backend.lib.api_hooks.DuckDuckGo) | src.backend.lib.api_hooks.DuckDuckGo | |
| image_result(self, query) | src.backend.lib.api_hooks.DuckDuckGo | |
| imageurl (defined in src.backend.lib.api_hooks.DuckDuckGo) | src.backend.lib.api_hooks.DuckDuckGo | |
| url (defined in src.backend.lib.api_hooks.DuckDuckGo) | src.backend.lib.api_hooks.DuckDuckGo |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.pyShelf.Server, including all inherited members.
+ 1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+
++Static Public Attributes | |
| Mapped | id = mapped_column(primary_key=True) |
| Mapped | name = mapped_column(unique=True) |
| book_collections | |
Collection model.
+
|
+ +static | +
+
|
+ +static | +
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
This is the complete list of members for src.backend.lib.models.BookCollection, including all inherited members.
+| book (defined in src.backend.lib.models.BookCollection) | src.backend.lib.models.BookCollection | static |
| book_id (defined in src.backend.lib.models.BookCollection) | src.backend.lib.models.BookCollection | static |
| collection (defined in src.backend.lib.models.BookCollection) | src.backend.lib.models.BookCollection | static |
| collection_id (defined in src.backend.lib.models.BookCollection) | src.backend.lib.models.BookCollection | static |
| id (defined in src.backend.lib.models.BookCollection) | src.backend.lib.models.BookCollection | static |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Public Member Functions | |
| test_book_dir (self) | |
| test_title (self) | |
| test_version (self) | |
+Static Public Attributes | |
| config = Config(os.path.abspath(os.path.curdir)) | |
| src.backend.tests.config_test.TestConfig.test_book_dir | +( | +self | ) | ++ |
| src.backend.tests.config_test.TestConfig.test_title | +( | +self | ) | ++ |
| src.backend.tests.config_test.TestConfig.test_version | +( | +self | ) | ++ |
+
|
+ +static | +
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Files | |
| __init__.py | |
| api_hooks.py | |
| config.py | |
| library.py | |
| models.py | |
| overide.py | |
| pyShelf.py | |
| storage.py | |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Directories | |
| lib | |
| tests | |
+Files | |
| __init__.py | |
| pyShelf_MakeCollections.py | |
| pyShelf_ScanLibrary.py | |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Directories | |
| backend | |
+Files | |
| __about__.py | |
| __init__.py | |
| __main__.py | |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
+Directories | |
| lib | |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
| src | |
| backend | |
| lib | |
| __init__.py | |
| api_hooks.py | |
| config.py | |
| library.py | |
| models.py | |
| overide.py | |
| pyShelf.py | |
| storage.py | |
| tests | |
| __init__.py | |
| config_test.py | |
| library_test.py | |
| server_test.py | |
| __init__.py | |
| pyShelf_MakeCollections.py | |
| pyShelf_ScanLibrary.py | |
| frontend | |
| lib | |
| DataHooks.py | |
| FastAPIServer.py | |
| objects.py | |
| runtime_paths.py | |
| __about__.py | |
| __init__.py | |
| __main__.py |
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+|
+ pyShelf Open Source Ebook Server 0.8.0
+
+ FOSS E-Book Server, https://pyshelf.com
+ |
+
1.14.0
+
+