2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00
2022-12-29 12:53:15 -08:00

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 these JSON data stores as external dependancies, saved locally (included)
https://github.com/scrollmapper/bible_databases/blob/master/json/t_kjv.json
https://github.com/scrollmapper/bible_databases/blob/master/json/key_english.json

For additional 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

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
key_english.json - King James Bible books by index in JSON
t_kjv.json - King James Bible in JSON
index.html - root document help file - user-facing documentation
INSTALL.txt - detailed installation instructions
kjv-api.sh - script that properly runs flask through uwsgi
README.txt - this file


AUTHOR
======
Copyright Tyler R Dinsmoor 2022
S
Description
Web-based KJV tools
https://api.1611.social
Readme 20 MiB
Languages
Python 68.8%
HTML 16.1%
CSS 12%
Shell 2%
JavaScript 1.1%