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. the aim is to provide a fully featured ebook server with minimal requirements, and no reliance on X.

Features

• Recursive Scanning
• Cover Image Aggregation
• 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

Pre-requisites

- Git
- Curl

Installation

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

pyShelf is installed as a systemd service, enabled by default, you can control it with the following commands:

systemctl start pyShelf
systemctl restart pyshelf
systemctl stop pyshelf
systemctl disable pyshelf
systemctl enable pyshelf

if your books are not in the default location (/mnt/books) edit the config file at /etc/pyShelf/config.json

Coming Soon

• Manual Collections
• Books Removal
• Access Restrictions
• Metadata Manipulation
• UiUx Improvements
• Expanded book information view
• Improved Cover Image System
• OPDS Support

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.