biblestudy 1.4.1

A text-based Bible study companion for your terminal

biblestudy-cli

BibleStudy CLI — a text-based Bible study companion for your terminal.

Powered by api.bible, api.nlt.to, api.esv.org, and OpenAI.
Inspired by SimplyScripture.

Note: Neither I nor this tool are affiliated with SimplyScripture — I just like their concept and wanted a CLI version.

---

✨ Features

• Input or detect Bible references (e.g., John 3:16)
• Choose from the following translations:
  • ✅ NLT (New Living Translation) — via api.nlt.to
  • ✅ ESV (English Standard Version) — via api.esv.org
  • ✅ FBV (Free Bible Version)
  • ✅ KJV (King James Version)
  • ✅ ASV (American Standard Version)
  • ✅ WEB (World English Bible)
• Retrieve verse content and:
  • ✏️ Simplify it
  • 🗣️ Translate into modern speech
  • 🏺 Reveal historical background
  • 🔗 Cross-reference other scriptures
  • 🔍 Highlight key terms
  • 🛠️ Apply to daily life
• 📅 Verse of the Day support (automatically shown on launch or via Option 9)
• Save study notes automatically
• Works in any terminal — beautiful output powered by rich

---

🚀 Quickstart

🔐 API Keys Setup

You'll need:

• OpenAI API key (Get one here)
• api.bible key (Sign up here)
• NLT API key (Request access here)
• ESV API key (Request access here)

Set environment variables:

export OPENAI_API_KEY=your-openai-key
export BIBLE_API_KEY=your-api-bible-key
export NLT_API_KEY=your-nlt-api-key
export ESV_API_KEY=your-esv-api-key
export BIBLESTUDY_NOTES_DIRECTORY=./notes  # optional override

Or use config.py locally (not recommended for production).

Install from PyPI

This package is published to PyPI, so you can install using pip directly:

pip install biblestudy
biblestudy

...OR Install Locally

To install the package locally for development or testing:

# Clone the repository (if you haven't already)
git clone https://github.com/labrack/biblestudy-cli.git
cd biblestudy-cli

# Install the package in development mode
pip install .

This is equivalent to the old way of running python main.py, but now the biblestudy command is available system-wide after installation.

---

🚀 Requirements

• Python 3.9+
• requests, openai, rich, beautifulsoup4

Install dependencies:

pip install -r requirements.txt

---

▶️ Running the App

Once installed, you can run the Bible study CLI from anywhere:

# Run the CLI using the installed command
biblestudy

---

💬 Sample Run

📖 Welcome to the Bible Study CLI 📖

Enter a Bible reference (e.g., John 3:16) or a snippet of scripture.

>> John 3:16

Which translation would you like to use?
[1] NLT (New Living Translation)
[2] ESV (English Standard Version)
[3] FBV (Free Bible Version)
[4] KJV (King James Version)
[5] ASV (American Standard Version)
[6] WEB (World English Bible)

Enter the number for your translation [1-6]: 1

Fetching NLT passage: John 3:16... done.

📜 John 3:16
╭────────────────────────────────────────────────────────────────────────────╮
│ For God loved the world so much that he gave his one and only Son, so     │
│ that everyone who believes in him will not perish but have eternal life.  │
╰────────────────────────────────────────────────────────────────────────────╯

What would you like to do?
[1] ✏️  Simplify
[2] 🗣️  Modern English
[3] 🏺 Background
[4] 🔗 Cross-References
[5] 🔍 Keyword Focus
[6] 🛠️ Life Application
[7] 🔄 Change Translation for Current Reference
[8] ➕ Enter a New Bible Reference
[9] 📅 Show the Verse of the Day
[0] 🚪 Exit

---

💾 Saving Notes

Your study results are saved to the notes/ folder by default.
You can change the location with the BIBLESTUDY_NOTES_DIRECTORY environment variable.

---

💡 Tips for Development

• Don't commit your real API keys — use the provided .gitignore to ignore config.py
• Use .env.example as a template for local testing
• Notes are plain .txt files and easy to back up

---

🍎 Mac-Specific Notes

If you see a warning like this:

NotOpenSSLWarning: urllib3 v2 only supports OpenSSL 1.1.1+, currently using LibreSSL

✅ You can safely ignore it, or pin urllib3<2 in your requirements to avoid it.

---

🔮 Future Ideas

• Add fuzzy search for snippets (e.g. "love is patient")
• Support full chapter navigation
• Offline caching for entire books
• Save notes in Markdown format
• Session resume after crash
• UI upgrade using textual or urwid

---

📜 License

MIT License — use freely and contribute back!