46 lines
1.4 KiB
Plaintext
46 lines
1.4 KiB
Plaintext
KJV-API
|
|
=======
|
|
King James Version web API is a machine and human callable service to
|
|
query the King James Bible and provides useful features, such as random
|
|
verses and a quote of the day.
|
|
|
|
|
|
EXTERNAL DATA
|
|
=============
|
|
The software uses a sqlite3 database as external data dependancy, saved locally
|
|
and modified to remove false Bible translations (included)
|
|
https://github.com/scrollmapper/bible_databases
|
|
|
|
For software dependancies see INSTALL.txt
|
|
|
|
|
|
INSTALLATION
|
|
============
|
|
See INSTALL.TXT
|
|
|
|
USAGE
|
|
=====
|
|
The program may be invoked by running kjv-api.sh in a non-root account, or via
|
|
systemd daemon process in a non-root account.
|
|
Alternately for testing, the program may be run on another port by running:
|
|
$ uwsgi_python3 --http-socket <listen address>:<port> --wsgi-file /opt/kjv-api/app.py --callable app
|
|
or by executing kjv-api-test.sh which will listen on 0.0.0.0:1612
|
|
|
|
Visiting the base directory will show the user-facing documentation via web browser or cURL.
|
|
|
|
CONTENTS
|
|
========
|
|
app.py - main flask program
|
|
install/ - folder containing sample configurations
|
|
kjv.db - King James Bible database
|
|
index.html - root document help file - user-facing documentation
|
|
INSTALL.txt - detailed installation instructions
|
|
kjv-api.sh - script that properly runs flask through uwsgi
|
|
kjv-api-test.sh - script that properly runs flask through uwsgi on port 1612 and global listening
|
|
README.txt - this file
|
|
|
|
|
|
AUTHOR
|
|
======
|
|
Copyright Tyler R Dinsmoor 2023
|