You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Alex e171ab6247 new requirements 3 years ago
app run on sqlite and be more stable 3 years ago
whoosh/Book adding annotations branch 6 years ago
.DS_Store interfaces updated 6 years ago
.gitignore default covers fix 6 years ago
README.md new requirements 3 years ago
import_csv.py update upload form extra questions 6 years ago
init.py Import csv works! Many to many books and authors is also nice 7 years ago
init_db.sh GRADIENT 6 years ago
rebuild.py added search all functionality with flask-whooshalchemyplus 7 years ago
run.py changes to annotations 6 years ago
test.py rqlite update 7 years ago
test2.py rqlite update 7 years ago
xpublibrary.csv test commit 7 years ago
xpublibrary_including_filelinks.csv default covers fix 6 years ago
xpublibrary_including_filelinks2.csv default covers fix 6 years ago
xpublibrary_old.csv some awesome stacks 7 years ago

README.md

XPPL version alt

Library to hold books / knowledge

TO DOs

[] fix adding stacks [] update requirements [ ] generate new requirements.txt and installation process? [ ] fix stacks layout [ ] remove autocomplete? and training at the start of app [ ] update layout navigation

Installation

Install the required dependencies:

$ pip3 install -r requirements.txt

Initialise database / Why is this needed again, could be checked in flask?

$ bash init_db.sh

Further install notes (bugs)

  • create the covers folder inside the uploadsfolder

  • don't forget to chmod the uploads and coverfolder ;-)

  • For Mac users -> brew install imagemagick@6 in order to install wand (should not be relevant for debian server install)

Run the program

Run the script in another terminal (from XPPL directory):

python3 run.py

Deploy on server

(this will be added soon)

REST API

Has currently 2 entrypoints:

/api/books GETs all the books in the database

/api/book/id GETs a specific book by its id