Home

Introduction.

This program is called Python Bible Reading Module (PBRM for short).
It’s my first published program, which I published a few yeas ago while I was 14.

If this is the first time you’ve downloaded this package and read this readme file, you’re lucky.
The readme file I wrote when I was 14 was horrific. Explaining things in a complicated manner and filled with spelling mistakes.

I hope this rewritten version of the readme file is easier to understand.

PBRM comes with no installer. So for PBRM to work you either need to place it in the python site-packages folder or place it in the same directory as your code.

PBRM is designed and made with python 3.6.4, but should work with most versions including python 2.

Open Source.
PBRM is in the public domain and is completely open source. You are free to tinker around with it as much as you like.
If you do improve it, or discover a bug, can you please contact me via email at lachlanimcilroy@gmail.com.

Bible Versions.
Due to copyright, all the bibles versions that come with PBRM are in the public domain.
The full list of versions is:
1. World English Bible
2. New Heart English Bible
3. American Standard Version
4. King James Version
5. Young's Literal Translation
6. Bible in Basic English
7. Catholic Public Domain Version

Though the first version of PBRM came out with the 1984 version of NIV. I had to remove it due to copyright
And It should be noted that the Catholic Public Domain Version contains the Deuterocanonical books, and is not officially recognised by the Catholic faith.

The two ways to use PBRM
14 year old me decide it would be a good idea to have two ways to achieve the same result. I’ll be showing you the two different ways to use PBRM.

Here is the first way:

from PBRM import bible_manager #imports bible_manager from PBRM

bible = bible_manager() #sets up a bible manager object
web = bible.import_bible("World English Bible") #This function returns a dictionary with the “World English Bible” in it.
#Within this dictionary, are several more dictionaries named after each book of the Bible. 
#Inside each of those dictionaries, are more dictionaries for each chapter of that book. 
#And inside each of those dictionaries, are more dictionaries containing a string of each verse for that chapter.

#you can then print a bible verse as follows.
print (web["Genesis"]["1"]["2"] #prints Genesis 1:2
#It should be noted that the names for each dictionary are strings, not integers.

Then there’s the other way of doing it, which is very similar:

from PBRM import bible_manager
bible = bible_manager( version="World English Bible" ) 
#The same as last time, except this time we’re setting up the bible manager object to automatically import a bible version, and store in within the object.

#The bible dictionary is saved as “bible” inside the bible_manager object
#It can be accessed as follows:
print (bible.bible["John"]["1"]["5]) #prints John 1:5

Other commands and variables.
With the bible_manager object set up you can access the following:

bible_manager.version
If you set up the bible_manager object with a bible version, this variable will contain the name of the version you’re using.
If you don’t set up the bible_manager object with a bible version, then the value will be None.

bible_manager.versions
This variable contains a list of available bible versions.

bible_manager.list_of_versions()
If the versions variable isn’t good enough for you, then you can call this function instead.
As well as returning a list of available versions, this function checks the PBRM directories to see if any new versions have been added
since the bible_manager object was initiated.

bible_manager.get_info(bible_version_name_here)
This will return a little bit of information about the bible version you typed in.
It will return none if you mistyped the bible version name, or if there’s no information supplied with it.

Adding new Bible versions in
It is possible to add new bible version in.

The first step is to create a new directory inside the PBRM\versions folder, and call it the name of the bible version you are adding.
Next step is to create a file called “read.py” inside of this new directory.
Inside “read.py” should be a directory containing the bible
(preferably in the same “Book name”, “Chapter number as string” and “Verse number as string” format, as the other bible versions used in PBRM).
And if you want to, add a variable called “info” containing a string with information about the bible version you added.

Thanks for reading this!
If I wasn’t clear about something and you have questions, don’t hesitate to contact me,
either through SourceForge or my email lachlanimcilroy@gamil.com.

And can you please consider giving my package a rating on SourceForge.
Nobody’s rated my program so far (as of writing this) and it makes me a little sad ☹.

Thanks,
Lachlan