aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b1135327212ebadaa45d9ed8e00e7224d098185d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# pyble
Python Bible tools

This is a Python toolbox to analyse the Bible.

Copyright © 2015 Camil Staps. See license details below.

## Setting up

Install the necessary packages:

    # pip3 install orator click

Edit the `config.py` to suit your needs. Then initialise the database:

    $ orator migrations:run -c config.py    # Create schema
    $ ./cli.py init                         # Fill with standard data

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:

    $ unzip bibles.zip
    $ ./cli.py load --type=biblehub bibles.txt
    $ rm bibles.zip bibles.txt

## Usage

See `./cli.py --help` for general instructions and `./cli.py command --help` for command specific instructions.

## Examples

    $ ./cli.py read 'John 1:1-3' --nl
    1:1 In the beginning was the Word, and the Word was with God, and the Word was God. 
    2 The same was in the beginning with God. 
    3 All things were made through him; and without him was not anything made that hath been made. 

## 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.

## License

This project is licensed under the GPLv2 license. 

[biblehubdb]: http://biblehub.net/database/
[openbibledb]: http://www.openbible.info/labs/cross-references/