diff options
| author | Camil Staps | 2015-10-04 14:31:38 +0200 |
|---|---|---|
| committer | Camil Staps | 2015-10-04 14:54:10 +0200 |
| commit | 5ea8db32ef9d5f788b854e82248cf62316ed0120 (patch) | |
| tree | 7f9e9992ec40f1017019cac02cf67c6ee27fc0c0 /README.md | |
| parent | Script to read Bible Hub database; Readme (diff) | |
Orator, Click
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 10 insertions, 21 deletions
@@ -5,28 +5,21 @@ This is a Python toolbox to analyse the Bible. Copyright © 2015 Camil Staps. See license details below. -## Overview +## Setting up -The Bible is stored in an SQLite database with the structure: +Install the necessary packages: -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 | + # pip3 install orator click -<sup>(PK: primary key; FK: foreign key)</sup> +First we need to setup an SQLite database: -## Setting up + $ ./cli.py init pyble.db + +You're going to need one or several translations. One possibility is to [get them from Bible Hub][biblehubdb] (take the "Text file (zipped, 5.5MB)"). Download and unzip the zipped text file, then run: -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`. + $ unzip bibles.zip + $ ./cli.py load --type=biblehub bibles.txt pyble.db + $ rm bibles.zip bibles.txt ## To do @@ -34,10 +27,6 @@ Add a table for cross references, and a script to read in the database from [Ope 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. |