Skip to main content

A feature-rich terminal Bible reader with version management and smart search

Project description

FunBible

A feature-rich terminal Bible reader written in Python with version management, smart search, and a beautiful CLI.

Features

  • 📖 Interactive Shell: Type funbible to enter a powerful interactive shell with tab completion and command history
  • 🔍 Smart Search: Hybrid search combining exact substring matching with fuzzy search for typo tolerance
  • 📚 Version Management: Download and switch between multiple Bible versions on-demand
  • 🌐 Online Lookup: Fetch verses from biblia.bg when offline copies aren't available
  • 📋 Clipboard Integration: Automatically copy results to your clipboard
  • 🎨 Rich Output: Beautiful colored terminal output with syntax highlighting
  • ⚡ Quick Commands: Direct CLI access for one-shot lookups without entering the shell

Installation

This project uses Poetry for dependency management.

# Clone the repository
git clone https://github.com/m-krastev/funbible.git
cd funbible

# Install dependencies
poetry install

# Or install globally with pip
pip install .

Quick Start

# Start interactive shell
funbible

# Quick verse lookup
funbible get "John 3:16"

# Search for text
funbible find "love"

# Get a random verse
funbible random

# List available Bible versions
funbible version list --all

# Install a new version
funbible version install kjv

# Set default version
funbible version default kjv

Usage

Interactive Shell

funbible

Inside the shell:

funbible> John 3:16
16 For God so loved the world...

funbible> find love
ℹ Found 10 results (5 exact, 5 fuzzy)
= (John 3:16) For God so loved the world...
...

funbible> version use kjv
✓ Switched to King James Version

funbible> random
Romans 8:28
And we know that all things work together for good...

funbible> help

Shell Commands

Command Alias Description
find <text> f, s Search for verses containing text
more m Show more results from last search
book <name> b Display an entire book
random r Display a random verse
version v Manage Bible versions
copy c Toggle clipboard copying
config - View/modify settings
exit q Exit the shell

Version Management

# List installed versions
funbible version list

# List all available versions (including downloadable)
funbible version list --all

# Install a version
funbible version install kjv

# Set as default
funbible version default kjv

# Remove a version
funbible version remove kjv

Available Versions

ID Name Language
biblia-1940 Bulgarian Bible 1940 Bulgarian
biblia-revizirano Bulgarian Bible Revised Bulgarian
kjv King James Version English
asv American Standard Version English
bbe Bible in Basic English English
web World English Bible English

Configuration

Settings are stored in ~/.config/funbible/config.json:

# View all settings
funbible config

# Set a value
funbible config auto_copy true
funbible config search_limit 20
funbible config fuzzy_threshold 60

CLI Options

funbible --help
funbible get --help
funbible version --help

License

MIT License - see LICENSE file for 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

funbible-0.1.0.tar.gz (7.9 MB view details)

Uploaded Source

Built Distribution

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

funbible-0.1.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

Details for the file funbible-0.1.0.tar.gz.

File metadata

  • Download URL: funbible-0.1.0.tar.gz
  • Upload date:
  • Size: 7.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for funbible-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1f9eff563e0c1750b4fb1822463c0aa29514ad4872a646033e6efc7734a7d48a
MD5 642de642bc125419eb7eb27f477509f1
BLAKE2b-256 1d25fce016164e73feb81c2fbfe581a9b89a6f9bd15c5b693e90c9c106a06485

See more details on using hashes here.

File details

Details for the file funbible-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: funbible-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for funbible-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d40f7fa2e9fb8fe03723d4129a5dce945311ba0ff86c789e2dd10503c15285a9
MD5 a5e9af31eb887a7ec00181fb7b9031b3
BLAKE2b-256 86b1b797e340695b8752306851fbe13afe46dcbcff20a42e1f2f6b610867b2fe

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