Skip to content
A simple terminal based ebook server
Python
Branch: development
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix syntax Dec 20, 2019
data fix data/ being ignored Dec 1, 2019
docs Incremented version number Jan 1, 2020
src Incremented version number Jan 1, 2020
.gitattributes Fix reporting wrong language to github Nov 30, 2019
.gitignore Stop tracking installer generated config files Jan 1, 2020
.pre-commit-config.yaml
LICENSE
README.md
config.json Finished ui design, system dependency installs, nginx config file gen… Dec 29, 2019
doxygen.conf Increment Version Number Jan 1, 2020
importBooks
install.sh Finished installer Dec 30, 2019
installer Removed postgresql-contrib Jan 1, 2020
pyproject.toml Finished ui design, system dependency installs, nginx config file gen… Dec 29, 2019
requirements.txt
uwsgi.ini Finished ui design, system dependency installs, nginx config file gen… Dec 29, 2019
uwsgi_params basic uwsgi configs for nginx integration Nov 19, 2019

README.md

pyShelf 0.4.0

Terminal based ebook server. Open source & Lightweight.

ko-fi

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.

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

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.

0.3.0 Patch Notes.

"And now we search."

Just about all the changes in this release were in some way related to implementing the search features. There is one new requirement

  • Requirement: PostgreSQL This is what I believe to be the last infrastructure requirement, users with larger libraries should notice an increase in access speed.
  • Feature: Searching The search feature is now implemented. In its current incarnation you will by default search the author, title, & file_name fields. More defined search options will be available in future releases. Searches are paginated @ 20 results per page.
  • Discord https://discord.gg/H9TbNJS
  • IRC find us on freenode.net @ #pyshelf

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
  • Reader for easy integration with your catalogue
You can’t perform that action at this time.