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

Use pre-commit

Browse Source 
[pre-commit](https://pre-commit.com/) automatically runs tools like
linters and fixers to make development easier. This change adds a simple
pre-commit config file with an example trailing whitespace fixer and
applies it to the existing project.

Additionally, don't ignore the lib directory (an error introduced in #8).
This commit is contained in:
Jon Banafato
2019-11-09 10:33:47 -05:00
parent 2ff0d35f4b
commit df4dd93347
5 changed files with 26 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -4,15 +4,22 @@ A simple terminal based ebook server
Frustrated with Calibre being my only option for hosting my eBook collection, I have decided to spin up my own.
Calibre is a great organizational tool for your books, however not having a terminal based option for running and maintaining
a server is cumbersome when running on a headless server.
a server is cumbersome when running on a headless server.
Calibre does have a console based server solution, However there is currently no way to create, and manage your library in a headless enviroment.
Thus I am creating pyShelf and I hope to be able to provide all the functionality required to organize and host all your ebooks.
I am open to and hoping for community help in the design and execution of this program.
## Development
pyShelf uses [`pre-commit`](https://pre-commit.com/) to automate some tasks.
Before developing, run `pre-commit install`.
See the [documentation](https://pre-commit.com/) for more information.
## Configuration
All configuration is done in config.py.
The only currently required configuration is to set book_path to the location of your books.
## Current Features
Currently pyShelf will recursively scan your collection, extract and store some metadata in the sqlite database.
The basic template system is in place, as well as a template mockup. This can be seen hosted on port 8000
@@ -21,7 +28,7 @@ The basic template system is in place, as well as a template mockup. This can be
* HTML Frontend for file transfers
* HTML Backend for catalogue maintenance
* Terminal Backend for catalogue maintenance
* Calculate page count from total characters
* Calculate page count from total characters
* (Thanks to @Fireblend for the idea) https://github.com/th3r00t/pyShelf/issues/3
* Move towards sqlAlchemy and enable user to specify desired storage system
* (Thanks to Sarcism) over on r/opensource for this idea!