pyShelf 0.8.0

Terminal based ebook server. Open source & Lightweight.

Discord

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?

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.

Features

Recursive Scanning
Fuzzy Search with optional specifiers
- tag:fiction
- author:Clancy
- title:"The Hunt for Red October"
- The Expanse
Download System
Automated Collections based on folder structure

Currently Supported Formats

epub
mobi
pdf

Installation

- curl -fsSL https://raw.githubusercontent.com/th3r00t/pyShelf/refs/heads/0.8.0--dev-zipapp/install.sh | sudo bash

Coming Soon

Manual Collections $id{67975ab0-5cf3-41f3-9198-d4284d30729b}
Books Removal $id{5eee7312-f4de-4cf0-855e-36cc056a6bf1}
Access Restrictions $id{98254c2c-e5a5-47bc-9369-e01dc8d2b2dc}
Metadata Manipulation $id{b149f6f8-300f-47a7-97cb-9ef365585147}
UiUx Improvements $id{21546c49-f3c4-495b-ad9b-d045226b11a3}
Expanded book information view $id{bdfdc654-e18d-48ef-8dc1-26aa77c596be}
Improved Cover Image System $id{d7764dad-6926-44dd-9f3e-f03ee687b143}
OPDS Support $id{ca717447-4f7c-4eef-b430-1f8c649b15fb}

Development

pre-commit Before developing, run pre-commit install See the documentation for more information.
'sem-ver' 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.

2.5 KiB Executable File Vendored Raw Blame History