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.

Join the discussion: Discord https://discord.gg/H9TbNJS | IRC freenode.net @ #pyshelf

Current Features

Custom Installer
Recursive Scanning
Fast database access
Django based frontend
Basic seaching via a SearchVector of author, title, & file_name fields.
Ebook Downloading

Currently Supported Formats

epub

Installation Example

pyShelf Installation Video

Further Installation & Support Information

SUPPORT.md

0.4.1 Patch Notes.

Filename detection

Now using os.path.splitext to ensure proper formating of downloaded files

0.4.0 Patch Notes.

The Installer Initiative

All work this time around was centered on creating an installer simple and inclusive enough to hopefully enable all users to simply set it and forget it. I have debugged as much as I can with my setup. I am performing some simple file finding to determine which system installer is present, and setting it as the installer used by pyShelf.

This setup has been tested and is working flawlessly on arch based distros, and i have done what I can for debian, and centos based distros, If you do encounter installer issues please let me know if it isnt finding the system installer, or possibly isnt passing command line arguments to your installer.

Also it should be noted that I am determining the presence of your postgresql, and nginx servers based on whether or not the process is listed in the process list.

At this time I would suggest stopping both your postgresql and nginx servers should you already have them and allowing the installer to do its work generating custom configurations and putting the nginx config files in place (/etc/nginx/sites-available, and symlinked to /etc/nginx/sites-enabled/) None of your existing configurations will be overwritten.

Development

pre-commit Before developing, run pre-commit install See the documentation for more information.
'Doxygen' Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting.
'sem-ver' Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly.

Configuration

All configuration is now handled by the installer.

Running via the Django test server might be possible, albeit not recomended.

In Progress

Organizational tools.
Docker image for those who need it.
Improved cover image storage, and acquisition.

Future Goals

Support for other book formats (Currently only supporting EPUBS)
Terminal Backend for catalogue maintenance
Calculate page count from total characters
- (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3
Reader for easy integration with your catalogue