Skip to main content

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.

Metadata

Release files for funbible 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for funbible 0.1.3
File Size Uploaded Provenance Actions
funbible-0.1.3.tar.gz 18.8 MB Without provenance Details for funbible-0.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for funbible 0.1.3
File Interpreter ABI Platform Actions
funbible-0.1.3-py3-none-any.whl Python 3 none any Details for funbible-0.1.3-py3-none-any.whl

Total release size: 26.9 MB

Release files / funbible-0.1.3.tar.gz

Download URL funbible-0.1.3.tar.gz
Size 18.8 MB
Tags Source
SHA-256 checksum
How to use checksums
e828b058923e7325b5f34ed6ae8c0d66194a185ff8ef183de710175af7d81aa4
BLAKE2b-256 checksum
How to use checksums
505a20ab982cb40fa81a86ab44264f1b9c75fe7f19090ec5293fac7bb77ee244
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / funbible-0.1.3-py3-none-any.whl

Download URL funbible-0.1.3-py3-none-any.whl
Size 8.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8397a9f17472a8a11672b86b21111b2f73814ed6396942958585b18637118bc0
BLAKE2b-256 checksum
How to use checksums
67ebb99e73cb1d46640c68f3d11c5ceda4e233db92e247bdf617709b5d75bbd8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Security for funbible 0.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page