Skip to main content

Berea: A CLI for studying Scripture.

Project description

Berea: A CLI for studying Scripture

Installation

pip install berea

Usage

Manage Translations

Once installed, download a Bible translation:

bible download KJV

Translations are downloaded from github.com/jstadnik619/bible_databases, which includes 140 translations across many languages. Check the available translations for more information. One or more translations may be downloaded. The first download is set as the default translation for the reference and search commands described below.

Run the config command to manually set the default translation:

bible config translation BSB

The default translation must be set to a downloaded translation.

To delete a translation, run the following command:

bible delete KJV

Reference

The reference command looks up a passage in the Bible, eg. a specific verse like so:

bible reference john 3 16

reference (the default command) is executed if no other command is specified:

bible john 3 16

Similarly, reference a passage:

bible matthew 5 1-11

Reference a chapter:

bible psalm 117

Reference an entire book:

bible 3john

The default translation is used unless otherwise specified via the -t, --translation flag:

bible john 3 16 -t BSB

Downloaded translations are displayed in the --translation flag description of the reference help text:

bible reference --help

Verse numbers can be toggled on using the -n, --numbers flag.

bible matthew 5 1-11 -n

The output format is specified using the -f, --format flag (default: txt or plaintext).

bible matthew 5 1-11 -f md

Search

The search command finds all occurrences of a tokenized phrase throughout the Bible:

bible search 'burning bush'

Translation is specified via the -t, --translation flag:

bible search 'burning bush' -t BSB

To search an exact phrase, enclose it in double quotes:

bible search '"prince of peace"'

A phrase can be searched in a particular book:

bible search martha john

or a specific chapter:

bible search justification rom 4

Search a phrase within the New Testament:

bible search ghost -NT

or the Old Testament:

bible search '"holy spirit"' -OT

To search a prefix, use the * operator:

bible search 'glor*' john 17

The search command also supports boolean operators (AND, OR, NOT). For example, to search all instances of 'mercy' in Exodus that are not referencing the mercy seat:

bible search 'mercy NOT seat' exo

Similarly, to search all mentions of James in Acts that do not reference the son of Alphaeus or the brother of John:

bible search 'james NOT ("son of alphaeus" OR john)' acts

More info on the search syntax is provided here.

For large results sets, consider saving the output to a file:

bible search fulfilled -NT >> search_fulfilled.txt

Book Abbreviations

Books are referenced using the following titles and abbreviations (case-insensitive).

