Skip to main content

A CLI tool to look up Bible verses locally.

Project description

grepbible

grepbible is a command-line interface (CLI) tool designed to make searching for Bible verses (in ca. 70 languages) locally (like grepping) and looking up the Bible quotes fast and intuitive. It also represents a new channel for Bible distribution, and helps language learners as well since parallel Bible translations were used for languages learning for centuries.

Wikipedia article on Bible citations The raw text is taken from Wordproject®

Features

  • Versatile Search Capabilities: Look up individual verses, ranges of chapters, or specific passages across multiple translations.
  • Multiple Bible Versions: Easily switch between different Bible translations to compare interpretations and wording.
  • Local Caching: Bible versions are downloaded and stored locally for quick access and offline use.
  • Customizable: Set your preferred Bible version and customize search options to suit your study needs.

Installation

To install grepbible, ensure you have Python 3.9 or higher installed on your system. You can install grepbible directly from PyPI:

pip install grepbible

This command installs the grepbible package and makes the gbib command available in your shell.

Usage

grepbible is designed to be straightforward and easy to use from the command line. The default version (unless the flag -v is specified) is 'kj' (KJV), in English.

Below are some common usage examples:

Look Up a Single Verse

gbib -c "John 3:11"
Verily, verily, I say unto thee, We speak that we do know, and testify that we have seen; and ye receive not our witness.

Compare Verses in Different Translations

gbib -v kj,pl -c "Romans 8:20"
For the creature was made subject to vanity, not willingly, but by reason of him who hath subjected the same in hope,
Gdyż stworzenie marności jest poddane, nie dobrowolnie, ale dla tego, który je poddał,

Lookup a Chapter

gbib -c "Psalms 23"

Show a Range of Verses

gbib -c "Gen 41:29-30"
Behold, there come seven years of great plenty throughout all the land of Egypt:
And there shall arise after them seven years of famine; and all the plenty shall be forgotten in the land of Egypt; and the famine shall consume the land;

Fetch Multiple Disjoint Verses

gbib -c "Genesis 1:1–3"

Compare different versions

Show interleave translation of Latin Vulgata to English KJV (line-by-line):

gbib -c 'Gen 41:29-30' -v kj,vg -i
Behold, there come seven years of great plenty throughout all the land of Egypt:
ecce septem anni venient fertilitatis magnae in universa terra Aegypti

And there shall arise after them seven years of famine; and all the plenty shall be forgotten in the land of Egypt; and the famine shall consume the land;
quos sequentur septem anni alii tantae sterilitatis ut oblivioni tradatur cuncta retro abundantia consumptura est enim fames omnem terram

Block-by block translation (omit the flag -i):

 gbib -c 'Gen 41:29-30' -v kj,vg 
Behold, there come seven years of great plenty throughout all the land of Egypt:
And there shall arise after them seven years of famine; and all the plenty shall be forgotten in the land of Egypt; and the famine shall consume the land;
ecce septem anni venient fertilitatis magnae in universa terra Aegypti
quos sequentur septem anni alii tantae sterilitatis ut oblivioni tradatur cuncta retro abundantia consumptura est enim fames omnem terram

For more information on command options and additional features, you can run:

gbib --help

Use with grep

One can literally use grep to look up the verses and leverage gbib only for downloading the sources. Here's how.

First, download KJV ('kj') and Vulgata ('vg'). The data is stored in $HOME/grepbible_data, thus, it makes sense to store it as a variable, e.g. the path to the 5th chapter of Exodus in KJV will be $HOME/grepbible_data/kj/Exodus/5.txt

gbib -d kj,vg
export GB=$HOME/grepbible_data/kj

Go to line

Example, jump 10th line of 5th chapter in Exodus:

less +10 $GB/Exodus/5.txt

Count occurences of words

How often the word 'camel' appears in the Bible:

grep -nr $GB -e camel | wc -l # 59

What was this quote about the sheep and wolves?

grep -nr $GB -e wolves | grep sheep

Result:

./grepbible_data/kj/Matthew/10.txt:16:Behold, I send you forth as sheep in the midst of wolves: be ye therefore wise as serpents, and harmless as doves.
./grepbible_data/kj/Matthew/7.txt:15:Beware of false prophets, which come to you in sheep's clothing, but inwardly they are ravening wolves.

Contributing

Contributions to grepbible are welcome! Whether it's adding new features, improving existing functionality, or reporting issues, your input is valuable. To raise an issue, go to 'Issues' tab, and click on 'New issue'.

To contribute code:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Commit your changes with clear, descriptive messages.
  4. Push your branch and submit a pull request.

Please ensure your code adheres to the project's style and quality standards. For major changes, please open an issue first to discuss what you would like to change.

License

grepbible is open-source software licensed under the MIT License. See the LICENSE file for more details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grepbible-0.1.7.tar.gz (12.5 kB view details)

Uploaded Source

Built Distribution

grepbible-0.1.7-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file grepbible-0.1.7.tar.gz.

File metadata

  • Download URL: grepbible-0.1.7.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for grepbible-0.1.7.tar.gz
Algorithm Hash digest
SHA256 20d3759267fcad8d09315e2574f9c4fd9d11d2ebadd3023c827330f56fad3d39
MD5 6477731e20c7e61a16c510f2297c830c
BLAKE2b-256 9149444b8abfdacb734744daace8664e1297e3d53da60a4ac3b7195064cc8e8c

See more details on using hashes here.

File details

Details for the file grepbible-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: grepbible-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for grepbible-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4ed9149e832663d92698efb71410bbfdf4f7663b91fa65a0d4587aa18ffdb23b
MD5 ffc9526db9892e0d986b8ce577b394f9
BLAKE2b-256 8d0a043afed3e720319c91678c38a276ddefbc0368c9f32676899a5e3ed5ff32

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page