mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
e01fcaa965108bdaf5ea4ae985c00e986b9bcb57
pyShelf 0.8.0
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.
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.
Follow or influence development @
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
| 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. |
Currently Supported Formats
- epub
- mobi
Installation & Support Information
Installation
- curl -fsSL https://raw.githubusercontent.com/th3r00t/pyShelf/refs/heads/0.8.0--dev-zipapp/install.sh | sudo bash
In Progress
Organizational tools.
- Manual Collections
- Books Removal
- Access Restrictions
- Metadata Manipulation
- UiUx Improvements
- Expanded book information view
- Improved Cover Image System
- OPDS Support
Development
pre-commitBefore developing, runpre-commit installSee the documentation for more information.- 'sem-ver' Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly.
Languages
JavaScript
96.1%
HTML
3.9%