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 version info, added release notes

Browse Source
This commit is contained in:
Mike Young
2019-12-13 22:30:02 -05:00
parent 242f63b6c7
commit fd9b155554
3 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md vendored
View File

@@ -1,11 +1,6 @@
# pyShelf 0.2.1
## Patch Notes.
* fixed missing src/interface/models.py. thanks to u/thelastpenguin212
* Removed un necessary data files from repo
# pyShelf 0.3.0
<p align="center"><b>A simple terminal based ebook server</b></p>
<a href="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a" target="_blank"><img src="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a.svg" /></a>
<img src="https://raw.githubusercontent.com/th3r00t/pyShelf/development/src/interface/static/img/pyShelf_frontend_0_1_0.png" alt="Server Frontend" align="center" />
Frustrated with Calibre being my only option for hosting my eBook collection, I have decided to spin up my own.
@@ -15,21 +10,39 @@ Calibre does have a console based server solution, However there is currently no
Thus I am creating pyShelf and I hope to be able to provide all the functionality required to organize and host all your ebooks.
<a href="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a" target="_blank"><img src="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a.svg" /></a>
* In addition to the above steps you must now also make the requisite changes in config.json to reflect the connection to your postgresql server
<img src="https://raw.githubusercontent.com/th3r00t/pyShelf/development/src/interface/static/img/pyShelf_frontend_0_1_0.png" alt="Server Frontend" align="center" />
I am open to and hoping for community help in the design and execution of this program.
## 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](https://discord.gg/H9TbNJS)
* IRC find us on freenode.net @ #pyshelf
## 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.
* [`pre-commit`](https://pre-commit.com/)
* Before developing, run `pre-commit install`.
* See the [documentation](https://pre-commit.com/) for more information.
pyShelf uses ['Doxygen'](http://www.doxygen.nl/) for source code documentation.
Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting.
* ['Doxygen'](http://www.doxygen.nl/)
* Any changes to source should be documented and have run doxygen doxygen.conf prior to commiting.
pyShelf follows ['sem-ver'](https://semver.org) standards. Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly.
* ['sem-ver'](https://semver.org)
* Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf accordingly.
## Configuration
All pyShelf configuration is done in config.py.
All pyShelf configuration is done in config.json.
* Be sure to set the path to your library, and database connection details.
### Nginx configuration
I have included a default nginx config file pyshelf_nginx.conf. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact.
@@ -43,27 +56,16 @@ Inside uwsgi.ini you should make changes to reflect your install directory, and
User configuration is contained within config.json in the project root. 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. It will also provide you with a web based frontend to view and download your books. Note that this is a very early alpha and lacking the ability to sort and search your collection. This feature is coming however.
Currently pyShelf will recursively scan your collection, extract and store some metadata in the sqlite database. It will also provide you with a web based frontend to view and download your books. The search feature is currently in its infancy, and by default searches the author, title, & file_name fields. There is no way to change this in the program right now.
Django has been implemented to power the frontend experience, and web based database maintenance. The first steps of which are included in this commit. Also the book database has been switched over to reflect this. A properly configured web server is required for hosting the frontend, configuration of which is outside of the scope of this readme. Running via the Django test server might be possible, albeit not recomended.
## New in 0.2.1
* UX
* Began implementing search functionality
* Switched to Postgresql as a default to enable better search functionality within Django, and speed up response time on queries.
## New in 0.2.0
* UI
* The UI has moved closer to what I have envisioned for this project, however more features and changes will be coming as needed to both the form and function.
* UX
* Results have now been limited to 20 per page. Currently this is hardcoded in however in the future it will be user definable.
* Previous page & next page buttons have been implemented, and are working.
Django has been implemented to power the frontend experience, and web based database maintenance. A properly configured web server is required for hosting the frontend, and a PostgreSQL server for the database, configuration of these servers is outside of the scope of this readme.
Running via the Django test server might be possible, albeit not recomended.
## In Progress
* UI/UX tweaks, including making the book display responsive. and not so ugly.
* Searching, & further organizational tools.
* Docker image for those who need it.
* Improved cover image storage, and acquisition.
## Future Goals

2
config.json vendored
View File

@@ -1,6 +1,6 @@
{
"TITLE": "pyShelf E-Book Server",
"VERSION": "0.2.1",
"VERSION": "0.3.0",
"BOOKPATH": "books/",
"DATABASE": "pyshelf",
"USER": "pyshelf",

2
doxygen.conf vendored
View File

@@ -38,7 +38,7 @@ PROJECT_NAME = "pyShelf Open Source Ebook Server"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 0.2.1
PROJECT_NUMBER = 0.3.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a