PyShelf Code
FOSS Ebook Server, With no windowing requirements
Status: Alpha
Brought to you by:
raelonmasters
Menu
▾
▴
Tree [53b377] master / History
th3r00t
Raelon Masters
Read Me
pyShelf 0.5.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.
Screenshot is from v0.6.0 on the development branch
Discord | IRC freenode.net @ #pyshelf
## Current Features * Custom Installer -- pre-req installs work on Arch Based Distros Only * Recursive Scanning * Fast database access * Django based frontend * Basic seaching via a SearchVector of author, title, & file_name fields. * Ebook Downloading * Collections | 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 * development branch has mobi support! ## Installation Example pyShelf Installation Video ## Further Installation & Support Information * [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md) ## 0.5.0 Patch Notes. ### Pre-req Dependencies * gcc -- This will be installed by the new pre-installer script if its binary is not detected at /usr/bin/gcc Users on distros other then Arch should install gcc via their systems package manager prior to running the installer. * Python3 * pip ### New Features * Collections We are now categorizing your ebooks into collections based on the folder structure used to store them. Any folder after the root book folder is now considered as a collection. #### books/forgotten realms/ -> Forgotten Realms Collection. #### books/Dune/Prelude To Dune -> Dune, & Preluse To Dune Collections. In addition to the work on the collection system, a good deal of time was spent on the installer, and the concept of having an installer in the first place. I mainly wanted to make this project for Network Administrators, and other home enthusiasts whom I assume will know how to setup a Django app, and a Postgres server. Beyond that theres nothing the user has to do to make the system work... The installer will only run correctly on arch based distros. This could be easily rectified to include other package managers, Members of the community are welcome to dig into the installer source and patch in support for other package managers. There is some support for detection of the aptitude package manager installation already present in the source now, however it is not complete and should not be relied upon to be present in future releases unless completed by a member of the community, ## Development * [`pre-commit`](https://pre-commit.com/) _Before developing, run `pre-commit install` See the [documentation](https://pre-commit.com/) for more information._ * ['Doxygen'](http://www.doxygen.nl/) _Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting._ * ['sem-ver'](https://semver.org) _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. - [x] Automated Collections - [ ] Manual Collections - [ ] Books Removal - [ ] Access Restrictions - [ ] Metadata Manipulation - [ ] Others? #### Improved cover image storage, and acquisition. #### OPDS Support #### Support for other formats - [ ] .mobi - [ ] .pdf - [ ] .cbz - [ ] .zip (Zipped book folders, is this a new idea? (Consider storing your library folders zipped and retrieving a book on demand)) ### Future Goals #### Terminal Backend for catalogue maintenance #### Calculate page count from total characters * (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3
