Skip to main content

A command-line interface for reading and searching the Bible

Project description

Bible CLI

A command-line interface for reading and searching the Bible woth beautiful formatting to keep you in the Word everyday.

Demo

Scripture Lookup

Bible CLI - Scripture Lookup Look up verses with beautiful formatting

Search Functionality

Bible CLI - Search Search across the Bible with advanced filters

Bookmarks

Bible CLI - Bookmarks Bible CLI - Bookmarks Save your favorite verses with a comment on your thoughts

Daily Verse

Bible CLI - Daily Verse Get daily inspiration

Features

  • Look up specific verses by book, chapter, and verse
  • Search for keywords or phrases across all books
  • Advanced search with filters (testament, word count, regex)
  • Daily verse feature
  • Bookmark favorite verses with notes
  • Beautiful terminal interface with Rich
  • Fuzzy matching for book names
  • Pagination for long chapters and search results
  • Context view for verses

Installation

Install directly from PyPI:

pip install bible-cli

Usage

Interactive Mode

bible

Command Line Arguments

# Look up a specific verse
bible "John 3:16"

# Search for a keyword
bible -s "love"

# Advanced search with options
bible -s "faith" --testament new --min-words 10 --max-words 20 --regex

Features in Detail

Scripture Lookup

  • Look up by book only (e.g., "Genesis")
  • Look up by book and chapter (e.g., "Genesis 1")
  • Look up by book, chapter, and verse (e.g., "John 3:16")
  • Look up verse ranges (e.g., "John 3:16-18")

Search Features

  • Case-insensitive search
  • Regular expression support
  • Filter by testament (Old/New)
  • Filter by word count
  • Paginated results

Bookmarks

  • Save favorite verses
  • Add notes to bookmarks
  • View all bookmarks with timestamps

Development

If you want to contribute to the project or run it from source:

  1. Clone the repository:
git clone https://github.com/wisyhambolu/Bible-Cli.git
cd Bible-Cli
  1. Install development dependencies:
pip install -r requirements.txt
  1. Run the development version:
python -m bible_cli

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support the Project

If you find this project helpful, consider buying me a coffee! Your support helps me maintain and improve this project.

Buy Me A Coffee

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Created by Wisdom Hambolu

Acknowledgments

  • Rich library for beautiful terminal output
  • RapidFuzz for fuzzy matching

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

bible_cli-1.0.3-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file bible_cli-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: bible_cli-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for bible_cli-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ecd64839573337c8dfe4ad00309ae5f323c33f53ee3e69e621694e982af84dcb
MD5 8a7eca5910fc876fe884ddce4ebed2f1
BLAKE2b-256 0e046cadf622deb08ba68e1789152e33a077ca2e0e7a89dc599937ea6d949741

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