From e0945e80db10df75d0868b82d7d986955b116588 Mon Sep 17 00:00:00 2001 From: Camil Staps Date: Tue, 29 Sep 2015 22:44:23 +0200 Subject: Script to read Bible Hub database; Readme --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 5c4fd7c..7038cb3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,47 @@ # pyble Python Bible tools + +This is a Python toolbox to analyse the Bible. + +Copyright © 2015 Camil Staps. See license details below. + +## Overview + +The Bible is stored in an SQLite database with the structure: + +Table | Column | Data type | Specials +-------------|---------------|-----------|--------------------------- +book | name | TEXT | PK +reference | book | TEXT | PK, FK book.name +reference | chapter | INTEGER | PK +reference | verse | INTEGER | PK +translation | name | TEXT | PK +text | translation | TEXT | PK, FK translation.name +text | book | TEXT | PK, FK reference.book +text | chapter | INTEGER | PK, FK reference.chapter +text | verse | INTEGER | PK, FK reference.verse +text | text | TEXT | + +(PK: primary key; FK: foreign key) + +## Setting up + +You're going to need one or several translations. One possibility is to [get them from Bible Hub][biblehubdb]. Download and unzip the zipped text file, then run `read-biblehub-db.py`. + +## To do + +Add a table for cross references, and a script to read in the database from [OpenBible.info][openbibledb]. + +Make a web frontend for anyone to search, add cross references, and vote for cross references. + +## Troubleshooting + +In case anything goes wrong, first check you're using **Python 3**. + +## License + +This project is licensed under the GPLv2 license. + +[biblehubdb]: http://biblehub.net/database/ +[openbibledb]: http://www.openbible.info/labs/cross-references/ + -- cgit v1.2.3