Genesis: genesis, gen, ge, gn
Exodus: exodus, ex, exod, exo
Leviticus: leviticus, lev, le, lv
Numbers: numbers, num, nu, nm, nb
Deuteronomy: deuteronomy, deut, de, dt
Joshua: joshua, josh, jos, jsh
Judges: judges, judg, jdg, jg, jdgs
Ruth: ruth, rth, ru
I Samuel: 1st samuel, 1 sam, 1sam, 1sm, 1sa, 1s, 1 samuel, 1samuel, 1st sam, first samuel, first sam
II Samuel: 2nd samuel, 2 sam, 2sam, 2sm, 2sa, 2s, 2 samuel, 2ndsam, 2nd sam, second samuel, second sam
I Kings: 1st kings, 1kings, 1 kings, 1kgs, 1 kgs, 1ki, 1k, 1stkgs, first kings, first kgs
II Kings: 2nd kings, 2kings, 2 kings, 2kgs, 2 kgs, 2ki, 2k, 2ndkgs, second kings, second kgs
I Chronicles: 1st chronicles, 1chronicles, 1 chronicles, 1chr, 1 chr, 1ch, 1stchr, 1st chr, first chronicles, first chr
II Chronicles: 2nd chronicles, 2chronicles, 2 chronicles, 2chr, 2 chr, 2ch, 2ndchr, 2nd chr, second chronicles, second chr
Ezra: ezra, ezr, ez
Nehemiah: nehemiah, neh, ne
Esther: esther, est, esth, es
Job: job, jb
Psalms: psalms, ps, psalm, pslm, psa, psm, pss
Proverbs: proverbs, prov, pro, prv, pr
Ecclesiastes: ecclesiastes, eccles, eccle, ecc, ec, eccl, qoh
Song of Solomon: song of solomon, song, song of songs, sos, so, canticle of canticles, canticles, cant
Isaiah: isaiah, isa, is
Jeremiah: jeremiah, jer, je, jr
Lamentations: lamentations, lam, la
Ezekiel: ezekiel, ezek, eze, ezk
Daniel: daniel, dan, da, dn
Hosea: hosea, hos, ho
Joel: joel, jl
Amos: amos, am
Obadiah: obadiah, obad, ob
Jonah: jonah, jnh, jon
Micah: micah, mic, mc
Nahum: nahum, nah, na
Habakkuk: habakkuk, hab, hb
Zephaniah: zephaniah, zeph, zep, zp
Haggai: haggai, hag, hg
Zechariah: zechariah, zech, zec, zc
Malachi: malachi, mal, ml
Matthew: matthew, matt, mt
Mark: mark, mrk, mar, mk, mr
Luke: luke, luk, lk
John: john, joh, jhn, jn
Acts: acts, act, ac
Romans: romans, rom, ro, rm
I Corinthians: 1 corinthians, 1corinthians, 1 cor, 1cor, 1 co, 1co, 1st corinthians, first corinthians
II Corinthians: 2 corinthians, 2corinthians, 2 cor, 2cor, 2 co, 2co, 2nd corinthians, second corinthians
Galatians: galatians, gal, ga
Ephesians: ephesians, eph, ephes
Philippians: philippians, phil, php, pp
Colossians: colossians, col, co
I Thessalonians: 1 thessalonians, 1thessalonians, 1 thess, 1thess, 1 thes, 1thes, 1 th, 1th, 1st thessalonians, 1st thess, first thessalonians, first thess
II Thessalonians: 2 thessalonians, 2thessalonians, 2 thess, 2thess, 2 thes, 2thes, 2 th, 2th, 2nd thessalonians, 2nd thess, second thessalonians, second thess
I Timothy: 1 timothy, 1timothy, 1 tim, 1tim, 1 ti, 1ti, 1st timothy, 1st tim, first timothy, first tim
II Timothy: 2 timothy, 2timothy, 2 tim, 2tim, 2 ti, 2ti, 2nd timothy, 2nd tim, second timothy, second tim
Titus: titus, tit, ti
Philemon: philemon, philem, phm, pm, phlm
Hebrews: hebrews, heb
James: james, jas, jm
I Peter: 1 peter, 1peter, 1 pet, 1pet, 1 pe, 1pe, 1 pt, 1pt, 1p, 1st peter, first peter
II Peter: 2 peter, 2peter, 2 pet, 2pet, 2 pe, 2pe, 2 pt, 2pt, 2p, 2nd peter, second peter
I John: 1 john, 1john, 1 jhn, 1jhn, 1 jn, 1jn, 1j, 1st john, first john
II John: 2 john, 2john, 2 jhn, 2jhn, 2 jn, 2jn, 2j, 2nd john, second john
III John: 3 john, 3john, 3 jhn, 3jhn, 3 jn, 3jn, 3j, 3rd john, third john
Jude: jude, jud, jd
Revelation of John: revelation, rev, re, the revelation

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

berea-0.1.2.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

berea-0.1.2-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file berea-0.1.2.tar.gz.

File metadata

  • Download URL: berea-0.1.2.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for berea-0.1.2.tar.gz
Algorithm Hash digest
SHA256 dcaf6e1a75cf1f5b12f50b2f19ed0572ee4c86292f9e925aef8995ae51d6b1b8
MD5 f8e543c8bacf682e9046b5b7c2052496
BLAKE2b-256 b94961e057c9d3c56f4710584a9982c16cb363bc531bab75e5c112a4572db22c

See more details on using hashes here.

File details

Details for the file berea-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: berea-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for berea-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 37925315c5ae841cb4c03af0c5c92ce7c41253b5fe1a8ae6fb7ada6794f4f0c0
MD5 0ef95068e9e032ab7b885dfc4360d7ec
BLAKE2b-256 36c0f99f98611ebee97191ea93e94402108bb7bf2837baada80140a95410d38b

See more details on using hashes here.

Supported by

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