th3r00t/pyShelf
1
0
Fork 0
mirror of https://github.com/th3r00t/pyShelf.git synced 2026-04-28 01:59:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Raelon Masters
2020-05-11 19:20:37 -04:00
parent 8d967a93a9
commit b2f61df59e
1 changed files with 27 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md vendored
View File

@@ -1,20 +1,20 @@
# pyShelf 0.4.1
# pyShelf 0.5.0
<p align="center"><b>Terminal based ebook server. Open source & Lightweight.</b></p>
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/D1D51ALZH)
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](https://discord.gg/H9TbNJS) | IRC freenode.net @ #pyshelf
## Current Features
* Custom Installer
* Custom Installer -- For 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
## Currently Supported Formats
* epub
@@ -25,23 +25,34 @@ Having used Calibre for hosting my eBook collection in the past, I found myself
## Further Installation & Support Information
* [SUPPORT.md](https://github.com/th3r00t/pyShelf/blob/development/.github/SUPPORT.md)
## 0.5.0 Patch Notes.
### 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 however not
running any other distros myself I will not be including support. Members of
the community are welcome to dig into the installer source and patch in support
for other package managers.
## 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`](https://pre-commit.com/)