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
Look up verses with beautiful formatting
Search Functionality
Search across the Bible with advanced filters
Bookmarks
Save your favorite verses with a comment on your thoughts
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:
- Clone the repository:
git clone https://github.com/wisyhambolu/Bible-Cli.git
cd Bible-Cli
- Install development dependencies:
pip install -r requirements.txt
- 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.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - 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.
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file bible_cli-1.0.2.tar.gz.
File metadata
- Download URL: bible_cli-1.0.2.tar.gz
- Upload date:
- Size: 1.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1c5f8e2fcbe60b44cb3de5bf3539d041f942085d3e7328999018657f5167c17a
|
|
| MD5 |
4ebe8565c2432f6b4f73b986c912bff7
|
|
| BLAKE2b-256 |
acfa257aee78454fcf4076c3aaf7dab09c83e5d71bfa8ab8145681e01b7d75f9
|
File details
Details for the file bible_cli-1.0.2-py3-none-any.whl.
File metadata
- Download URL: bible_cli-1.0.2-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a958e3a5314e8de8596ff77d7f61de1705b71d497ef07655952f241169e82a4
|
|
| MD5 |
8693d7fb8b2c57cf1c4f7f38be07da8c
|
|
| BLAKE2b-256 |
504a4044737d61be1e454a50d923c55e38f025461f278ccac5e79da441e637ff
|