# 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/scrollmapper/bible_databases](https://github.com/scrollmapper/bible_databases), which includes 140 translations across many languages. Check the [available translations](https://github.com/scrollmapper/bible_databases?tab=readme-ov-file#available-translations-140) 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 phrase throughout the Bible:
```
bible search 'prince of peace'
```
Translation is specified via the `-t, --translation` flag:
```
bible search 'prince of peace' -t BSB
```
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
```
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
```
<!-- TODO: Development -->
Raw data
{
"_id": null,
"home_page": null,
"name": "berea",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "bible, cli, find, lookup, reference, scripture, search, verse",
"author": "Jamie Stadnik",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/67/bd/11a1a91dc156de549cef5ee93b572b1fe023b35986821e4e1e874c910610/berea-0.1.0.tar.gz",
"platform": null,
"description": "# Berea: A CLI for studying Scripture\n\n## Installation\n\n```\npip install berea\n```\n\n## Usage\n### Manage Translations\n\nOnce installed, download a Bible translation:\n\n```\nbible download KJV\n```\n\nTranslations are downloaded from [github.com/scrollmapper/bible_databases](https://github.com/scrollmapper/bible_databases), which includes 140 translations across many languages. Check the [available translations](https://github.com/scrollmapper/bible_databases?tab=readme-ov-file#available-translations-140) 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.\n\nRun the `config` command to manually set the default translation:\n\n```\nbible config translation BSB\n```\n\nThe default translation must be set to a downloaded translation.\n\nTo delete a translation, run the following command:\n\n```\nbible delete KJV\n```\n\n### Reference\n\nThe `reference` command looks up a passage in the Bible, eg. a specific verse like so:\n\n```\nbible reference john 3 16\n```\n\n`reference` (the default command) is executed if no other command is specified:\n\n```\nbible john 3 16\n```\n\nSimilarly, reference a passage:\n\n```\nbible matthew 5 1-11\n```\n\nReference a chapter:\n\n```\nbible psalm 117\n```\n\nReference an entire book:\n\n```\nbible 3john\n```\n\nThe default translation is used unless otherwise specified via the `-t, --translation` flag:\n\n```\nbible john 3 16 -t BSB\n```\n\nDownloaded translations are displayed in the `--translation` flag description of the `reference` help text:\n\n```\nbible reference --help\n```\n\nVerse numbers can be toggled on using the `-n, --numbers` flag.\n\n```\nbible matthew 5 1-11 -n\n```\n\nThe output format is specified using the `-f, --format` flag (default: `txt` or plaintext).\n\n```\nbible matthew 5 1-11 -f md\n```\n\n### Search\n\nThe `search` command finds all occurrences of a phrase throughout the Bible:\n\n```\nbible search 'prince of peace'\n```\n\nTranslation is specified via the `-t, --translation` flag:\n\n```\nbible search 'prince of peace' -t BSB\n```\n\nA phrase can be searched in a particular book:\n\n```\nbible search martha john\n```\n\nor a specific chapter:\n\n```\nbible search justification rom 4\n```\n\nSearch a phrase within the New Testament:\n\n```\nbible search ghost -NT\n```\n\nor the Old Testament:\n\n```\nbible search 'holy spirit' -OT\n```\n\nFor large results sets, consider saving the output to a file:\n\n```\nbible search fulfilled -NT >> search_fulfilled.txt\n```\n\n### Book Abbreviations\n\nBooks are referenced using the following titles and abbreviations (case-insensitive).\n\n```\nGenesis: genesis, gen, ge, gn\nExodus: exodus, ex, exod, exo\nLeviticus: leviticus, lev, le, lv\nNumbers: numbers, num, nu, nm, nb\nDeuteronomy: deuteronomy, deut, de, dt\nJoshua: joshua, josh, jos, jsh\nJudges: judges, judg, jdg, jg, jdgs\nRuth: ruth, rth, ru\nI Samuel: 1st samuel, 1 sam, 1sam, 1sm, 1sa, 1s, 1 samuel, 1samuel, 1st sam, first samuel, first sam\nII Samuel: 2nd samuel, 2 sam, 2sam, 2sm, 2sa, 2s, 2 samuel, 2ndsam, 2nd sam, second samuel, second sam\nI Kings: 1st kings, 1kings, 1 kings, 1kgs, 1 kgs, 1ki, 1k, 1stkgs, first kings, first kgs\nII Kings: 2nd kings, 2kings, 2 kings, 2kgs, 2 kgs, 2ki, 2k, 2ndkgs, second kings, second kgs\nI Chronicles: 1st chronicles, 1chronicles, 1 chronicles, 1chr, 1 chr, 1ch, 1stchr, 1st chr, first chronicles, first chr\nII Chronicles: 2nd chronicles, 2chronicles, 2 chronicles, 2chr, 2 chr, 2ch, 2ndchr, 2nd chr, second chronicles, second chr\nEzra: ezra, ezr, ez\nNehemiah: nehemiah, neh, ne\nEsther: esther, est, esth, es\nJob: job, jb\nPsalms: psalms, ps, psalm, pslm, psa, psm, pss\nProverbs: proverbs, prov, pro, prv, pr\nEcclesiastes: ecclesiastes, eccles, eccle, ecc, ec, eccl, qoh\nSong of Solomon: song of solomon, song, song of songs, sos, so, canticle of canticles, canticles, cant\nIsaiah: isaiah, isa, is\nJeremiah: jeremiah, jer, je, jr\nLamentations: lamentations, lam, la\nEzekiel: ezekiel, ezek, eze, ezk\nDaniel: daniel, dan, da, dn\nHosea: hosea, hos, ho\nJoel: joel, jl\nAmos: amos, am\nObadiah: obadiah, obad, ob\nJonah: jonah, jnh, jon\nMicah: micah, mic, mc\nNahum: nahum, nah, na\nHabakkuk: habakkuk, hab, hb\nZephaniah: zephaniah, zeph, zep, zp\nHaggai: haggai, hag, hg\nZechariah: zechariah, zech, zec, zc\nMalachi: malachi, mal, ml\nMatthew: matthew, matt, mt\nMark: mark, mrk, mar, mk, mr\nLuke: luke, luk, lk\nJohn: john, joh, jhn, jn\nActs: acts, act, ac\nRomans: romans, rom, ro, rm\nI Corinthians: 1 corinthians, 1corinthians, 1 cor, 1cor, 1 co, 1co, 1st corinthians, first corinthians\nII Corinthians: 2 corinthians, 2corinthians, 2 cor, 2cor, 2 co, 2co, 2nd corinthians, second corinthians\nGalatians: galatians, gal, ga\nEphesians: ephesians, eph, ephes\nPhilippians: philippians, phil, php, pp\nColossians: colossians, col, co\nI Thessalonians: 1 thessalonians, 1thessalonians, 1 thess, 1thess, 1 thes, 1thes, 1 th, 1th, 1st thessalonians, 1st thess, first thessalonians, first thess\nII Thessalonians: 2 thessalonians, 2thessalonians, 2 thess, 2thess, 2 thes, 2thes, 2 th, 2th, 2nd thessalonians, 2nd thess, second thessalonians, second thess\nI Timothy: 1 timothy, 1timothy, 1 tim, 1tim, 1 ti, 1ti, 1st timothy, 1st tim, first timothy, first tim\nII Timothy: 2 timothy, 2timothy, 2 tim, 2tim, 2 ti, 2ti, 2nd timothy, 2nd tim, second timothy, second tim\nTitus: titus, tit, ti\nPhilemon: philemon, philem, phm, pm, phlm\nHebrews: hebrews, heb\nJames: james, jas, jm\nI Peter: 1 peter, 1peter, 1 pet, 1pet, 1 pe, 1pe, 1 pt, 1pt, 1p, 1st peter, first peter\nII Peter: 2 peter, 2peter, 2 pet, 2pet, 2 pe, 2pe, 2 pt, 2pt, 2p, 2nd peter, second peter\nI John: 1 john, 1john, 1 jhn, 1jhn, 1 jn, 1jn, 1j, 1st john, first john\nII John: 2 john, 2john, 2 jhn, 2jhn, 2 jn, 2jn, 2j, 2nd john, second john\nIII John: 3 john, 3john, 3 jhn, 3jhn, 3 jn, 3jn, 3j, 3rd john, third john\nJude: jude, jud, jd\nRevelation of John: revelation, rev, re, the revelation\n```\n\n<!-- TODO: Development -->\n",
"bugtrack_url": null,
"license": null,
"summary": "Berea: A CLI for studying Scripture.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/JStadnik619/berea"
},
"split_keywords": [
"bible",
" cli",
" find",
" lookup",
" reference",
" scripture",
" search",
" verse"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e5f3ddb7efcdb08cd50fd4fe436930097be389082f35d114032229b1e9f36366",
"md5": "dd8b0f23633ea8ee0ee40421991f3bba",
"sha256": "c48f238cb7786bd9ac11aaccd91b802dd979222887ce2c8c1687bb88fbb3f9c3"
},
"downloads": -1,
"filename": "berea-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dd8b0f23633ea8ee0ee40421991f3bba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13228,
"upload_time": "2025-08-02T12:09:38",
"upload_time_iso_8601": "2025-08-02T12:09:38.080005Z",
"url": "https://files.pythonhosted.org/packages/e5/f3/ddb7efcdb08cd50fd4fe436930097be389082f35d114032229b1e9f36366/berea-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "67bd11a1a91dc156de549cef5ee93b572b1fe023b35986821e4e1e874c910610",
"md5": "ff055f5056459b3905cbadd20154ed80",
"sha256": "b0d1cf211448fe8f6c252610da1ce8a0f13e712f8bec1dd6ca60626e0ca70a44"
},
"downloads": -1,
"filename": "berea-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ff055f5056459b3905cbadd20154ed80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 17093,
"upload_time": "2025-08-02T12:09:37",
"upload_time_iso_8601": "2025-08-02T12:09:37.161023Z",
"url": "https://files.pythonhosted.org/packages/67/bd/11a1a91dc156de549cef5ee93b572b1fe023b35986821e4e1e874c910610/berea-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-02 12:09:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JStadnik619",
"github_project": "berea",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "berea"
}
JSON
